uk.org.jcam.processor.dataObjects
Class Parameter

java.lang.Object
  uk.org.jcam.processor.dataObjects.Parameter

public class Parameter
extends java.lang.Object

uk.jorg.cam.processor.Parameter Used to extract parameter vales from XML dinstance documents and set them directly when they are passed in on the cammand line

Author:

robertmm 27-Jun-2003 17:14:34

Nested Class Summary

static class

Parameter.ParameterException Exception generated when a CAMtemplate function fails

Field Summary

static java.lang.String	ATTR_DEFAULT
static java.lang.String	ATTR_NAME
static java.lang.String	ATTR_TYPE
static java.lang.String	ATTR_TYPE_GLOBAL
static java.lang.String	ATTR_TYPE_LOCAL
static java.lang.String	ATTR_TYPE_OVERRIDE
static java.lang.String	ATTR_VALUES
static java.lang.String	ATTR_XPATH

Constructor Summary

Parameter(java.lang.String name)

Parameter(java.lang.String name, java.lang.String value)

Parameter(java.lang.String name, java.lang.String type, java.lang.String xpath, java.lang.String allowedValues, java.lang.String defaultValue)

Parameter(java.lang.String name, java.lang.String value, java.lang.String type, java.lang.String xpath, java.lang.String allowedValues, java.lang.String defaultValue)

Method Summary

java.lang.String	getAllowedValues()
java.lang.String	getDefaultValue()
java.lang.String	getName()
java.lang.String	getType()
java.lang.String	getValue()
java.lang.String	getXpath()
void	setAllowedValues(java.lang.String allowedValues)
void	setDefaultValue(java.lang.String defaultValue)
void	setName(java.lang.String name)
void	setType(java.lang.String type)
void	setUpParameter(java.lang.String name, java.lang.String type, java.lang.String xpath, java.lang.String allowedValues, java.lang.String defaultValue)
void	setValue(java.lang.String ValueIn)
void	setXpath(java.lang.String xpath)

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_DEFAULT

public static final java.lang.String ATTR_DEFAULT

See Also:

Constant Field Values

ATTR_NAME

public static final java.lang.String ATTR_NAME

See Also:

Constant Field Values

ATTR_TYPE

public static final java.lang.String ATTR_TYPE

See Also:

Constant Field Values

ATTR_TYPE_GLOBAL

public static final java.lang.String ATTR_TYPE_GLOBAL

See Also:

Constant Field Values

ATTR_TYPE_LOCAL

public static final java.lang.String ATTR_TYPE_LOCAL

See Also:

Constant Field Values

ATTR_TYPE_OVERRIDE

public static final java.lang.String ATTR_TYPE_OVERRIDE

See Also:

Constant Field Values

ATTR_VALUES

public static final java.lang.String ATTR_VALUES

See Also:

Constant Field Values

ATTR_XPATH

public static final java.lang.String ATTR_XPATH

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(java.lang.String name)
          throws Parameter.ParameterException

Throws:

Parameter.ParameterException

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value)
          throws Parameter.ParameterException

Throws:

Parameter.ParameterException

Parameter

public Parameter(java.lang.String name,
                 java.lang.String type,
                 java.lang.String xpath,
                 java.lang.String allowedValues,
                 java.lang.String defaultValue)
          throws Parameter.ParameterException

Throws:

Parameter.ParameterException

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value,
                 java.lang.String type,
                 java.lang.String xpath,
                 java.lang.String allowedValues,
                 java.lang.String defaultValue)
          throws Parameter.ParameterException

Throws:

Parameter.ParameterException

Method Detail

getAllowedValues

public java.lang.String getAllowedValues()

Returns:

Returns the allowedValues.

getDefaultValue

public java.lang.String getDefaultValue()

Returns:

Returns the defaultValue.

getName

public java.lang.String getName()

getType

public java.lang.String getType()

Returns:

Returns the type.

getValue

public java.lang.String getValue()

getXpath

public java.lang.String getXpath()

Returns:

Returns the xpath.

setAllowedValues

public void setAllowedValues(java.lang.String allowedValues)
                      throws Parameter.ParameterException

Parameters:

allowedValues - The allowedValues to set.

Throws:

Parameter.ParameterException

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
                     throws Parameter.ParameterException

Parameters:

defaultValue - The defaultValue to set.

Throws:

Parameter.ParameterException

setName

public void setName(java.lang.String name)
             throws Parameter.ParameterException

Parameters:

name - The name to set.

Throws:

Parameter.ParameterException

setType

public void setType(java.lang.String type)
             throws Parameter.ParameterException

Parameters:

type - The type to set.

Throws:

Parameter.ParameterException

setUpParameter

public void setUpParameter(java.lang.String name,
                           java.lang.String type,
                           java.lang.String xpath,
                           java.lang.String allowedValues,
                           java.lang.String defaultValue)
                    throws Parameter.ParameterException

Throws:

Parameter.ParameterException

setValue

public void setValue(java.lang.String ValueIn)
              throws Parameter.ParameterException

Throws:

Parameter.ParameterException

setXpath

public void setXpath(java.lang.String xpath)
              throws Parameter.ParameterException

Parameters:

xpath - The xpath to set.

Throws:

Parameter.ParameterException