Package chemaxon.structurechecker.configuration

Class StructureCheckerConfigurationXmlReader

java.lang.Object

chemaxon.structurechecker.configuration.StructureCheckerConfigurationXmlReader

All Implemented Interfaces:

StructureCheckerConfigurationReader

@PublicApi
public class StructureCheckerConfigurationXmlReader
extends Object
implements StructureCheckerConfigurationReader

Structure Checker configuration reader for parsing XML configuration files.

Since:

Marvin 5.3

Field Summary

Fields

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

Fields inherited from interface chemaxon.structurechecker.configuration.StructureCheckerConfigurationReader

DEFAULT_USER_CHECKER_FILENAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<StructureChecker>	getCheckerList()	Returns the list of StructureChecker instances, which can be run by a CheckerRunner instance.
Map<StructureCheckerErrorType,StructureFixer>	getErrorTypeDefaultFixerMap()	Returns a map that contains the association between StructureCheckerErrorType and StructureFixer instances.
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 Details

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 Details

StructureCheckerConfigurationXmlReader

public StructureCheckerConfigurationXmlReader(InputStream inputStream)

Initiate an StructureCheckerConfigurationXmlReader instance with the given inputSteam with the configuration

Parameters:

inputStream - an InputStream instance

StructureCheckerConfigurationXmlReader

public StructureCheckerConfigurationXmlReader(InputStream inputStream,
 CheckerFixerFactory factory)

Initiate an StructureCheckerConfigurationXmlReader 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 Details

getCheckerList

public List<StructureChecker> getCheckerList()

Description copied from interface: StructureCheckerConfigurationReader

Returns the list of StructureChecker instances, which can be run by a CheckerRunner instance.

Specified by:

getCheckerList in interface StructureCheckerConfigurationReader

getErrorTypeDefaultFixerMap

public Map<StructureCheckerErrorType,StructureFixer> getErrorTypeDefaultFixerMap()

Description copied from interface: StructureCheckerConfigurationReader

Returns a map that contains the association between StructureCheckerErrorType and StructureFixer instances.

Specified by:

getErrorTypeDefaultFixerMap in interface StructureCheckerConfigurationReader

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