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

Class Variables

java.lang.Object

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

All Implemented Interfaces:

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

public class Variables
extends java.lang.Object
implements org.pfsw.textx.VariableContainer

This is a specialized container for variables (placeholders).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(org.pfsw.util.NamedText namedText)
void	addFrom(java.util.Map<?,?> vars) Adds all key value pairs from the given map to the variables, if the key is a String.
java.util.Map<java.lang.String,java.lang.String>	asHashMap()
protected java.lang.String[]	asStringArray(java.util.Collection<java.lang.String> coll)
Variables	copy() Returns a copy of the variables which ensures that changes to it won't effect the original variables.
java.lang.String	getValue(java.lang.String varName)
java.lang.String	getValueOf(java.lang.String varName) Returns the current value of the variable with the given name or null if the variable is not set.
protected org.pfsw.util.NamedTextList	getVarData()
java.lang.String[]	getVariableNames() Returns all variable names.
boolean	isKnownVariable(java.lang.String varName)
java.util.Set<java.lang.String>	knownVariableNames() Returns all variable names as set.
org.pfsw.util.NamedText[]	namedTextArray()
org.pfsw.util.NamedText	namedTextAt(int index)
void	remove(org.pfsw.util.NamedText varDef)
void	removeAll(java.util.Collection<org.pfsw.util.NamedText> coll)
void	removeVariable(java.lang.String varName)
void	setNamedTextAt(int index, org.pfsw.util.NamedText namedText)
void	setValue(java.lang.String varName, java.lang.String value)
void	setValueFor(java.lang.String varName, java.lang.Object value)
int	size()
protected org.pfsw.text.StringUtil	str()
protected java.util.List<java.lang.String>	variableNameList()

Methods inherited from class java.lang.Object

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

Constructor Detail

Variables

public Variables()

Initialize the new instance with default values.

Method Detail

copy

public Variables copy()

Returns a copy of the variables which ensures that changes to it won't effect the original variables.

removeVariable

public void removeVariable(java.lang.String varName)

Specified by:

removeVariable in interface org.pfsw.textx.VariableContainer

setValue

public void setValue(java.lang.String varName,
                     java.lang.String value)

Specified by:

setValue in interface org.pfsw.textx.VariableContainer

setValueFor

public void setValueFor(java.lang.String varName,
                        java.lang.Object value)

Specified by:

setValueFor in interface org.pfsw.textx.VariableContainer

getValue

public java.lang.String getValue(java.lang.String varName)
                          throws org.pfsw.textx.UnknownVariableException

Specified by:

getValue in interface org.pfsw.textx.VariableResolver

Throws:

org.pfsw.textx.UnknownVariableException

isKnownVariable

public boolean isKnownVariable(java.lang.String varName)

Specified by:

isKnownVariable in interface org.pfsw.textx.VariableResolver

knownVariableNames

public java.util.Set<java.lang.String> knownVariableNames()

Returns all variable names as set.

Specified by:

knownVariableNames in interface org.pfsw.textx.VariableResolver

getValueOf

public java.lang.String getValueOf(java.lang.String varName)

Returns the current value of the variable with the given name or null if the variable is not set. Does not throw UnknownVariableException!

See Also:

getValue(String)

addFrom

public void addFrom(java.util.Map<?,?> vars)

Adds all key value pairs from the given map to the variables, if the key is a String.

getVariableNames

public java.lang.String[] getVariableNames()

Returns all variable names.

size

public int size()

asHashMap

public java.util.Map<java.lang.String,java.lang.String> asHashMap()

add

public void add(org.pfsw.util.NamedText namedText)

remove

public void remove(org.pfsw.util.NamedText varDef)

removeAll

public void removeAll(java.util.Collection<org.pfsw.util.NamedText> coll)

namedTextAt

public org.pfsw.util.NamedText namedTextAt(int index)

setNamedTextAt

public void setNamedTextAt(int index,
                           org.pfsw.util.NamedText namedText)

namedTextArray

public org.pfsw.util.NamedText[] namedTextArray()

variableNameList

protected java.util.List<java.lang.String> variableNameList()

asStringArray

protected java.lang.String[] asStringArray(java.util.Collection<java.lang.String> coll)

getVarData

protected org.pfsw.util.NamedTextList getVarData()

str

protected org.pfsw.text.StringUtil str()