com.chemaxon.search.transformation.transformers

Enum Aromatizer

java.lang.Object

java.lang.Enum<Aromatizer>

com.chemaxon.search.transformation.transformers.Aromatizer

All Implemented Interfaces:

com.chemaxon.search.transformation.AromatizationDataProvider, Transformer, java.io.Serializable, java.lang.Comparable<Aromatizer>

@PublicAPI
public enum Aromatizer
extends java.lang.Enum<Aromatizer>
implements Transformer, com.chemaxon.search.transformation.AromatizationDataProvider

Aromatizer transformer. Performs aromatization according to the specified method.

Since:

JChem 5.12

Author:

Robert Wagner, Nora Mate

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMBIGUOUS
BASIC
GENERAL
LOOSE
NONE

Field Summary

Fields

Modifier and Type	Field and Description
static Aromatizer	IDENTITY Identity transformer.

Method Summary

Modifier and Type	Method and Description
static Aromatizer	fromMethod(com.chemaxon.search.AromatizationMethod method) Gets the aromatizer-transformer corresponding to the specified aromatization method
com.chemaxon.search.AromatizationMethod	getAromatizationMethod()
com.chemaxon.search.transformation.AtomIndexMapper	transform(Molecule m) Transforms a Molecule.
static Aromatizer	valueOf(java.lang.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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAromatizationMethod

public com.chemaxon.search.AromatizationMethod getAromatizationMethod()

Specified by:

getAromatizationMethod in interface com.chemaxon.search.transformation.AromatizationDataProvider

transform

public com.chemaxon.search.transformation.AtomIndexMapper transform(Molecule m)

Description copied from interface: Transformer

Transforms a Molecule. The molecule object is changed during the transformation, the mappings between old and new atom indexes are returned by the transformation.

TODO: revise this interface, do we really want to force implementations to change the input molecule rather than return a one?

Specified by:

transform in interface Transformer

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