java.lang.Object
- org.corpus_tools.pepper.modules.PepperModuleProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DOTManipulatorProperties, SaltValidatorProperties
```
public class PepperModuleProperties
extends Object
implements Serializable
```
This class is a container for a set of PepperModuleProperty objects. This class also offers some methods for accessing and maintaining the objects.

Author:

Florian Zipser

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,PepperModuleProperty<?>>`	`pepperModuleProperties`	Internal map to map all `PepperModuleProperty` objects to their name.
`static String`	`PROP_AFTER_ADD_SLAYER`
`static String`	`PROP_AFTER_COPY_RES`
`static String`	`PROP_AFTER_REMOVE_ANNOTATIONS`
`static String`	`PROP_AFTER_RENAME_ANNOTATIONS`
`static String`	`PROP_AFTER_REPORT_CORPUSGRAPH`
`static String`	`PROP_AFTER_TOKENIZE`
`static String`	`PROP_BEFORE_ADD_SLAYER`
`static String`	`PROP_BEFORE_READ_META`

Constructor Summary

Constructors
Constructor Description

PepperModuleProperties()
Creates instance of PepperModuleProperties and initializes it with a set of customization properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addProperties(org.eclipse.emf.common.util.URI propURI)`	Loads the given file via `Properties.load(java.io.InputStream)` and adds all properties given in the passed `Property` object.
`void`	`addProperty(PepperModuleProperty<?> property)`	Adds the given `PepperModuleProperty` object to the internal list.
`boolean`	`checkProperties()`	Checks if all properties marked as required are really set.
`boolean`	`checkProperty(PepperModuleProperty<?> prop)`	Checks if the value of given property, when marked as required is really set.
`Properties`	`getProperties()`	Returns a new `Properties` object containing all property names and their values.
`PepperModuleProperty<?>`	`getProperty(String propName)`	Returns a `PepperModuleProperty` object corresponding to the given property name.
`Collection<PepperModuleProperty<?>>`	`getPropertyDesctriptions()`	Returns all registered `PepperModuleProperty` objects, which are usable for the corresponding `PepperModule`.
`Collection<String>`	`getPropertyNames()`	Returns all property names registered in that object, and therefore usable for the corresponding `PepperModule`.
`void`	`removePropertyValue(String propName)`	Removes the value of the property with the passed property name from the properties.
`<T> void`	`setPropertyValue(String propName, T propValue)`	Searches for a `PepperModuleProperty` object in registered `PepperModuleProperty` objects and sets its value attribute, if a `PepperModuleProperty` object was found.
`void`	`setPropertyValues(File propFile)`	Loads the given file via `Properties.load(java.io.InputStream)` and adds all properties given in the passed `Property` object.
`void`	`setPropertyValues(Properties properties)`	Adds all properties given in the passed `Property` object.
`List<Character>`	`stringToCharList(String input)`	Expects a list of characters encoded as a String.
`String`	`toString()`

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

- Field Detail
  - PROP_AFTER_ADD_SLAYER
```
public static final String PROP_AFTER_ADD_SLAYER
```
    See Also:
    
    Constant Field Values
  - PROP_AFTER_COPY_RES
```
public static final String PROP_AFTER_COPY_RES
```
    See Also:
    
    Constant Field Values
  - PROP_BEFORE_ADD_SLAYER
```
public static final String PROP_BEFORE_ADD_SLAYER
```
    See Also:
    
    Constant Field Values
  - PROP_BEFORE_READ_META
```
public static final String PROP_BEFORE_READ_META
```
    See Also:
    
    Constant Field Values
  - PROP_AFTER_REPORT_CORPUSGRAPH
```
public static final String PROP_AFTER_REPORT_CORPUSGRAPH
```
    See Also:
    
    Constant Field Values
  - PROP_AFTER_RENAME_ANNOTATIONS
```
public static final String PROP_AFTER_RENAME_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - PROP_AFTER_REMOVE_ANNOTATIONS
```
public static final String PROP_AFTER_REMOVE_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
  - PROP_AFTER_TOKENIZE
```
public static final String PROP_AFTER_TOKENIZE
```
    See Also:
    
    Constant Field Values
  - pepperModuleProperties
```
protected Map<String,PepperModuleProperty<?>> pepperModuleProperties
```
    Internal map to map all PepperModuleProperty objects to their name.
- Constructor Detail
  - PepperModuleProperties
```
public PepperModuleProperties()
```
    Creates instance of PepperModuleProperties and initializes it with a set of customization properties. These properties are:
    
    PROP_AFTER_ADD_SLAYER
- Method Detail
  - addProperties
```
public void addProperties(org.eclipse.emf.common.util.URI propURI)
```
    Loads the given file via Properties.load(java.io.InputStream) and adds all properties given in the passed Property object. That means, the corresponding PepperModuleProperty will be searched and its value will be set to the one found in the passed Properties object. If no corresponding PepperModuleProperties object corresponds to one of the properties contained in the passed Property object, a new one will be created.
  - getProperties
```
public Properties getProperties()
```
    Returns a new Properties object containing all property names and their values.
    
    Returns:
    
    new Properties object
  - setPropertyValues
```
public void setPropertyValues(File propFile)
```
    Loads the given file via Properties.load(java.io.InputStream) and adds all properties given in the passed Property object. That means, the corresponding PepperModuleProperty will be searched and its value will be set to the one found in the passed Properties object. If no corresponding PepperModuleProperties object corresponds to one of the properties contained in the passed Property object, a new one will be created.
  - setPropertyValues
```
public void setPropertyValues(Properties properties)
```
    Adds all properties given in the passed Property object. That means, the corresponding PepperModuleProperty will be searched and its value will be set to the one found in the passed Properties object. If no corresponding PepperModuleProperties object corresponds to one of the properties contained in the passed Property object, a new one will be created.
  - setPropertyValue
```
public <T> void setPropertyValue(String propName,
                                 T propValue)
```
    Searches for a PepperModuleProperty object in registered PepperModuleProperty objects and sets its value attribute, if a PepperModuleProperty object was found.
    
    Parameters:
    
    propName - name of property to search for
    
    propValue - value to which PepperModulePropertys value attribute is set to
  - checkProperties
```
public boolean checkProperties()
```
    Checks if all properties marked as required are really set. Throws a PepperModulePropertyException if a required value is not set.
  - checkProperty
```
public boolean checkProperty(PepperModuleProperty<?> prop)
```
    Checks if the value of given property, when marked as required is really set. Throws a PepperModulePropertyException if a required value is not set.
  - addProperty
```
public void addProperty(PepperModuleProperty<?> property)
```
    Adds the given PepperModuleProperty object to the internal list.
    
    Parameters:
    
    property -
  - getProperty
```
public PepperModuleProperty<?> getProperty(String propName)
```
    Returns a PepperModuleProperty object corresponding to the given property name.
    
    Parameters:
    
    propName - name of the property
    
    Returns:
    
    PepperModuleProperty object
  - getPropertyNames
```
public Collection<String> getPropertyNames()
```
    Returns all property names registered in that object, and therefore usable for the corresponding PepperModule.
    
    Returns:
  - getPropertyDesctriptions
```
public Collection<PepperModuleProperty<?>> getPropertyDesctriptions()
```
    Returns all registered PepperModuleProperty objects, which are usable for the corresponding PepperModule.
    
    Returns:
  - removePropertyValue
```
public void removePropertyValue(String propName)
```
    Removes the value of the property with the passed property name from the properties.
    
    Parameters:
    
    propName - name of the property to be removed
  - stringToCharList
```
public List<Character> stringToCharList(String input)
```
    Expects a list of characters encoded as a String. The String is split and returned as a list of characters. The list must be build like this:
    LIST: ITEM (,ITEM)*
    ITEM: 'CHARACTER'
    
    For instance the passed String "'a', 'b', 'c'" is returned as a list containing 'a', 'b' and 'c'. In case of the characters "'" or "\" are used as items, they must be escaped as "\'" or "\\".
    
    Returns:
    
    the isToTokenize
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PepperModuleProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_AFTER_ADD_SLAYER

PROP_AFTER_COPY_RES

PROP_BEFORE_ADD_SLAYER

PROP_BEFORE_READ_META

PROP_AFTER_REPORT_CORPUSGRAPH

PROP_AFTER_RENAME_ANNOTATIONS

PROP_AFTER_REMOVE_ANNOTATIONS

PROP_AFTER_TOKENIZE

pepperModuleProperties

Constructor Detail

PepperModuleProperties

Method Detail

addProperties

getProperties

setPropertyValues

setPropertyValues

setPropertyValue

checkProperties

checkProperty

addProperty

getProperty

getPropertyNames

getPropertyDesctriptions

removePropertyValue

stringToCharList

toString