org.apache.commons.workflow.base
Class BaseDescriptor

java.lang.Object
  org.apache.commons.workflow.base.BaseDescriptor

All Implemented Interfaces:

org.apache.commons.workflow.Descriptor

public class BaseDescriptor

extends java.lang.Object

implements org.apache.commons.workflow.Descriptor

Basic implementation of the Descriptor interface.

Version:

$Revision: 1.9 $ $Date: 2004/02/28 03:35:54 $

Field Summary

protected java.lang.String	name The name of the Java object (in some scope).
protected java.lang.String	scope The scope of the Java object.
protected java.lang.Class	type The optional Java class expected by this Descriptor.
protected java.lang.String	xpath The XPath expression used to access the Java object.

Constructor Summary

BaseDescriptor()
Create an instance with default values.

BaseDescriptor(java.lang.String xpath)
Create an instance with the specified values.

BaseDescriptor(java.lang.String xpath, java.lang.Class type)
Create an instance with the specified values.

BaseDescriptor(java.lang.String name, java.lang.String scope)
Create an instance with the specified values.

BaseDescriptor(java.lang.String name, java.lang.String scope, java.lang.Class type)
Create an instance with the specified values.

BaseDescriptor(java.lang.String name, java.lang.String scope, java.lang.String xpath, java.lang.Class type)
Create an instance with the specified values.

Method Summary

java.lang.Object	get(org.apache.commons.workflow.Context context) Return the value specified by this Descriptor from the specified Context.
java.lang.String	getName() Return the name of the Java object (in some scope) referenced by this Descriptor.
java.lang.String	getScope() Return the scope of the Java object referenced by this Descriptor.
java.lang.Class	getType() Return the optional Java class expected by this Descriptor.
java.lang.String	getXpath() Return the XPath expression used to access the Java object referenced by this Descriptor.
boolean	positive(org.apache.commons.workflow.Context context) Call get() to retrieve the value specified by this Descriptor, and then return true if this value represents a positive result; otherwise return false.
void	put(org.apache.commons.workflow.Context context, java.lang.Object value) Store the value into the destination specified by this Descriptor in the specified Context, replacing any existing value.
void	remove(org.apache.commons.workflow.Context context) Remove any existing value associated with this Descriptor from the specified Context.
void	setName(java.lang.String name) Set the name of the Java object (in some scope) referenced by this Descriptor.
void	setScope(java.lang.String scope) Set the scope of the Java object referenced by this Descriptor.
void	setType(java.lang.Class type) Set the optional Java class expected by this Descriptor.
void	setXpath(java.lang.String xpath) Set the XPath expression used to access the Java object referenced by this Descriptor.
java.lang.String	toString() Render a printable version of this object.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The name of the Java object (in some scope).

scope

protected java.lang.String scope

The scope of the Java object.

type

protected java.lang.Class type

The optional Java class expected by this Descriptor.

xpath

protected java.lang.String xpath

The XPath expression used to access the Java object.

Constructor Detail

BaseDescriptor

public BaseDescriptor()

Create an instance with default values.

BaseDescriptor

public BaseDescriptor(java.lang.String xpath)

Create an instance with the specified values.

Parameters:

xpath - The XPath reference expression

BaseDescriptor

public BaseDescriptor(java.lang.String xpath,
                      java.lang.Class type)

Create an instance with the specified values.

Parameters:

xpath - The XPath reference expression

type - The expected class of this object

BaseDescriptor

public BaseDescriptor(java.lang.String name,
                      java.lang.String scope)

Create an instance with the specified values.

Parameters:

name - The object name

scope - The object scope

BaseDescriptor

public BaseDescriptor(java.lang.String name,
                      java.lang.String scope,
                      java.lang.Class type)

Create an instance with the specified values.

Parameters:

name - The object name

scope - The object scope

type - The expected class of this object

BaseDescriptor

public BaseDescriptor(java.lang.String name,
                      java.lang.String scope,
                      java.lang.String xpath,
                      java.lang.Class type)

Create an instance with the specified values.

Parameters:

name - The object name

scope - The object scope

xpath - The XPath reference expression

type - The expected class

Method Detail

getName

public java.lang.String getName()

Return the name of the Java object (in some scope) referenced by this Descriptor.

Specified by:

getName in interface org.apache.commons.workflow.Descriptor

setName

public void setName(java.lang.String name)

Set the name of the Java object (in some scope) referenced by this Descriptor.

Specified by:

setName in interface org.apache.commons.workflow.Descriptor

Parameters:

name - The new object name

getScope

public java.lang.String getScope()

Return the scope of the Java object referenced by this Descriptor.

Specified by:

getScope in interface org.apache.commons.workflow.Descriptor

setScope

public void setScope(java.lang.String scope)

Set the scope of the Java object referenced by this Descriptor.

Specified by:

setScope in interface org.apache.commons.workflow.Descriptor

Parameters:

scope - The new scope name

getType

public java.lang.Class getType()

Return the optional Java class expected by this Descriptor.

Specified by:

getType in interface org.apache.commons.workflow.Descriptor

setType

public void setType(java.lang.Class type)

Set the optional Java class expected by this Descriptor.

Specified by:

setType in interface org.apache.commons.workflow.Descriptor

Parameters:

type - The new expected type

getXpath

public java.lang.String getXpath()

Return the XPath expression used to access the Java object referenced by this Descriptor.

Specified by:

getXpath in interface org.apache.commons.workflow.Descriptor

setXpath

public void setXpath(java.lang.String xpath)

Set the XPath expression used to access the Java object referenced by this Descriptor.

Specified by:

setXpath in interface org.apache.commons.workflow.Descriptor

Parameters:

xpath - The new XPath expression

get

public java.lang.Object get(org.apache.commons.workflow.Context context)

Return the value specified by this Descriptor from the specified Context. If there is no such value, return null.

Specified by:

get in interface org.apache.commons.workflow.Descriptor

Parameters:

context - Context from which to retrieve this value

positive

public boolean positive(org.apache.commons.workflow.Context context)

Call get() to retrieve the value specified by this Descriptor, and then return true if this value represents a positive result; otherwise return false. A positive result depends on the data type of the retrieved value:

• Value returned is a String of length greater than 0.
• Value is a Boolean "true".
• Value is a numeric primitive (byte, char, float, double, int, long, short), or an Object wrapper for one of these types, and the corresponding value is non-zero.
• Value returned is a non-null Object.

Specified by:

positive in interface org.apache.commons.workflow.Descriptor

Parameters:

context - Context from which to retrieve this value

put

public void put(org.apache.commons.workflow.Context context,
                java.lang.Object value)

Store the value into the destination specified by this Descriptor in the specified Context, replacing any existing value.

Specified by:

put in interface org.apache.commons.workflow.Descriptor

Parameters:

context - Context into which to store this value

value - Object value to be stored

remove

public void remove(org.apache.commons.workflow.Context context)

Remove any existing value associated with this Descriptor from the specified Context.

Specified by:

remove in interface org.apache.commons.workflow.Descriptor

Parameters:

context - Context from which to remove this value.

toString

public java.lang.String toString()

Render a printable version of this object.