StandardizerConfiguration (JChem Base API documentation (c) 1998-2021 ChemAxon Ltd.)

java.lang.Object
- chemaxon.standardizer.configuration.StandardizerConfiguration

All Implemented Interfaces:

java.lang.Cloneable
```
@PublicAPI
public class StandardizerConfiguration
extends java.lang.Object
implements java.lang.Cloneable
```
Standardizer configuration class.
Contains a list of StandardizerAction instances.

Groups of actions can be created using addActionToGroup(String, StandardizerAction) and addActionToGroups(Collection, StandardizerAction) methods. Note, that the StandardizerAction must be added to the configuration using addAction(StandardizerAction) or addActions(List) prior added into a group.

The configuration may contain invalid actions, that could not be read from XML or action string configuration. In all cases these actions must be instances of InvalidStandardizerAction. In these cases the root cause of the error can be gathered using InvalidStandardizerAction.getErrorMessage() method.

The validity of the configuration can be checked by the function isValid(). If there are invalid standardizer actions in the configuration, this function returns true. A text representation of all errors contained by a configuration can be gathered by the static method createErrorMessage(StandardizerConfiguration) .

IMPORTANT NOTE: The groups of the actions should be provided only after the actions are provided!

Since:

5.11

Author:

Imre Barna

Constructor Summary

Constructors
Constructor and Description

StandardizerConfiguration()

Constructors
Constructor and Description
`StandardizerConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(StandardizerAction action)` Adds an action to the configuration
`void`	`addActions(java.util.List<StandardizerAction> actions)` Adds actions to the configuration
`void`	`addActionToGroup(java.lang.String group, StandardizerAction action)` Adds an action to the group
`void`	`addActionToGroups(java.util.Collection<java.lang.String> groups, StandardizerAction action)` Adds an action to a list of groups
`void`	`clear()` Clears the configuration of action
`StandardizerConfiguration`	`clone()`
`StandardizerConfiguration`	`cloneConfiguration()` Clones the configuration
`static java.lang.String`	`createErrorMessage(StandardizerConfiguration configuration)` Creates an error message based on an invalid configuration
`int`	`getActionCount()` Gets the action count of the configuration
`java.util.List<java.lang.Integer>`	`getActionIndexes(java.lang.String actionString)` Gets the indexes of actions defined by the provided action string
`java.util.List<StandardizerAction>`	`getActions()` Gets all actions of the configuration
`java.util.List<StandardizerAction>`	`getActions(java.lang.String... groups)` Gets actions of a group of the configuration
`java.util.List<StandardizerAction>`	`getActions(java.lang.String group)` Gets actions of a group of the configuration
`java.lang.String`	`getGroupsOf(StandardizerAction action)` Gets the group names associated to an action separated by , character
`int`	`getLastIndexOfAction(java.lang.String token)` Gets the last index of an action defined by the provided action string
`boolean`	`isEmpty()` Gets whether the configuration contains actions
`boolean`	`isValid()` Gets whether the configuration contains only valid elements
`void`	`removeAction(StandardizerAction action)` Removes an action of the configuration
`void`	`removeActions(java.util.Collection<StandardizerAction> actions)` Removes actions of the configuration
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StandardizerConfiguration
```
public StandardizerConfiguration()
```
- Method Detail
  - addAction
```
public void addAction(StandardizerAction action)
```
    Adds an action to the configuration
    
    Parameters:
    
    action - the action to be added to the configuration
  - addActions
```
public void addActions(java.util.List<StandardizerAction> actions)
```
    Adds actions to the configuration
    
    Parameters:
    
    actions - the actions to be added to the configuration
  - removeAction
```
public void removeAction(StandardizerAction action)
```
    Removes an action of the configuration
    
    Parameters:
    
    action - the action to be removed to the configuration
  - removeActions
```
public void removeActions(java.util.Collection<StandardizerAction> actions)
```
    Removes actions of the configuration
    
    Parameters:
    
    actions - the actions to be removed to the configuration
  - getActions
```
public java.util.List<StandardizerAction> getActions()
```
    Gets all actions of the configuration
    
    Returns:
    
    all actions of the configuration
  - getActions
```
public java.util.List<StandardizerAction> getActions(java.lang.String group)
```
    Gets actions of a group of the configuration
    
    Parameters:
    
    group - the name of the group (case sensitive)
    
    Returns:
    
    actions of a group of the configuration
  - getActions
```
public java.util.List<StandardizerAction> getActions(java.lang.String... groups)
```
    Gets actions of a group of the configuration
    
    Parameters:
    
    groups - the name of the group (case sensitive)
    
    Returns:
    
    actions of a group of the configuration
  - addActionToGroup
```
public void addActionToGroup(java.lang.String group,
                             StandardizerAction action)
```
    Adds an action to the group
    
    Parameters:
    
    group - the name of the group
    
    action - the standardizer action
  - addActionToGroups
```
public void addActionToGroups(java.util.Collection<java.lang.String> groups,
                              StandardizerAction action)
```
    Adds an action to a list of groups
    
    Parameters:
    
    groups - the list of the group names
    
    action - the standardizer action
  - clone
```
public StandardizerConfiguration clone()
                                throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - cloneConfiguration
```
public StandardizerConfiguration cloneConfiguration()
```
    Clones the configuration
    
    Returns:
    
    the clone of the configuration
  - isEmpty
```
public boolean isEmpty()
```
    Gets whether the configuration contains actions
    
    Returns:
    
    true is the configuration does not contains actions
  - clear
```
public void clear()
```
    Clears the configuration of action
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getActionCount
```
public int getActionCount()
```
    Gets the action count of the configuration
    
    Returns:
    
    the action count of the configuration
  - getLastIndexOfAction
```
public int getLastIndexOfAction(java.lang.String token)
```
    Gets the last index of an action defined by the provided action string
    
    Parameters:
    
    token - the action string token of the action
    
    Returns:
    
    the last index of an action defined by the provided action string
  - getActionIndexes
```
public java.util.List<java.lang.Integer> getActionIndexes(java.lang.String actionString)
```
    Gets the indexes of actions defined by the provided action string
    
    Parameters:
    
    actionString - the action string token of the task
    
    Returns:
    
    indexes of actions defined by the provided action string
  - getGroupsOf
```
public java.lang.String getGroupsOf(StandardizerAction action)
```
    Gets the group names associated to an action separated by , character
    
    Parameters:
    
    action - the target action
    
    Returns:
    
    the groups associated to the action
  - isValid
```
public boolean isValid()
```
    Gets whether the configuration contains only valid elements
    
    Returns:
    
    true if the configuration contains only valid elements
  - createErrorMessage
```
public static java.lang.String createErrorMessage(StandardizerConfiguration configuration)
```
    Creates an error message based on an invalid configuration
    
    Parameters:
    
    configuration - the base configuration
    
    Returns:
    
    the proper error message for the configuration

Class StandardizerConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StandardizerConfiguration

Method Detail

addAction

addActions

removeAction

removeActions

getActions

getActions

getActions

addActionToGroup

addActionToGroups

clone

cloneConfiguration

isEmpty

clear

toString

getActionCount

getLastIndexOfAction

getActionIndexes

getGroupsOf

isValid

createErrorMessage