org.apache.manifoldcf.scriptengine

Class VariableConfigurationNode

java.lang.Object

org.apache.manifoldcf.scriptengine.VariableBase

org.apache.manifoldcf.scriptengine.VariableConfigurationNode

All Implemented Interfaces:

Variable, VariableReference

public class VariableConfigurationNode
extends VariableBase

Variable wrapper for ConfigurationNode object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	VariableConfigurationNode.AttributeReference Implement VariableReference to allow attributes to be set or cleared
protected class	VariableConfigurationNode.NodeReference Extend VariableReference class so we capture attempts to set the reference, and actually overwrite the child when that is done
protected class	VariableConfigurationNode.ValueReference Implement VariableReference to allow values to be set or cleared

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationNode	configurationNode

Fields inherited from interface org.apache.manifoldcf.scriptengine.Variable

ATTRIBUTE_BOOLEAN, ATTRIBUTE_CREATEDSTATUS, ATTRIBUTE_DICT, ATTRIBUTE_FLOAT, ATTRIBUTE_INT, ATTRIBUTE_NOTFOUNDSTATUS, ATTRIBUTE_OKSTATUS, ATTRIBUTE_SCRIPT, ATTRIBUTE_SIZE, ATTRIBUTE_STRING, ATTRIBUTE_TYPE, ATTRIBUTE_UNAUTHORIZEDSTATUS, ATTRIBUTE_VALUE

Constructor Summary

Constructors

Constructor and Description
VariableConfigurationNode(ConfigurationNode node)
VariableConfigurationNode(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
VariableReference	getAttribute(java.lang.String attributeName) Get a named attribute of the variable; e.g.
ConfigurationNode	getConfigurationNodeValue() Get the variable's value as a ConfigurationNode object
VariableReference	getIndexed(Variable index) Get an indexed property of the variable
java.lang.String	getScriptValue() Get the variable's script value
java.lang.String	getStringValue() Convert to a value
boolean	hasScriptValue() Check if the variable has a script value
boolean	hasStringValue() Check if the variable has a string value
void	insertAt(Variable v, Variable index) Insert an object into this variable at a position.
VariableReference	plus(Variable v)
void	removeAt(Variable index) Delete an object from this variable at a position.

Methods inherited from class org.apache.manifoldcf.scriptengine.VariableBase

ampersand, asterisk, composeMessage, doubleAmpersand, doubleEquals, doublePipe, exclamationEquals, getBooleanValue, getConfigurationValue, getDoubleValue, getIntValue, getQueryArgumentValue, getURLPathValue, greaterAngle, greaterAngleEquals, hasBooleanValue, hasConfigurationNodeValue, hasConfigurationValue, hasDoubleValue, hasIntValue, hasQueryArgumentValue, hasURLPathValue, isNull, lesserAngle, lesserAngleEquals, minus, pipe, resolve, setReference, slash, unaryExclamation, unaryMinus

Methods inherited from class java.lang.Object

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

Field Detail

configurationNode

protected ConfigurationNode configurationNode

Constructor Detail

VariableConfigurationNode

public VariableConfigurationNode(java.lang.String name)

VariableConfigurationNode

public VariableConfigurationNode(ConfigurationNode node)

Method Detail

hasScriptValue

public boolean hasScriptValue()
                       throws ScriptException

Check if the variable has a script value

Specified by:

hasScriptValue in interface Variable

Overrides:

hasScriptValue in class VariableBase

Throws:

ScriptException

getScriptValue

public java.lang.String getScriptValue()
                                throws ScriptException

Get the variable's script value

Specified by:

getScriptValue in interface Variable

Overrides:

getScriptValue in class VariableBase

Throws:

ScriptException

hasStringValue

public boolean hasStringValue()
                       throws ScriptException

Check if the variable has a string value

Specified by:

hasStringValue in interface Variable

Overrides:

hasStringValue in class VariableBase

Throws:

ScriptException

getStringValue

public java.lang.String getStringValue()
                                throws ScriptException

Convert to a value

Specified by:

getStringValue in interface Variable

Overrides:

getStringValue in class VariableBase

Throws:

ScriptException

getConfigurationNodeValue

public ConfigurationNode getConfigurationNodeValue()
                                            throws ScriptException

Get the variable's value as a ConfigurationNode object

Specified by:

getConfigurationNodeValue in interface Variable

Overrides:

getConfigurationNodeValue in class VariableBase

Throws:

ScriptException

getAttribute

public VariableReference getAttribute(java.lang.String attributeName)
                               throws ScriptException

Get a named attribute of the variable; e.g. xxx.yyy

Specified by:

getAttribute in interface Variable

Overrides:

getAttribute in class VariableBase

Throws:

ScriptException

getIndexed

public VariableReference getIndexed(Variable index)
                             throws ScriptException

Get an indexed property of the variable

Specified by:

getIndexed in interface Variable

Overrides:

getIndexed in class VariableBase

Throws:

ScriptException

insertAt

public void insertAt(Variable v,
                     Variable index)
              throws ScriptException

Insert an object into this variable at a position.

Specified by:

insertAt in interface Variable

Overrides:

insertAt in class VariableBase

Throws:

ScriptException

removeAt

public void removeAt(Variable index)
              throws ScriptException

Delete an object from this variable at a position.

Specified by:

removeAt in interface Variable

Overrides:

removeAt in class VariableBase

Throws:

ScriptException

plus

public VariableReference plus(Variable v)
                       throws ScriptException

Specified by:

plus in interface Variable

Overrides:

plus in class VariableBase

Throws:

ScriptException