com.infoengine.object.factory
Class Param

java.lang.Object
  com.infoengine.object.factory.Param

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Param
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

See Also:

Serialized Form

Field Summary

static java.lang.String	DATA
static int	KEY
static java.lang.String[]	TYPES
static int	UNKNOWN
static int	VALUE

Constructor Summary

Param(IeAtt att)
Constructs a parameter wrapper around an existing set of meta.

Param(java.lang.String name, int type)
Constructs a named parameter without a value.

Param(java.lang.String name, int type, java.lang.String data)
Constructs a named parameter with a value.

Param(java.lang.String name, java.lang.String data)
Constructs a named parameter without a type.

Param(java.lang.String name, java.lang.String type, java.lang.String data)
Constructs a named parameter with a value.

Method Summary

java.util.Enumeration	applyBinding(Task task) Bind this parameter to variable substitutions in the context of a specified task, and return the resulting value.
java.lang.Object	clone() Creates a shallow copy of this parameter.
java.lang.String	getData() Returns the value of this parameter.
java.lang.String	getDefault() Returns this parameter's default value.
java.lang.String	getDelim() Returns this parameter's delimiter (DELIM) value.
java.lang.String	getElementSeparator() Returns this parameter's element separator value.
java.lang.String	getName() Returns this parameter's name.
int	getType() Returns this parameter's type.
java.lang.String	getValueSeparator() Returns this parameter's value separator value.
void	printTree() Prints the structure of the parameter to System.out.
void	setData(java.lang.String value) Sets the value of this parameter.
void	setDefault(java.lang.String value) Sets this parameter's default value.
void	setDelim(java.lang.String value) Sets this parameter's delimiter (DELIM) value.
void	setElementSeparator(java.lang.String value) Sets this parameter's element separator value.
void	setName(java.lang.String name) Sets this parameter's name.
void	setType(int type) Sets this parameter's type.
void	setType(java.lang.String type) Sets this parameter's type.
void	setValueSeparator(java.lang.String value) Sets this parameter's value separator value.

Methods inherited from class java.lang.Object

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

Field Detail

DATA

public static final java.lang.String DATA

See Also:

Constant Field Values

TYPES

public static final java.lang.String[] TYPES

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

KEY

public static final int KEY

See Also:

Constant Field Values

VALUE

public static final int VALUE

See Also:

Constant Field Values

Constructor Detail

Param

public Param(java.lang.String name,
             java.lang.String type,
             java.lang.String data)

Constructs a named parameter with a value.

Parameters:

name - the name of the parameter

type - the type of the parameter

data - the value of the parameter

Param

public Param(java.lang.String name,
             int type,
             java.lang.String data)

Constructs a named parameter with a value.

Parameters:

name - the name of the parameter

type - the type of the parameter

data - the value of the parameter

Param

public Param(java.lang.String name,
             int type)

Constructs a named parameter without a value.

Parameters:

name - the name of the parameter

type - the type of the parameter

Param

public Param(java.lang.String name,
             java.lang.String data)

Constructs a named parameter without a type.

Parameters:

name - the name of the parameter

data - the value of the parameter

Param

public Param(IeAtt att)

Constructs a parameter wrapper around an existing set of meta.

Parameters:

att - an Info*Engine attribute object

Method Detail

getName

public java.lang.String getName()

Returns this parameter's name.

Returns:

The parameter's current name.

setName

public void setName(java.lang.String name)

Sets this parameter's name.

Parameters:

name - The parameter's new name.

getDefault

public java.lang.String getDefault()

Returns this parameter's default value.

Returns:

The parameter's current default value.

setDefault

public void setDefault(java.lang.String value)

Sets this parameter's default value.

Parameters:

value - The parameter's new default value.

getDelim

public java.lang.String getDelim()

Returns this parameter's delimiter (DELIM) value.

Returns:

The parameter's current delimiter value.

setDelim

public void setDelim(java.lang.String value)

Sets this parameter's delimiter (DELIM) value.

Parameters:

value - The parameter's new default value.

getElementSeparator

public java.lang.String getElementSeparator()

Returns this parameter's element separator value.

Returns:

The parameter's current element separator value.

setElementSeparator

public void setElementSeparator(java.lang.String value)

Sets this parameter's element separator value.

Parameters:

value - The parameter's new element separator value.

getValueSeparator

public java.lang.String getValueSeparator()

Returns this parameter's value separator value.

Returns:

The parameter's current value separator value.

setValueSeparator

public void setValueSeparator(java.lang.String value)

Sets this parameter's value separator value.

Parameters:

value - The parameter's new value separator value.

applyBinding

public java.util.Enumeration applyBinding(Task task)

Bind this parameter to variable substitutions in the context of a specified task, and return the resulting value.

Parameters:

task - The task providing the binding context

Returns:

The string value of this param after binding.

getType

public int getType()

Returns this parameter's type.

Returns:

The parameter's current type.

setType

public void setType(int type)

Sets this parameter's type.

Parameters:

type - The parameter's new type.

setType

public void setType(java.lang.String type)

Sets this parameter's type.

Parameters:

type - The parameter's new type.

getData

public java.lang.String getData()

Returns the value of this parameter.

Returns:

This parameter's current string value.

setData

public void setData(java.lang.String value)

Sets the value of this parameter.

Parameters:

value - This parameter's string value.

clone

public java.lang.Object clone()

Creates a shallow copy of this parameter.

Overrides:

clone in class java.lang.Object

Returns:

The shallow copy.

printTree

public void printTree()

Prints the structure of the parameter to System.out.