Package chemaxon.standardizer.actions

Class SetHydrogenIsotopeSymbolAction

java.lang.Object

chemaxon.standardizer.AbstractStandardizerAction

chemaxon.standardizer.actions.SetHydrogenIsotopeSymbolAction

All Implemented Interfaces:

Licensable, StandardizerAction, PropertyChangeListener, Cloneable, EventListener

@PublicApi
public final class SetHydrogenIsotopeSymbolAction
extends AbstractStandardizerAction

Standardizer action that sets hydrogen isotope symbols to be used in the molecule (D/T or 2H/3H).

Since:

6.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SetHydrogenIsotopeSymbolAction.Type	Hydrogen isotope representation type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_KEY	Key of type for parsing and property change

Fields inherited from class chemaxon.standardizer.AbstractStandardizerAction

CONFIG_PATH_KEY, FORMAT_KEY, ID_KEY, support

Constructor Summary

Constructors

Constructor	Description
SetHydrogenIsotopeSymbolAction(Map<String,String> params)	Initializes the action

Method Summary

Modifier and Type	Method	Description
SetHydrogenIsotopeSymbolAction	clone()
SetHydrogenIsotopeSymbolAction.Type	getType()	Gets the type of action
void	setType(SetHydrogenIsotopeSymbolAction.Type type)	Sets the type of action
protected Changes	standardize1(Molecule molecule)	This method contains the current standardization mechanism.
String	toString()

Methods inherited from class chemaxon.standardizer.AbstractStandardizerAction

addPropertyChangeListener, addPropertyChangeListener, anyBooleanPropertyTrue, cloneItem, getComponents, getDescriptor, getID, isActive, isAvailable, isLicensed, isValid, propertyChange, removePropertyChangeListener, removePropertyChangeListener, setActive, setID, setLicenseEnvironment, setValid, standardize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TYPE_KEY

public static final String TYPE_KEY

Key of type for parsing and property change

See Also:

• Constant Field Values

Constructor Details

SetHydrogenIsotopeSymbolAction

public SetHydrogenIsotopeSymbolAction(Map<String,String> params)

Initializes the action

Parameters:

params - the parameters of the action

Method Details

setType

public void setType(SetHydrogenIsotopeSymbolAction.Type type)

Sets the type of action

Parameters:

type - the type of action

getType

public SetHydrogenIsotopeSymbolAction.Type getType()

Gets the type of action

Returns:

the type of action

standardize1

protected Changes standardize1(Molecule molecule)

Description copied from class: AbstractStandardizerAction

This method contains the current standardization mechanism. Descendants needs to implement this method.

Special molecules containing more components (e.g. RgMolecule, RxnMolecule) are decomponented by the method AbstractStandardizerAction.getComponents(Molecule), and AbstractStandardizerAction.standardize1(Molecule) method is called on each component, before applied on the original molecule. If a descendant does not want this to occur, this method must be overridden. Logs of standardization should be generated to a Logger, that can be collected by using StandardizerLogger.getLogger() method.

Specified by:

standardize1 in class AbstractStandardizerAction

Parameters:

molecule - the Molecule instance to be standardized

Returns:

the changes applied on the molecule during the standardization process

clone

public SetHydrogenIsotopeSymbolAction clone()
                                     throws CloneNotSupportedException

Overrides:

clone in class AbstractStandardizerAction

Throws:

CloneNotSupportedException

toString

public String toString()

Overrides:

toString in class AbstractStandardizerAction