Package chemaxon.standardizer.actions

Class ContractSgroupsAction

java.lang.Object

chemaxon.standardizer.AbstractStandardizerAction

chemaxon.standardizer.AbstractSgroupAction

chemaxon.standardizer.actions.ContractSgroupsAction

All Implemented Interfaces:

Licensable, StandardizerAction, PropertyChangeListener, Cloneable, EventListener

@PublicApi
public final class ContractSgroupsAction
extends AbstractSgroupAction

Standardizer action that contracts S-groups of the molecule.

Since:

6.0

Field Summary

Fields

Modifier and Type	Field	Description
protected String	excludeString

Fields inherited from class chemaxon.standardizer.AbstractSgroupAction

changes, EXCLUDE_KEY

Fields inherited from class chemaxon.standardizer.AbstractStandardizerAction

CONFIG_PATH_KEY, FORMAT_KEY, ID_KEY, support

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getExcludeString()	Gets the exclude string of action
void	setExcludeString(String excludeString)	Sets the exclude string of action
protected Changes	standardize1(Molecule molecule)	This method contains the current standardization mechanism.

Methods inherited from class chemaxon.standardizer.AbstractSgroupAction

clone, parseGroupNames, 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

excludeString

protected String excludeString

Constructor Details

ContractSgroupsAction

public ContractSgroupsAction(Map<String,String> params)

Initializes the action

Parameters:

params - the parameters of the action

Method Details

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

setExcludeString

public void setExcludeString(String excludeString)

Description copied from class: AbstractSgroupAction

Sets the exclude string of action

Specified by:

setExcludeString in class AbstractSgroupAction

Parameters:

excludeString - the exclude string of action

getExcludeString

public String getExcludeString()

Description copied from class: AbstractSgroupAction

Gets the exclude string of action

Specified by:

getExcludeString in class AbstractSgroupAction

Returns:

the exclude string of action