org.writersforge.catalan.process.workers.text
Class TextProperties

java.lang.Object
  org.writersforge.catalan.process.properties.BaseWorkProperties
      org.writersforge.catalan.process.properties.ChainedProperties
          org.writersforge.catalan.process.properties.CommonProperties
              org.writersforge.catalan.process.workers.text.TextProperties

All Implemented Interfaces:

IWorkProperties

public class TextProperties

extends CommonProperties

Specialized properties container for TextWorker.

Author:

jsheets

Constructor Summary

TextProperties(IWorkProperties baseProps)
Creates a new instance of TextProperties.

Method Summary

CaseFilter.CaseStyle	getCaseStyle() Retrieves the value of the "style" property.
java.lang.String[]	getDelimiters() Retrieves the value of the "delimiters" property for the tokenize command.
java.lang.String	getEndToken() Retrieves the value of the "end-token" property.
java.lang.String	getFieldSpec() Retrieves the value of the "field-spec" property.
boolean	getIncludeDelimiters() Retrieves the value of the "include-delimiters" property.
java.lang.String	getNewText() Retrieves the value of the "newtext" property.
java.lang.String[][]	getNormalizeExclusions() Retrieves the value of the "exclusions" property for the normalize command.
java.lang.String	getNormalizeResolver() Retrieves the value of the "resolver" property.
java.lang.String[]	getNormalizeTokens() Retrieves the value of the "tokens" property for the normalize command.
java.lang.String	getOldText() Retrieves the value of the "oldtext" property.
java.lang.String	getPadding() Retrieves the value of the "padding" property.
java.util.Map	getResolverMap() Retrieves the value of the "lookup" property.
java.lang.String	getSeparator() Retrieves the value of the "separator" property.
java.lang.String	getStartToken() Retrieves the value of the "start-token" property.
boolean	getSwallowUndefined() Retrieves the value of the "swallow-undefined" property.

Methods inherited from class org.writersforge.catalan.process.properties.CommonProperties

getCommand, getCount, getEndIndex, getStartIndex

Methods inherited from class org.writersforge.catalan.process.properties.ChainedProperties

addPropertySet, getProperty, getPropertyNames, getPropertySets, toString

Methods inherited from class org.writersforge.catalan.process.properties.BaseWorkProperties

asMap, asMap, getPropertyAsBoolean, getPropertyAsDatum, getPropertyAsMap, getPropertyAsNumber, getPropertyAsString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.writersforge.catalan.process.properties.IWorkProperties

getProperty, getPropertyAsBoolean, getPropertyAsDatum, getPropertyAsMap, getPropertyAsNumber, getPropertyAsString, getPropertyNames

Constructor Detail

TextProperties

public TextProperties(IWorkProperties baseProps)

Creates a new instance of TextProperties.

Parameters:

baseProps - properties to wrap

Method Detail

getSeparator

public java.lang.String getSeparator()

Retrieves the value of the "separator" property.

Returns:

the "separator" property

getFieldSpec

public java.lang.String getFieldSpec()

Retrieves the value of the "field-spec" property.

Returns:

the "field-spec" property

getNormalizeTokens

public java.lang.String[] getNormalizeTokens()

Retrieves the value of the "tokens" property for the normalize command.

Returns:

the "tokens" property

getNormalizeExclusions

public java.lang.String[][] getNormalizeExclusions()

Retrieves the value of the "exclusions" property for the normalize command.

Returns:

the "exclusions" property

getNormalizeResolver

public java.lang.String getNormalizeResolver()

Retrieves the value of the "resolver" property.

Returns:

the "resolver" property

getOldText

public java.lang.String getOldText()

Retrieves the value of the "oldtext" property.

Returns:

the "oldtext" property

getNewText

public java.lang.String getNewText()

Retrieves the value of the "newtext" property.

Returns:

the "newtext" property

getStartToken

public java.lang.String getStartToken()

Retrieves the value of the "start-token" property.

Returns:

the "start-token" property

getEndToken

public java.lang.String getEndToken()

Retrieves the value of the "end-token" property.

Returns:

the "end-token" property

getSwallowUndefined

public boolean getSwallowUndefined()

Retrieves the value of the "swallow-undefined" property.

Returns:

the "swallow-undefined" property

getDelimiters

public java.lang.String[] getDelimiters()

Retrieves the value of the "delimiters" property for the tokenize command.

Returns:

the "delimiters" property

getIncludeDelimiters

public boolean getIncludeDelimiters()

Retrieves the value of the "include-delimiters" property.

Returns:

the "include-delimiters" property

getPadding

public java.lang.String getPadding()

Retrieves the value of the "padding" property.

Returns:

the "padding" property

getResolverMap

public java.util.Map getResolverMap()

Retrieves the value of the "lookup" property. The property should be stored in the wrapped IWorkProperties as a Map; if it is not, this method will return an empty Map.

Returns:

the "lookup" property

getCaseStyle

public CaseFilter.CaseStyle getCaseStyle()

Retrieves the value of the "style" property. Defaults to null, which implies no case change.

Returns:

the "style" property