Enum Aromatizer
- java.lang.Object
-
- java.lang.Enum<Aromatizer>
-
- com.chemaxon.search.transformation.transformers.Aromatizer
-
- All Implemented Interfaces:
com.chemaxon.search.transformation.AromatizationDataProvider
,Transformer
,Serializable
,Comparable<Aromatizer>
@PublicAPI public enum Aromatizer extends Enum<Aromatizer> implements Transformer, com.chemaxon.search.transformation.AromatizationDataProvider
Aromatizer transformer. Performs aromatization according to the specified method.- Since:
- JChem 5.12
-
-
Field Summary
Fields Modifier and Type Field Description static Aromatizer
IDENTITY
Identity transformer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Aromatizer
fromMethod(com.chemaxon.search.AromatizationMethod method)
Gets the aromatizer-transformer corresponding to the specified aromatization methodcom.chemaxon.search.AromatizationMethod
getAromatizationMethod()
com.chemaxon.search.transformation.AtomIndexMapper
transform(Molecule m)
Transforms aMolecule
.static Aromatizer
valueOf(String name)
Returns the enum constant of this type with the specified name.static Aromatizer[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final Aromatizer NONE
-
AMBIGUOUS
public static final Aromatizer AMBIGUOUS
-
BASIC
public static final Aromatizer BASIC
-
GENERAL
public static final Aromatizer GENERAL
-
LOOSE
public static final Aromatizer LOOSE
-
-
Field Detail
-
IDENTITY
public static final Aromatizer IDENTITY
Identity transformer.
-
-
Method Detail
-
values
public static Aromatizer[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Aromatizer c : Aromatizer.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Aromatizer valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getAromatizationMethod
public com.chemaxon.search.AromatizationMethod getAromatizationMethod()
- Specified by:
getAromatizationMethod
in interfacecom.chemaxon.search.transformation.AromatizationDataProvider
-
transform
public com.chemaxon.search.transformation.AtomIndexMapper transform(Molecule m)
Description copied from interface:Transformer
Transforms a
TODO: revise this interface, do we really want to force implementations to change the input molecule rather than return a one?Molecule
. The molecule object is changed during the transformation, the mappings between old and new atom indexes are returned by the transformation.- Specified by:
transform
in interfaceTransformer
- Parameters:
m
- the molecule- Returns:
AtomIndexMapper
between old and new atom indexes
-
fromMethod
public static Aromatizer fromMethod(com.chemaxon.search.AromatizationMethod method)
Gets the aromatizer-transformer corresponding to the specified aromatization method- Parameters:
method
- the specified aromatization method.- Returns:
- returns an
Aromatizer
corresponding to the specified aromatization method
-
-