chemaxon.standardizer

Class StandardizerActionFactory

java.lang.Object

chemaxon.standardizer.StandardizerActionFactory

@PublicAPI
public class StandardizerActionFactory
extends java.lang.Object

Factory of StandardizerAction objects
Initializes the list of available standardizer action based on the provided factory configuration XML files, defining the factory:

• Internal list: the factory configuration XML containing the definitions of internal (ChemAxon defined) standardizer actions, that should be available using the factory
• External list: the factory configuration XML containing the definitions of external (user defined) standardizer actions, that should be available using the factory

The schema of the definition XML is defined by the DEFAULT_CONFIGURATION_SCHEMA:

 
 <?xml version="1.0" encoding="UTF-8"?>
 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <xsd:element name="configuration">
     <xsd:complexType>
       <xsd:sequence maxOccurs="1" minOccurs="1">
         <xsd:element name="bundle">
           <xsd:complexType>
             <xsd:attribute name="base" type="xsd:string" use="required"/>
           </xsd:complexType>
         </xsd:element>
         <xsd:element name="standardizer-action-list">
           <xsd:complexType>
             <xsd:sequence maxOccurs="unbounded" minOccurs="0">
               <xsd:element name="standardizer-action">
                 <xsd:complexType>
                   <xsd:attribute name="id" type="xsd:string" use="required"/>
                   <xsd:attribute name="class" type="xsd:string" use="required"/>
                   <xsd:attribute name="editor-class" type="xsd:string" use="optional"/>
                   <xsd:attribute name="jar" type="xsd:string" use="optional"/>
                 </xsd:complexType>
               </xsd:element>
             </xsd:sequence>
           </xsd:complexType>
         </xsd:element>
       </xsd:sequence>
     </xsd:complexType>
   </xsd:element>
 </xsd:schema>
 
 

The schema defines a factory identifier and the class name for each standardizer actions. The actions can be reached by the following methods:

• All actions can be accessed by the method getAvailableStandardizerActions() or,
• each action can be accessed by the factory identifier by the method getStandardizerAction(String, Map), however with this functionality the action can be initialized with special parameters.

Example for ChemAxon's default configuration with pre-configured transformations and user-defined standardizers:

 StandardizerActionFactory.Builder builder = new StandardizerActionFactory.Builder();
 builder.add(StandardizerTest.class.getResourceAsStream(StandardizerActionFactory.DEFAULT_CONFIGURATION_PATH));
 try {
        builder.add(DotfileUtil.open(StandardizerActionFactory.USER_DEFINED_STANDARDIZERCONFIG_XML));
 } catch (IOException e) {
        // no user defined standardizer configuration found
 }
 builder.add(StandardizerTest.class.getResourceAsStream(StandardizerActionFactory.PRE_CONFIGURED_TRANSFORMATIONS));
 StandardizerActionFactory factory = builder.build();
 

Since:

5.11

Version:

6.0

Author:

Imre Barna

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardizerActionFactory.Builder Builder class for StandardizerActionFactory.
static class	StandardizerActionFactory.StandardizerClassDescriptor Descriptor of a standardizer class

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT default factory id
static java.lang.String	DEFAULT_CONFIGURATION_PATH ChemAxon's default standardizer action configuration path
static java.lang.String	DEFAULT_CONFIGURATION_SCHEMA ChemAxon's default standardizer action configuration file schema path
static java.lang.String	PRE_CONFIGURED_TRANSFORMATIONS Pre-configured transformation configuration path
static java.lang.String	STANDARDIZERCONFIG_XML ChemAxon's default standardizer action configuration file name
static java.lang.String	USER_DEFINED_STANDARDIZERCONFIG_XML Users standardizer action configuration file name

Constructor Summary

Constructors

Constructor and Description
StandardizerActionFactory() Default constructor.
StandardizerActionFactory(java.lang.String path, java.lang.String externalPath) With this constructor inner and external configuration location can be defined.

Method Summary

Modifier and Type	Method and Description
java.util.List<StandardizerAction>	getAvailableStandardizerActions() Returns the list of standardizer actions that are available
StandardizerAction	getStandardizerAction(java.lang.String standardizerActionId, java.util.Map<java.lang.String,java.lang.String> params) This method creates a requested (type represented in actionId) StandardizerAction instance with the give parameters
void	writeConfiguration(java.io.OutputStream outputstream) Writes the factory configuration to the output stream

Methods inherited from class java.lang.Object

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

Field Detail

STANDARDIZERCONFIG_XML

public static final java.lang.String STANDARDIZERCONFIG_XML

ChemAxon's default standardizer action configuration file name

See Also:

Constant Field Values

USER_DEFINED_STANDARDIZERCONFIG_XML

public static final java.lang.String USER_DEFINED_STANDARDIZERCONFIG_XML

Users standardizer action configuration file name

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_PATH

public static final java.lang.String DEFAULT_CONFIGURATION_PATH

ChemAxon's default standardizer action configuration path

See Also:

Constant Field Values

PRE_CONFIGURED_TRANSFORMATIONS

public static final java.lang.String PRE_CONFIGURED_TRANSFORMATIONS

Pre-configured transformation configuration path

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_SCHEMA

public static final java.lang.String DEFAULT_CONFIGURATION_SCHEMA

ChemAxon's default standardizer action configuration file schema path

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

default factory id

See Also:

Constant Field Values

Constructor Detail

StandardizerActionFactory

public StandardizerActionFactory()

Default constructor. Only the built in configuration file defined by DEFAULT_CONFIGURATION_PATH, and the USER_DEFINED_STANDARDIZERCONFIG_XML will be read, the default list of Standardizer Actions will be reachable by the factory

StandardizerActionFactory

public StandardizerActionFactory(java.lang.String path,
                                 java.lang.String externalPath)

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

Parameters:

path - the location of the configuration XML for the inner standardizer action classes

externalPath - the location of the configuration XML for the external standardizer action classes

Method Detail

getAvailableStandardizerActions

public java.util.List<StandardizerAction> getAvailableStandardizerActions()

Returns the list of standardizer actions that are available

Returns:

the list of standardizer actions that are available with default parameters

getStandardizerAction

public StandardizerAction getStandardizerAction(java.lang.String standardizerActionId,
                                                java.util.Map<java.lang.String,java.lang.String> params)

This method creates a requested (type represented in actionId) StandardizerAction instance with the give parameters

Parameters:

standardizerActionId - the Id of the standardizer action

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

Returns:

a well configured StandardizerAction instance

writeConfiguration

public void writeConfiguration(java.io.OutputStream outputstream)

Writes the factory configuration to the output stream

Parameters:

outputstream - the target output stream