org.pfsw.tools.cda.base.model.workset

Class VariablePool

java.lang.Object

org.pfsw.textx.GlobalLocalVariables

org.pfsw.textx.GlobalLocalPlaceholderReplacement

org.pfsw.tools.cda.base.model.workset.VariablePool

All Implemented Interfaces:

org.pfsw.textx.VariableContainer, org.pfsw.textx.VariableResolver

public class VariablePool
extends org.pfsw.textx.GlobalLocalPlaceholderReplacement

The container for all variables. Particularly it replaces variables in a given text more than once. That is, variables can contain other placeholders.

Constructor Summary

Constructors

Constructor and Description
VariablePool() Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
VariablePool	copy() Returns a copy of the local variables which ensures that changes to it won't effect the original variables.
java.lang.String	fillInVariables(java.lang.String text) Replaces all text fragments by variable definitions as they can be found in this variable pool.
Variables	getGlobalVariables() Returns the globally defined key/value pairs
Variables	getLocalVariables() Returns the locally defined key/value pairs
protected int	getReplacements()
boolean	isEqual(VariablePool varPool) Returns true if the given variable pool contains the same variables as this one.
java.lang.String	replace(java.lang.String text) Replace all variables in the given text

Methods inherited from class org.pfsw.textx.GlobalLocalPlaceholderReplacement

getFunctionResolver, getTextEngine, setFunctionResolver, setTextEngine

Methods inherited from class org.pfsw.textx.GlobalLocalVariables

getGlobalVars, getLocalVars, getValue, globalVariables, isKnownVariable, knownVariableNames, localVariables, newGlobalContext, newLocalContext, removeVariable, set, setGlobal, setGlobalFrom, setGlobalObject, setGlobalVars, setLocal, setLocalFrom, setLocalObject, setLocalVars, setValue, setValueFor, setVariablesFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablePool

public VariablePool()

Initialize the new instance with default values.

Method Detail

replace

public java.lang.String replace(java.lang.String text)
                         throws org.pfsw.textx.TextReplacementException

Replace all variables in the given text

Overrides:

replace in class org.pfsw.textx.GlobalLocalPlaceholderReplacement

Throws:

org.pfsw.textx.TextReplacementException

getLocalVariables

public Variables getLocalVariables()

Returns the locally defined key/value pairs

getGlobalVariables

public Variables getGlobalVariables()

Returns the globally defined key/value pairs

copy

public VariablePool copy()

Returns a copy of the local variables which ensures that changes to it won't effect the original variables. The reference to the global variables will be identical.

isEqual

public boolean isEqual(VariablePool varPool)

Returns true if the given variable pool contains the same variables as this one.

fillInVariables

public java.lang.String fillInVariables(java.lang.String text)

Replaces all text fragments by variable definitions as they can be found in this variable pool.

getReplacements

protected int getReplacements()