Package org.apache.manifoldcf.scriptengine

Class VariableBase

java.lang.Object

org.apache.manifoldcf.scriptengine.VariableBase

All Implemented Interfaces:

Variable, VariableReference

Direct Known Subclasses:

VariableArray, VariableBoolean, VariableConfiguration, VariableConfigurationNode, VariableConnectionName, VariableDict, VariableFloat, VariableInt, VariableQueryArg, VariableResult, VariableString, VariableURL

public class VariableBase
extends java.lang.Object
implements Variable, VariableReference

Base class for variables. Basically, everything is illegal until overridden.

Field Summary

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	Description
VariableBase()

Method Summary

Modifier and Type	Method	Description
VariableReference	ampersand(Variable v)
VariableReference	asterisk(Variable v)
protected java.lang.String	composeMessage(java.lang.String input)	Compose a message which includes the current class name, so we can see what type of variable it is.
VariableReference	doubleAmpersand(Variable v)
VariableReference	doubleEquals(Variable v)
VariableReference	doublePipe(Variable v)
VariableReference	exclamationEquals(Variable v)
VariableReference	getAttribute(java.lang.String attributeName)	Get a named attribute of the variable; e.g.
boolean	getBooleanValue()	Get the variable's value as a boolean
ConfigurationNode	getConfigurationNodeValue()	Get the variable's value as a ConfigurationNode object
Configuration	getConfigurationValue()	Get the variable's value as a Configuration object
double	getDoubleValue()	Get the variable's value as a double
VariableReference	getIndexed(Variable index)	Get an indexed property of the variable
int	getIntValue()	Get the variable's value as an integer
java.lang.String	getQueryArgumentValue()	Get the variable's value as a properly-encoded query argument
java.lang.String	getScriptValue()	Get the variable's script value
java.lang.String	getStringValue()	Get the variable's value as a string
java.lang.String	getURLPathValue()	Get the variable's value as a URL path component
VariableReference	greaterAngle(Variable v)
VariableReference	greaterAngleEquals(Variable v)
boolean	hasBooleanValue()	Check if the variable has a boolean value
boolean	hasConfigurationNodeValue()	Check if the variable has a ConfigurationNode value
boolean	hasConfigurationValue()	Check if the variable has a Configuration value
boolean	hasDoubleValue()	Check if the variable has a double value
boolean	hasIntValue()	Check if the variable has an int value
boolean	hasQueryArgumentValue()	Check if the variable has a query argument value
boolean	hasScriptValue()	Check if the variable has a script value
boolean	hasStringValue()	Check if the variable has a string value
boolean	hasURLPathValue()	Check if the variable has a URL path value
void	insertAt(Variable v, Variable index)	Insert an object into this variable at a position.
boolean	isNull()	Check if this reference is null
VariableReference	lesserAngle(Variable v)
VariableReference	lesserAngleEquals(Variable v)
VariableReference	minus(Variable v)
VariableReference	pipe(Variable v)
VariableReference	plus(Variable v)
void	removeAt(Variable index)	Delete an object from this variable at a position.
Variable	resolve()	Resolve the reference
void	setReference(Variable object)	Set the reference
VariableReference	slash(Variable v)
VariableReference	unaryExclamation()
VariableReference	unaryMinus()

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableBase

public VariableBase()

Method Detail

hasStringValue

public boolean hasStringValue()
                       throws ScriptException

Check if the variable has a string value

Specified by:

hasStringValue in interface Variable

Throws:

ScriptException

hasScriptValue

public boolean hasScriptValue()
                       throws ScriptException

Check if the variable has a script value

Specified by:

hasScriptValue in interface Variable

Throws:

ScriptException

hasConfigurationValue

public boolean hasConfigurationValue()
                              throws ScriptException

Check if the variable has a Configuration value

Specified by:

hasConfigurationValue in interface Variable

Throws:

ScriptException

hasConfigurationNodeValue

public boolean hasConfigurationNodeValue()
                                  throws ScriptException

Check if the variable has a ConfigurationNode value

Specified by:

hasConfigurationNodeValue in interface Variable

Throws:

ScriptException

hasBooleanValue

public boolean hasBooleanValue()
                        throws ScriptException

Check if the variable has a boolean value

Specified by:

hasBooleanValue in interface Variable

Throws:

ScriptException

hasIntValue

public boolean hasIntValue()
                    throws ScriptException

Check if the variable has an int value

Specified by:

hasIntValue in interface Variable

Throws:

ScriptException

hasDoubleValue

public boolean hasDoubleValue()
                       throws ScriptException

Check if the variable has a double value

Specified by:

hasDoubleValue in interface Variable

Throws:

ScriptException

hasQueryArgumentValue

public boolean hasQueryArgumentValue()
                              throws ScriptException

Check if the variable has a query argument value

Specified by:

hasQueryArgumentValue in interface Variable

Throws:

ScriptException

hasURLPathValue

public boolean hasURLPathValue()
                        throws ScriptException

Check if the variable has a URL path value

Specified by:

hasURLPathValue in interface Variable

Throws:

ScriptException

getScriptValue

public java.lang.String getScriptValue()
                                throws ScriptException

Get the variable's script value

Specified by:

getScriptValue in interface Variable

Throws:

ScriptException

getStringValue

public java.lang.String getStringValue()
                                throws ScriptException

Get the variable's value as a string

Specified by:

getStringValue in interface Variable

Throws:

ScriptException

getConfigurationValue

public Configuration getConfigurationValue()
                                    throws ScriptException

Get the variable's value as a Configuration object

Specified by:

getConfigurationValue in interface Variable

Throws:

ScriptException

getConfigurationNodeValue

public ConfigurationNode getConfigurationNodeValue()
                                            throws ScriptException

Get the variable's value as a ConfigurationNode object

Specified by:

getConfigurationNodeValue in interface Variable

Throws:

ScriptException

getBooleanValue

public boolean getBooleanValue()
                        throws ScriptException

Get the variable's value as a boolean

Specified by:

getBooleanValue in interface Variable

Throws:

ScriptException

getIntValue

public int getIntValue()
                throws ScriptException

Get the variable's value as an integer

Specified by:

getIntValue in interface Variable

Throws:

ScriptException

getDoubleValue

public double getDoubleValue()
                      throws ScriptException

Get the variable's value as a double

Specified by:

getDoubleValue in interface Variable

Throws:

ScriptException

getQueryArgumentValue

public java.lang.String getQueryArgumentValue()
                                       throws ScriptException

Get the variable's value as a properly-encoded query argument

Specified by:

getQueryArgumentValue in interface Variable

Throws:

ScriptException

getURLPathValue

public java.lang.String getURLPathValue()
                                 throws ScriptException

Get the variable's value as a URL path component

Specified by:

getURLPathValue in interface Variable

Throws:

ScriptException

plus

public VariableReference plus(Variable v)
                       throws ScriptException

Specified by:

plus in interface Variable

Throws:

ScriptException

minus

public VariableReference minus(Variable v)
                        throws ScriptException

Specified by:

minus in interface Variable

Throws:

ScriptException

asterisk

public VariableReference asterisk(Variable v)
                           throws ScriptException

Specified by:

asterisk in interface Variable

Throws:

ScriptException

slash

public VariableReference slash(Variable v)
                        throws ScriptException

Specified by:

slash in interface Variable

Throws:

ScriptException

unaryMinus

public VariableReference unaryMinus()
                             throws ScriptException

Specified by:

unaryMinus in interface Variable

Throws:

ScriptException

greaterAngle

public VariableReference greaterAngle(Variable v)
                               throws ScriptException

Specified by:

greaterAngle in interface Variable

Throws:

ScriptException

lesserAngle

public VariableReference lesserAngle(Variable v)
                              throws ScriptException

Specified by:

lesserAngle in interface Variable

Throws:

ScriptException

doubleEquals

public VariableReference doubleEquals(Variable v)
                               throws ScriptException

Specified by:

doubleEquals in interface Variable

Throws:

ScriptException

greaterAngleEquals

public VariableReference greaterAngleEquals(Variable v)
                                     throws ScriptException

Specified by:

greaterAngleEquals in interface Variable

Throws:

ScriptException

lesserAngleEquals

public VariableReference lesserAngleEquals(Variable v)
                                    throws ScriptException

Specified by:

lesserAngleEquals in interface Variable

Throws:

ScriptException

exclamationEquals

public VariableReference exclamationEquals(Variable v)
                                    throws ScriptException

Specified by:

exclamationEquals in interface Variable

Throws:

ScriptException

ampersand

public VariableReference ampersand(Variable v)
                            throws ScriptException

Specified by:

ampersand in interface Variable

Throws:

ScriptException

pipe

public VariableReference pipe(Variable v)
                       throws ScriptException

Specified by:

pipe in interface Variable

Throws:

ScriptException

doubleAmpersand

public VariableReference doubleAmpersand(Variable v)
                                  throws ScriptException

Specified by:

doubleAmpersand in interface Variable

Throws:

ScriptException

doublePipe

public VariableReference doublePipe(Variable v)
                             throws ScriptException

Specified by:

doublePipe in interface Variable

Throws:

ScriptException

unaryExclamation

public VariableReference unaryExclamation()
                                   throws ScriptException

Specified by:

unaryExclamation in interface Variable

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

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

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

Throws:

ScriptException

getIndexed

public VariableReference getIndexed(Variable index)
                             throws ScriptException

Get an indexed property of the variable

Specified by:

getIndexed in interface Variable

Throws:

ScriptException

setReference

public void setReference(Variable object)
                  throws ScriptException

Set the reference

Specified by:

setReference in interface VariableReference

Throws:

ScriptException

resolve

public Variable resolve()
                 throws ScriptException

Resolve the reference

Specified by:

resolve in interface VariableReference

Throws:

ScriptException

isNull

public boolean isNull()

Check if this reference is null

Specified by:

isNull in interface VariableReference

composeMessage

protected java.lang.String composeMessage(java.lang.String input)

Compose a message which includes the current class name, so we can see what type of variable it is.