Interface Expandable

All Known Implementing Classes:
MultipleSgroup, SuperatomSgroup

@PublicApi public interface Expandable
Expandable interface for S-groups.
Since:
Marvin 3.0, 11/05/2002
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Deprecated, for removal: This API element is subject to removal in a future version.
    As of Marvin 6.2, no replacement.
    Not supported feature.
    static final int
    Default expansion/contraction options.
    static final int
    Fast coordinate calculation in expand.
    static final int
    Coordinates are not calculated during expand or contract.
    static final int
    MDL like multiple group expansion flag.
    static final int
    Non recursive expansion of child groups.
    static final int
    Deprecated, for removal: This API element is subject to removal in a future version.
    as of Marvin 6.2, use LEAVE_COORDS_UNCHANGED instead
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contract(int opts)
    Contracts the S-group.
    boolean
    expand(int opts)
    Expands the S-group.
    boolean
    Is this S-group expanded?
  • Field Details

    • DEFAULT_OPTIONS

      static final int DEFAULT_OPTIONS
      Default expansion/contraction options.
      Since:
      Marvin 3.3
      See Also:
    • MDL_EXPAND

      static final int MDL_EXPAND
      MDL like multiple group expansion flag. Coordinates of corresponding atoms in different expanded units are equal. Use this flag for MDL molfile export.
      See Also:
    • REVERSIBLE_EXPAND

      @Deprecated(forRemoval=true) @SubjectToRemoval(date=JUL_01_2025) static final int REVERSIBLE_EXPAND
      Deprecated, for removal: This API element is subject to removal in a future version.
      as of Marvin 6.2, use LEAVE_COORDS_UNCHANGED instead
      Reversible expansion or contraction. Coordinates are not calculated.
      Since:
      Marvin 3.4, 03/18/2004
      See Also:
    • LEAVE_COORDS_UNCHANGED

      static final int LEAVE_COORDS_UNCHANGED
      Coordinates are not calculated during expand or contract.
      Since:
      Marvin 6.2, 2013/09/25
      See Also:
    • NONRECURSIVE_EXPAND

      static final int NONRECURSIVE_EXPAND
      Non recursive expansion of child groups.
      Since:
      Marvin 3.4, 04/22/2004
      See Also:
    • FAST_COORDS

      static final int FAST_COORDS
      Fast coordinate calculation in expand.
      Since:
      Marvin 4.1, 01/12/2006
      See Also:
    • COORDS_UPDATE

      @Deprecated(forRemoval=true) @SubjectToRemoval(date=JUL_01_2025) static final int COORDS_UPDATE
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of Marvin 6.2, no replacement.
      Not supported feature.
      Performs coordinate update during the unbinding of atoms.

      The atom which replaces the unbound atom will take the coordinates of the unbound atom in order preserve the stereo attributes of crossing bonds.

      Since:
      Marvin 5.3, 01/27/2010
      See Also:
  • Method Details

    • contract

      boolean contract(int opts)
      Contracts the S-group.
      Parameters:
      opts - contraction options
      Returns:
      true if the operation was successful, false if the group cannot be contracted
      See Also:
    • expand

      boolean expand(int opts)
      Expands the S-group.
      Parameters:
      opts - expansion options
      Returns:
      true if the operation was successful, false if the group cannot be expanded
      See Also:
    • isExpanded

      boolean isExpanded()
      Is this S-group expanded?
      Returns:
      true if expanded, false if not