Package chemaxon.standardizer.configuration

Class StandardizerConfigurationXmlReader

java.lang.Object

chemaxon.standardizer.configuration.StandardizerConfigurationXmlReader

All Implemented Interfaces:

StandardizerConfigurationReader

@PublicApi
public class StandardizerConfigurationXmlReader
extends Object
implements StandardizerConfigurationReader

Standardizer configuration reader for parsing XML configuration files.

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 getting the configuration. However, it is strongly discouraged to reference external molecule files from the configuration.

There is no static schema for the configuration file, as the available standardizer actions define their own XML tags. However, the basic structure of the configuration file must be as follows.

 <?xml version="1.0" encoding="UTF-8"?>
 <StandardizerConfiguration>
   <Actions>
   </Actions>
 </StandardizerConfiguration>
 

Since:

5.11

Field Summary

Fields inherited from interface chemaxon.standardizer.configuration.StandardizerConfigurationReader

DEFAULT_STANDARDIZERS_CONFIG_PATH, USER_STANDARDIZERS_CONFIG_PATH

Constructor Summary

Constructors

Constructor	Description
StandardizerConfigurationXmlReader(InputStream inputStream)	Initiate an StandardizerConfigurationXmlReader instance with the given inputSteam with the configuration
StandardizerConfigurationXmlReader(InputStream inputStream, StandardizerActionFactory factory)	Initiate an StandardizerConfigurationXmlReader instance with the given inputSteam with the configuration

Method Summary

Modifier and Type	Method	Description
StandardizerConfiguration	getConfiguration()	Gets the configuration defined by the pre-set configuration file.
static boolean	isValidXMLConfiguration(InputStream inputStream)	Checks whether the contents of the provided input stream is a valid configuration XML
void	setPath(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

Constructor Details

StandardizerConfigurationXmlReader

public StandardizerConfigurationXmlReader(InputStream inputStream)

Initiate an StandardizerConfigurationXmlReader instance with the given inputSteam with the configuration

Parameters:

inputStream - an InputStream instance

StandardizerConfigurationXmlReader

public StandardizerConfigurationXmlReader(InputStream inputStream,
 StandardizerActionFactory factory)

Initiate an StandardizerConfigurationXmlReader instance with the given inputSteam with the configuration

Parameters:

inputStream - an InputStream instance

factory - the action factory to be used by the reader

Method Details

getConfiguration

public StandardizerConfiguration getConfiguration()
                                           throws IllegalArgumentException

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

Throws:

IllegalArgumentException

setPath

public void setPath(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

isValidXMLConfiguration

public static boolean isValidXMLConfiguration(InputStream inputStream)

Checks whether the contents of the provided input stream is a valid configuration XML

Parameters:

inputStream - the input stream containing the configuration

Returns:

true if valid configuration, false otherwise