chemaxon.standardizer.configuration.reader

Class StandardizerActionStringReader

java.lang.Object

chemaxon.standardizer.configuration.reader.StandardizerActionStringReader

All Implemented Interfaces:

StandardizerConfigurationReader

@PublicAPI
public class StandardizerActionStringReader
extends java.lang.Object
implements StandardizerConfigurationReader

An implementation of StandardizerConfigurationReader for parsing action strings
If the configuration contains references to molecules/molecule files not contained by the configuration file, the base path of the configuration must be set by the method setPath(String) before gathering the configuration.
Syntax of action strings:
<actionString>::=<actionStringEntry>(..<actionStringEntry>) *
<actionStringEntry>::=<standardizerAction>|<groupDefinitions& gt;<standardizerAction>
<groupDefinitions>::=<groupDefinition>(,<groupDefinition>)*
<groupDefinition>::=(a-zA-Z0-9)+
<standardizerAction>::=<actionName>|<actionName>< parameters>
<actionName>::=(a-zA-Z0-9)+
<parameters>::=<parameter>(:<parameter>)*
<parameter>::=<key>| '<extendedKey>'|<key>=<value>|<key>='<extendedValu e & g t ; '
<key>::=(a-zA-Z0-9)+
<value>::=(anything\{.':,"})*
<extendedKey>::=(anything\{'" })*
<extendedValue>::=(anything\{'"})*

Since:

Marvin 5.11

Author:

Imre Barna

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTRY_SEPARATOR Configuration entry separator token of the action string
static java.lang.String	GROUP_END_TOKEN End of group list token of the action string
static java.lang.String	GROUP_SEPARATOR Group entry separator token of the action string
static java.lang.String	GROUP_START_TOKEN Start of group list token of the action string
static java.lang.String	KEY_VALUE_SEPARATOR Parameter key and value separator token of the action string
static java.lang.String	PARAM_SEPARATOR Parameter separator token of the action string

Fields inherited from interface chemaxon.standardizer.configuration.reader.StandardizerConfigurationReader

DEFAULT_STANDARDIZERS_CONFIG_PATH, USER_STANDARDIZERS_CONFIG_PATH

Constructor Summary

Constructors

Constructor and Description
StandardizerActionStringReader(java.lang.String configString) Default constructor of the reader.
StandardizerActionStringReader(java.lang.String configString, StandardizerActionFactory factory) Constructor with custom standardizer action factory

Method Summary

Modifier and Type	Method and Description
StandardizerConfiguration	getConfiguration() Gets the configuration defined by the pre-set configuration file.
void	setPath(java.lang.String path) Sets the base path of the configuration.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_SEPARATOR

public static final java.lang.String PARAM_SEPARATOR

Parameter separator token of the action string

See Also:

Constant Field Values

ENTRY_SEPARATOR

public static final java.lang.String ENTRY_SEPARATOR

Configuration entry separator token of the action string

See Also:

Constant Field Values

KEY_VALUE_SEPARATOR

public static final java.lang.String KEY_VALUE_SEPARATOR

Parameter key and value separator token of the action string

See Also:

Constant Field Values

GROUP_START_TOKEN

public static final java.lang.String GROUP_START_TOKEN

Start of group list token of the action string

See Also:

Constant Field Values

GROUP_END_TOKEN

public static final java.lang.String GROUP_END_TOKEN

End of group list token of the action string

See Also:

Constant Field Values

GROUP_SEPARATOR

public static final java.lang.String GROUP_SEPARATOR

Group entry separator token of the action string

See Also:

Constant Field Values

Constructor Detail

StandardizerActionStringReader

public StandardizerActionStringReader(java.lang.String configString)

Default constructor of the reader. Default StandardizerActionFactory is used.

Parameters:

configString - a String which contains the configurations described in action string

StandardizerActionStringReader

public StandardizerActionStringReader(java.lang.String configString,
                                      StandardizerActionFactory factory)

Constructor with custom standardizer action factory

Parameters:

configString - a String which contains the configurations described in action string

factory - a custom StandardizerActionFactory which gives the possibility for this instance to be able to recognized configuration contains custom implemented StandardizerAction instances

Method Detail

getConfiguration

public StandardizerConfiguration getConfiguration()

Description copied from interface: StandardizerConfigurationReader

Gets the configuration defined by the pre-set configuration file.

Specified by:

getConfiguration in interface StandardizerConfigurationReader

Returns:

the StandardizerConfiguration instance which can be run by a StandardizerActionRunner instance

setPath

public void setPath(java.lang.String path)

Description copied from interface: StandardizerConfigurationReader

Sets the base path of the configuration. External references within the configuration file mist be based on the path set with this method.

Specified by:

setPath in interface StandardizerConfigurationReader

Parameters:

path - the base path of the configuration