Package chemaxon.standardizer.actions

Class InvalidStandardizerAction

java.lang.Object

chemaxon.standardizer.actions.InvalidStandardizerAction

All Implemented Interfaces:

StandardizerAction

@PublicAPI
public final class InvalidStandardizerAction
extends Object
implements StandardizerAction

Implementation of StandardizerAction representing an invalid instance of a standardizer action. Used by StandardizerConfigurationReader for invalid configuration entries

Since:

5.11

Constructor Summary

Constructors

Constructor	Description
InvalidStandardizerAction(String errorMessage)	Initializes an invalid standardizer instance
InvalidStandardizerAction(String errorMessage, String actionName, Map<String,String> parameters)	Initializes an invalid standardizer instance

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Add a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Add a PropertyChangeListener for a specific property.
InvalidStandardizerAction	clone()
StandardizerAction	cloneItem()	Returns a clone of this StandardizerAction instance
String	getActionName()	Gets the name of the original action
StandardizerActionDescriptor	getDescriptor()	Gets the descriptor of the standardizer action.
String	getErrorMessage()	Gets the error message of the standardizer instance
String	getID()	Gets the identifier of the standardizer task
Map<String,String>	getParameters()	Gets the parameter map of the action
boolean	isActive()	Returns true if the action is active, and can be used
boolean	isAvailable()	Returns true if the action is available, and can be used
boolean	isValid()	Returns true if the action's parameters are valid, false otherwise
void	removePropertyChangeListener(PropertyChangeListener listener)	Remove a PropertyChangeListener from the listener list.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)	Remove a PropertyChangeListener for a specific property.
void	setActive(boolean active)	Sets whether the action is active, and can be used
void	setLicenseEnvironment(String env)	Sets the license environment of the action
Changes	standardize(Molecule molecule)	Standardizes the provided molecule. Logs of standardization should be generated to a Logger, that can be collected by using StandardizerLogger.getLogger() method.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidStandardizerAction

public InvalidStandardizerAction(String errorMessage)

Initializes an invalid standardizer instance

Parameters:

errorMessage - the error message of the instance.

InvalidStandardizerAction

public InvalidStandardizerAction(String errorMessage,
                                 String actionName,
                                 Map<String,String> parameters)

Initializes an invalid standardizer instance

Parameters:

actionName - the name of the action

parameters - the parameters of the action

errorMessage - the error message of the instance.

Method Detail

standardize

public Changes standardize(Molecule molecule)
                    throws NullPointerException

Description copied from interface: StandardizerAction

Standardizes the provided molecule.
Logs of standardization should be generated to a Logger, that can be collected by using StandardizerLogger.getLogger() method.

Specified by:

standardize in interface StandardizerAction

Parameters:

molecule - the target molecule of the standardization process

Returns:

the change set of the molecule

Throws:

NullPointerException

cloneItem

public StandardizerAction cloneItem()

Description copied from interface: StandardizerAction

Returns a clone of this StandardizerAction instance

Specified by:

cloneItem in interface StandardizerAction

Returns:

a clone of this StandardizerAction instance

isValid

public boolean isValid()

Description copied from interface: StandardizerAction

Returns true if the action's parameters are valid, false otherwise

Specified by:

isValid in interface StandardizerAction

Returns:

true if the action's parameters are valid, false otherwise

isAvailable

public boolean isAvailable()

Description copied from interface: StandardizerAction

Returns true if the action is available, and can be used

Specified by:

isAvailable in interface StandardizerAction

Returns:

true if the action is available, and can be used

getDescriptor

public StandardizerActionDescriptor getDescriptor()

Description copied from interface: StandardizerAction

Gets the descriptor of the standardizer action. Contains all necessary informations of the action for user interfaces.

Specified by:

getDescriptor in interface StandardizerAction

Returns:

the descriptor of the standardizer action.

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Description copied from interface: StandardizerAction

Remove a PropertyChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface StandardizerAction

Parameters:

propertyName - The name of the property that was listened on.

listener - The PropertyChangeListener to be removed

See Also:

PropertyChangeSupport.removePropertyChangeListener(String, PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Description copied from interface: StandardizerAction

Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.

Specified by:

addPropertyChangeListener in interface StandardizerAction

Parameters:

propertyName - The name of the property to listen on.

listener - The PropertyChangeListener to be added

See Also:

PropertyChangeSupport.addPropertyChangeListener(String, PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: StandardizerAction

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface StandardizerAction

Parameters:

listener - The PropertyChangeListener to be removed

See Also:

PropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Description copied from interface: StandardizerAction

Add a PropertyChangeListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.

Specified by:

addPropertyChangeListener in interface StandardizerAction

Parameters:

listener - The PropertyChangeListener to be added

See Also:

PropertyChangeSupport.addPropertyChangeListener(PropertyChangeListener)

getErrorMessage

public String getErrorMessage()

Gets the error message of the standardizer instance

Returns:

the error message of the standardizer instance

toString

public String toString()

Overrides:

toString in class Object

getID

public String getID()

Description copied from interface: StandardizerAction

Gets the identifier of the standardizer task

Specified by:

getID in interface StandardizerAction

Returns:

the identifier of the standardizer task

isActive

public boolean isActive()

Description copied from interface: StandardizerAction

Returns true if the action is active, and can be used

Specified by:

isActive in interface StandardizerAction

Returns:

true if the action is active, and can be used

setActive

public void setActive(boolean active)

Description copied from interface: StandardizerAction

Sets whether the action is active, and can be used

Specified by:

setActive in interface StandardizerAction

Parameters:

active - whether the action should be active, and can be used

clone

public InvalidStandardizerAction clone()
                                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getActionName

public String getActionName()

Gets the name of the original action

Returns:

the name of the original action

getParameters

public Map<String,String> getParameters()

Gets the parameter map of the action

Returns:

the parameter map of the action

setLicenseEnvironment

public void setLicenseEnvironment(String env)

Description copied from interface: StandardizerAction

Sets the license environment of the action

Specified by:

setLicenseEnvironment in interface StandardizerAction

Parameters:

env - the license environment of the action