chemaxon.checkers

Class StructureCheckerFactory

java.lang.Object

chemaxon.checkers.StructureCheckerFactory

Deprecated.

use CheckerFixerFactory instead

@Deprecated
 @PublicAPI
public final class StructureCheckerFactory
extends java.lang.Object

This is a factory class providing functionality of creating StructureChecker instances by name with the given parameters.

Please note that factory instances will use class loaders to load external checkers, and that can lead to problems when using checker editor components, as external checkers loaded with different factories are different types. In most cases using getInstance() or getInstance(String, String) instead of creating multiple factory instances is a safe way to load default and external checkers.

Since:

Marvin 5.3

Version:

5.11

Author:

Attila Szabo, Istvan Rabel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKERCONFIG_XML Deprecated. ChemAxon's default checker configuration file name
static java.lang.String	DEFAULT Deprecated. default factory id
static java.lang.String	DEFAULT_CONFIGURATION_PATH Deprecated. ChemAxon's default checker configuration path
static java.lang.String	DEFAULT_CONFIGURATION_SCHEMA Deprecated. ChemAxon's default checker configuration file schema path
static java.lang.String	USER_DEFINED_CHECKERCONFIG_XML Deprecated. Users checker configuration file name

Constructor Summary

Constructors

Constructor and Description
StructureCheckerFactory() Deprecated. Please consider using getInstance() instead of calling this constructor directly. Default constructor. Default configurations will be read.
StructureCheckerFactory(java.io.InputStream internalCheckerConfigStream, java.io.InputStream externalCheckerConfigStream) Deprecated. Please consider using getInstance(String, String) instead of calling this constructor directly. With this constructor inner and external configuration location can be defined.
StructureCheckerFactory(java.lang.String path, java.lang.String externalPath) Deprecated. Please consider using getInstance(String, String) instead of calling this constructor directly. With this constructor inner and external configuration location can be defined.

Method Summary

Modifier and Type	Method and Description
java.util.List<StructureChecker>	getAvailableCheckers() Deprecated. Returns a list of checkers available
StructureChecker	getChecker(java.lang.String checkerId, java.util.Map<java.lang.String,java.lang.String> params) Deprecated. This method creates a requested (type represented in checkerId) StructureChecker instance with the give parameters
static StructureCheckerFactory	getInstance() Deprecated. Returns the default factory instance.
static StructureCheckerFactory	getInstance(java.lang.String path, java.lang.String externalPath) Deprecated. Returns the factory instance for specified paths.
static void	reloadDefaultMap() Deprecated. Forces reload of factory data.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final java.lang.String DEFAULT

Deprecated.

default factory id

See Also:

Constant Field Values

CHECKERCONFIG_XML

public static final java.lang.String CHECKERCONFIG_XML

Deprecated.

ChemAxon's default checker configuration file name

See Also:

Constant Field Values

USER_DEFINED_CHECKERCONFIG_XML

public static final java.lang.String USER_DEFINED_CHECKERCONFIG_XML

Deprecated.

Users checker configuration file name

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_PATH

public static final java.lang.String DEFAULT_CONFIGURATION_PATH

Deprecated.

ChemAxon's default checker configuration path

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_SCHEMA

public static final java.lang.String DEFAULT_CONFIGURATION_SCHEMA

Deprecated.

ChemAxon's default checker configuration file schema path

See Also:

Constant Field Values

Constructor Detail

StructureCheckerFactory

@Deprecated
public StructureCheckerFactory()

Deprecated. Please consider using getInstance() instead of calling this constructor directly.

Default constructor. Default configurations will be read.

StructureCheckerFactory

@Deprecated
public StructureCheckerFactory(java.lang.String path,
                                           java.lang.String externalPath)

Deprecated. Please consider using getInstance(String, String) instead of calling this constructor directly.

With this constructor inner and external configuration location can be defined.

Parameters:

path - the location of the configuration xml for the inner checker classes

externalPath - the location of the configuration xml for the external checker classes

StructureCheckerFactory

@Deprecated
public StructureCheckerFactory(java.io.InputStream internalCheckerConfigStream,
                                           java.io.InputStream externalCheckerConfigStream)

Deprecated. Please consider using getInstance(String, String) instead of calling this constructor directly.

With this constructor inner and external configuration location can be defined.

Parameters:

internalCheckerConfigStream - the stream containing the configuration xml for the inner checker classes

externalCheckerConfigStream - the stream containing the configuration xml for the external checker classes

Method Detail

getAvailableCheckers

public java.util.List<StructureChecker> getAvailableCheckers()

Deprecated.

Returns a list of checkers available

Returns:

a list of checkers available

Since:

5.7

getChecker

public StructureChecker getChecker(java.lang.String checkerId,
                                   java.util.Map<java.lang.String,java.lang.String> params)

Deprecated.

This method creates a requested (type represented in checkerId) StructureChecker instance with the give parameters

Parameters:

checkerId - the Id of the checker

params - is a Map contains String pairs representing a property bag should be passed to the checker instance

Returns:

a well configured StructureChecker instance

reloadDefaultMap

public static void reloadDefaultMap()

Deprecated.

Forces reload of factory data.

Since:

5.12

getInstance

public static StructureCheckerFactory getInstance()

Deprecated.

Returns the default factory instance.

Returns:

the default factory instance

Since:

5.11

getInstance

public static StructureCheckerFactory getInstance(java.lang.String path,
                                                  java.lang.String externalPath)

Deprecated.

Returns the factory instance for specified paths.

Parameters:

path - the internal checker path (resource path)

externalPath - the external checker path (file path)

Returns:

the factory instance for paths

Since:

5.11