chemaxon.checkers

Class InvalidChecker

java.lang.Object

chemaxon.checkers.InvalidChecker

All Implemented Interfaces:

StructureChecker

@PublicAPI
public final class InvalidChecker
extends java.lang.Object
implements StructureChecker

An extremal checker implementation indicating error in the configuration imported from XML or action string

Since:

5.11

Author:

Imre Barna

Field Summary

Fields inherited from interface chemaxon.checkers.StructureChecker

PROPERTY_KEY_VALID

Constructor Summary

Constructors

Constructor and Description
InvalidChecker(java.lang.String errorMessage) Initializes an invalid structure checker instance

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Add a PropertyChangeListener for a specific property.
StructureCheckerResult	check(Molecule molecule) Detects a specific error in the molecule.
StructureChecker	cloneItem() Returns a clone of this StructureChecker instance
java.lang.String	getDescription()
StructureCheckerDescriptor	getDescriptor() Returns a StructureCheckerDescriptor instance which represents the user interface related informations of the checker
java.lang.String	getEditorClassName()
java.lang.String	getErrorCode() Returns the String represented error code of the checker (this error code should be used for external implementation support instead of StructureChecker.getErrorType())
java.lang.String	getErrorMessage() Gets the error message of the checker instance
StructureCheckerErrorType	getErrorType()
java.lang.String	getHelpText() Gets the help text of the checker
javax.swing.Icon	getIcon() Gets the Icon of the current checker
java.lang.String	getLocalMenuName() Gets the local menu name of the checker
java.lang.String	getName() Gets the name of the checker
boolean	isAvailable() Returns true if the checker is available, and can be used
boolean	isValid() Returns true if the checker's configuration is valid, false otherwise
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a PropertyChangeListener from the listener list.
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Remove a PropertyChangeListener for a specific property.
void	setDescription(java.lang.String description) Sets the description of the checker
void	setHelpText(java.lang.String helpText) Sets the detailed help of the checker which will shown in the tooltip on the GUI
void	setIcon(javax.swing.Icon icon) Sets the icon of the checker
void	setLocalMenuName(java.lang.String localMenuName) Set the local menu name of the checker
void	setMoreErrorMessage(java.lang.String moreError) Sets the message which will given in the result if two or more error found
void	setName(java.lang.String name) Sets the name of the checker
void	setNoErrorMessage(java.lang.String noError) Sets the message which will given in the result if no error found
void	setOneErrorMessage(java.lang.String oneError) Sets the message which will given in the result if one error found

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidChecker

public InvalidChecker(java.lang.String errorMessage)

Initializes an invalid structure checker instance

Parameters:

errorMessage - the error message of the instance.

Method Detail

check

public StructureCheckerResult check(Molecule molecule)
                             throws java.lang.NullPointerException

Description copied from interface: StructureChecker

Detects a specific error in the molecule.

Specified by:

check in interface StructureChecker

Parameters:

molecule - a Molecule instance have to be checked

Returns:

an instance of StructureCheckerResult (which contains all data needed to fix the problem) if the molecule contains the examined error, null otherwise

Throws:

java.lang.NullPointerException - if molecule is null

getName

public java.lang.String getName()

Description copied from interface: StructureChecker

Gets the name of the checker

Specified by:

getName in interface StructureChecker

Returns:

a human readable name

setName

public void setName(java.lang.String name)

Description copied from interface: StructureChecker

Sets the name of the checker

Specified by:

setName in interface StructureChecker

Parameters:

name - the human readable name of the checker

getLocalMenuName

public java.lang.String getLocalMenuName()

Description copied from interface: StructureChecker

Gets the local menu name of the checker

Specified by:

getLocalMenuName in interface StructureChecker

Returns:

the name for the local menu

setLocalMenuName

public void setLocalMenuName(java.lang.String localMenuName)

Description copied from interface: StructureChecker

Set the local menu name of the checker

Specified by:

setLocalMenuName in interface StructureChecker

Parameters:

localMenuName - a String to be shown in the local menu

getHelpText

public java.lang.String getHelpText()

Description copied from interface: StructureChecker

Gets the help text of the checker

Specified by:

getHelpText in interface StructureChecker

Returns:

the help text of the checker

setHelpText

public void setHelpText(java.lang.String helpText)

Description copied from interface: StructureChecker

Sets the detailed help of the checker which will shown in the tooltip on the GUI

Specified by:

setHelpText in interface StructureChecker

Parameters:

helpText - a String to be shown in the tooltip

setNoErrorMessage

public void setNoErrorMessage(java.lang.String noError)

Description copied from interface: StructureChecker

Sets the message which will given in the result if no error found

Specified by:

setNoErrorMessage in interface StructureChecker

Parameters:

noError - the error message if no error found

setOneErrorMessage

public void setOneErrorMessage(java.lang.String oneError)

Description copied from interface: StructureChecker

Sets the message which will given in the result if one error found

Specified by:

setOneErrorMessage in interface StructureChecker

Parameters:

oneError - the error message if one error found

setMoreErrorMessage

public void setMoreErrorMessage(java.lang.String moreError)

Description copied from interface: StructureChecker

Sets the message which will given in the result if two or more error found

Specified by:

setMoreErrorMessage in interface StructureChecker

Parameters:

moreError - the error message if two or more error found

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: StructureChecker

Gets the Icon of the current checker

Specified by:

getIcon in interface StructureChecker

Returns:

the Icon of the current checker

setIcon

public void setIcon(javax.swing.Icon icon)

Description copied from interface: StructureChecker

Sets the icon of the checker

Specified by:

setIcon in interface StructureChecker

Parameters:

icon - is an instance of Icon

getErrorType

public StructureCheckerErrorType getErrorType()

Specified by:

getErrorType in interface StructureChecker

Returns:

the error type of this checker

getErrorCode

public java.lang.String getErrorCode()

Description copied from interface: StructureChecker

Returns the String represented error code of the checker (this error code should be used for external implementation support instead of StructureChecker.getErrorType())

Specified by:

getErrorCode in interface StructureChecker

Returns:

the String represented error code of the checker (this error code should be used for external implementation support instead of StructureChecker.getErrorType())

getEditorClassName

public java.lang.String getEditorClassName()

Specified by:

getEditorClassName in interface StructureChecker

Returns:

the name of the editor class of the checker

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: StructureChecker

Sets the description of the checker

Specified by:

setDescription in interface StructureChecker

Parameters:

description - the description of the checker

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface StructureChecker

Returns:

the description of the checker

cloneItem

public StructureChecker cloneItem()

Description copied from interface: StructureChecker

Returns a clone of this StructureChecker instance

Specified by:

cloneItem in interface StructureChecker

Returns:

a clone of this StructureChecker instance

isValid

public boolean isValid()

Description copied from interface: StructureChecker

Returns true if the checker's configuration is valid, false otherwise

Specified by:

isValid in interface StructureChecker

Returns:

true if the checker's configuration is valid, false otherwise

isAvailable

public boolean isAvailable()

Description copied from interface: StructureChecker

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

Specified by:

isAvailable in interface StructureChecker

Returns:

true if the checker is available, and can be used

getDescriptor

public StructureCheckerDescriptor getDescriptor()

Description copied from interface: StructureChecker

Returns a StructureCheckerDescriptor instance which represents the user interface related informations of the checker

Specified by:

getDescriptor in interface StructureChecker

Returns:

a StructureCheckerDescriptor instance which represents the user interface related informations of the checker

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

Description copied from interface: StructureChecker

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 StructureChecker

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(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Description copied from interface: StructureChecker

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 StructureChecker

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(java.beans.PropertyChangeListener listener)

Description copied from interface: StructureChecker

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 StructureChecker

Parameters:

listener - The PropertyChangeListener to be removed

See Also:

PropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: StructureChecker

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 StructureChecker

Parameters:

listener - The PropertyChangeListener to be added

See Also:

PropertyChangeSupport.addPropertyChangeListener(PropertyChangeListener)

getErrorMessage

public java.lang.String getErrorMessage()

Gets the error message of the checker instance

Returns:

the error message of the checker instance