Package chemaxon.checkers.runner.configuration.reader

Class XMLBasedConfigurationReader

java.lang.Object

chemaxon.checkers.runner.configuration.reader.XMLBasedConfigurationReader

All Implemented Interfaces:

ConfigurationReader

@PublicAPI
public class XMLBasedConfigurationReader
extends Object
implements ConfigurationReader

A descendant of ConfigurationReader which can read CheckerRunner configuration described Chemaxon's own checker configuration XML format (schema in jar: chemaxon/checkers/runner/configuration /reader/resoruce/checkerconfiguation.xsd)

Since:

Marvin 5.3

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CONFIGURATION_SCHEMA	The default location of Chemaxon standard checker runner configuration

Fields inherited from interface chemaxon.checkers.runner.configuration.reader.ConfigurationReader

DEFAULT_CHECKERS_CONFIG_PATH, DEFAULT_USER_CHECKER_FILENAME, USER_CHECKERS_CONFIG_PATH

Constructor Summary

Constructors

Constructor	Description
XMLBasedConfigurationReader(InputStream inputStream)	Initiate an XMLBasedConfigurationReader instance with the given inputSteam with the configuration
XMLBasedConfigurationReader(InputStream inputStream, chemaxon.structurechecker.factory.CheckerFixerFactory factory)	Initiate an XMLBasedConfigurationReader instance with the given inputSteam with the configuration

Method Summary

Modifier and Type	Method	Description
List<StructureChecker>	getCheckerList()
Map<StructureCheckerErrorType,StructureFixer>	getErrorTypeDefaultFixerMap()
static boolean	isValid(InputStream inputStream)	Checks whether the contents of the provided input stream is a valid configuration XML

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIGURATION_SCHEMA

public static final String DEFAULT_CONFIGURATION_SCHEMA

The default location of Chemaxon standard checker runner configuration

See Also:

Constant Field Values

Constructor Detail

XMLBasedConfigurationReader

public XMLBasedConfigurationReader(InputStream inputStream)

Initiate an XMLBasedConfigurationReader instance with the given inputSteam with the configuration

Parameters:

inputStream - an InputStream instance

XMLBasedConfigurationReader

public XMLBasedConfigurationReader(InputStream inputStream,
                                   chemaxon.structurechecker.factory.CheckerFixerFactory factory)

Initiate an XMLBasedConfigurationReader instance with the given inputSteam with the configuration

Parameters:

inputStream - an InputStream instance

factory - a custom CheckerFixerFactory which gives the possibility for this instance to be able to recognize configurations that contain custom implemented StructureChecker instances

Method Detail

getCheckerList

public List<StructureChecker> getCheckerList()

Specified by:

getCheckerList in interface ConfigurationReader

Returns:

the List of StructureChecker instances which can be run by a CheckerRunner instance

getErrorTypeDefaultFixerMap

public Map<StructureCheckerErrorType,StructureFixer> getErrorTypeDefaultFixerMap()

Specified by:

getErrorTypeDefaultFixerMap in interface ConfigurationReader

Returns:

a Map which contains the association between StructureCheckerErrorType and StructureFixer instances

isValid

public static boolean isValid(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