@PublicAPI public class Clean2DAction extends AbstractStandardizerAction
Modifier and Type | Class and Description |
---|---|
static class |
Clean2DAction.Type
Type of clean action (partial, full, template based or convert 3D to 2D)
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PARTIAL_CLEAN_KEY
Key for partial clean necessary property change
|
static java.lang.String |
TEMPLATE_FILE_KEY
Key of template file for parsing and property change
|
static java.lang.String |
TEMPLATES_KEY
Key for templates property change
|
static java.lang.String |
TYPE_KEY
Key of type for parsing and property change
|
CONFIG_PATH_KEY, FORMAT_KEY, ID_KEY, support
Constructor and Description |
---|
Clean2DAction(java.util.Map<java.lang.String,java.lang.String> params)
Initializes the action with parameters
|
Modifier and Type | Method and Description |
---|---|
Clean2DAction |
clone() |
Molecule[] |
getTemplates()
Gets the template molecules of the clean action
|
Clean2DAction.Type |
getType()
Gets the type of action
|
void |
setTemplates(Molecule[] cleanTemplates)
Sets the clean templates of the action
|
void |
setType(Clean2DAction.Type type)
Sets the type of action
|
protected Changes |
standardize1(Molecule molecule)
This method contains the current standardization mechanism.
|
java.lang.String |
toString() |
addPropertyChangeListener, addPropertyChangeListener, cloneItem, getComponents, getDescriptor, getID, isActive, isAvailable, isLicensed, isValid, propertyChange, removePropertyChangeListener, removePropertyChangeListener, setActive, setID, setLicenseEnvironment, setValid, standardize
public static final java.lang.String TYPE_KEY
public static final java.lang.String TEMPLATE_FILE_KEY
public static final java.lang.String PARTIAL_CLEAN_KEY
public static final java.lang.String TEMPLATES_KEY
public Clean2DAction(java.util.Map<java.lang.String,java.lang.String> params)
params
- the parameters of the actionpublic void setType(Clean2DAction.Type type)
type
- the type of actionpublic Clean2DAction.Type getType()
protected Changes standardize1(Molecule molecule) throws java.lang.IllegalArgumentException
AbstractStandardizerAction
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.Logger
, that can
be collected by using StandardizerLogger.getLogger()
method.standardize1
in class AbstractStandardizerAction
molecule
- the Molecule
instance to be standardizedjava.lang.IllegalArgumentException
- if the provided molecule or the provided parameters of the
action are invalidpublic Clean2DAction clone() throws java.lang.CloneNotSupportedException
clone
in class AbstractStandardizerAction
java.lang.CloneNotSupportedException
public void setTemplates(Molecule[] cleanTemplates)
cleanTemplates
- the clean templates of the actionpublic java.lang.String toString()
toString
in class AbstractStandardizerAction
public Molecule[] getTemplates()