planetj.dataengine.parameter
Interface IParameter

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Subinterfaces:

IDisplayParameter, IJDBCSQLParameter, INamedParameter

All Known Implementing Classes:

AbstractNamedParameter, AbstractParameter, ContextParameterParameter, ExecutingContextParameter, FieldOrUsageIdParameter, ParameterManager, ParameterParameter, RequestPromptParameter, RuntimeParameter

public interface IParameter

extends java.lang.Cloneable, java.io.Serializable

A Parameter in a DataEngnine operation. All classes which implement this interface should provide a default constructor

Field Summary

static char	CONTEXT_SPECIFIC_ID_END Char with which all parameter context specific id's (NOT unqiue id's) end
static char	CONTEXT_SPECIFIC_ID_START
static int	DEFAULT_DATA_TYPE Default data type for parameter values.
static char	ID_START Char with which all parameter context specific id's begin
static java.lang.String	PARAMETER_INDEX_PREFIX Constant which can be used to identify a parameter by index
static int	PARAMETER_VALUE_ACTUAL
static int	PARAMETER_VALUE_DISPLAY
static int	PARAMETER_VALUE_UNKNOWN

Method Summary

java.lang.Object	clearValue() Clears this parameter's value, returning the current value after it has been cleared.
java.lang.Object	clone() Clones this parameter
IParameter	cloneParameter() Clones this parameter
java.lang.String	getCodeReplacementString() Gets the String which represents this parameter's value in a String of code.
IContext	getContext() Gets the parameter's context
int	getContextIndex() Gets the (0-based) index of this parameter within its context
java.lang.String	getContextSpecificId() Gets the context specific ID of this parameter.
int	getDataType() Gets the SQL data type of the parameter
IParameterSource	getSource() Gets the object from which this parameter was generated.
FieldDescriptorRow	getTargetFieldDescriptor() Gets a field descriptor describing this parameter's target (i.e.
java.lang.String	getToken() Gets the literal token that was used to denote this parameter in code
java.lang.Object	getValue() Gets the value of the parameter
boolean	hasAssignedValue() Tests if this parameter has been assigned a value.
java.lang.Object	loadValueFromSource(java.lang.Object source) Loads this parameter's value from a source.
java.lang.Object	loadValueFromSource(java.lang.Object source, int valueType) Loads this parameter's value from a source.
void	setContext(IContext context) Sets the parameter's context
void	setDataType(int newDataType) Sets the SQL data type of the parameter
void	setSource(IParameterSource source) Sets the object from which this parameter was generated.
void	setToken(java.lang.String token) Sets the literal token that was used to denote this parameter in code
void	setValue(java.lang.Object value) Sets the value of the parameter

Field Detail

DEFAULT_DATA_TYPE

public static final int DEFAULT_DATA_TYPE

Default data type for parameter values.

See Also:

Constant Field Values

ID_START

public static final char ID_START

Char with which all parameter context specific id's begin

See Also:

Constant Field Values

CONTEXT_SPECIFIC_ID_START

public static final char CONTEXT_SPECIFIC_ID_START

See Also:

Constant Field Values

CONTEXT_SPECIFIC_ID_END

public static final char CONTEXT_SPECIFIC_ID_END

Char with which all parameter context specific id's (NOT unqiue id's) end

See Also:

Constant Field Values

PARAMETER_INDEX_PREFIX

public static final java.lang.String PARAMETER_INDEX_PREFIX

Constant which can be used to identify a parameter by index

See Also:

Constant Field Values

PARAMETER_VALUE_UNKNOWN

public static final int PARAMETER_VALUE_UNKNOWN

See Also:

Constant Field Values

PARAMETER_VALUE_ACTUAL

public static final int PARAMETER_VALUE_ACTUAL

See Also:

Constant Field Values

PARAMETER_VALUE_DISPLAY

public static final int PARAMETER_VALUE_DISPLAY

See Also:

Constant Field Values

Method Detail

clearValue

public java.lang.Object clearValue()
                            throws CMException

Clears this parameter's value, returning the current value after it has been cleared.

Throws:

CMException

clone

public java.lang.Object clone()

Clones this parameter

cloneParameter

public IParameter cloneParameter()

Clones this parameter

getCodeReplacementString

public java.lang.String getCodeReplacementString()
                                          throws DataEngineException

Gets the String which represents this parameter's value in a String of code. For SQL parameters, this will be a question mark. For most other parameters, this will be a String representation of the parameter value

Throws:

DataEngineException

getContext

public IContext getContext()

Gets the parameter's context

getContextIndex

public int getContextIndex()

Gets the (0-based) index of this parameter within its context

getContextSpecificId

public java.lang.String getContextSpecificId()

Gets the context specific ID of this parameter. This is just the context index, with the ID_START char tacked onto the beginning of it and the CONTEXT_SPECIFIC_ID_END char tacked onto the end. Two parameters in different contexts may have the same context specific ID

getDataType

public int getDataType()

Gets the SQL data type of the parameter

getSource

public IParameterSource getSource()

Gets the object from which this parameter was generated. This value may be null

getTargetFieldDescriptor

public FieldDescriptorRow getTargetFieldDescriptor()
                                            throws CMException

Gets a field descriptor describing this parameter's target (i.e. where this parameter's value is being set). Not all parameters will have a target field descriptor.

Throws:

CMException

getToken

public java.lang.String getToken()

Gets the literal token that was used to denote this parameter in code

getValue

public java.lang.Object getValue()

Gets the value of the parameter

hasAssignedValue

public boolean hasAssignedValue()

Tests if this parameter has been assigned a value. When this method returns false then this parameter's value is either null or is the default value.

loadValueFromSource

public java.lang.Object loadValueFromSource(java.lang.Object source)
                                     throws CMException

Loads this parameter's value from a source. The object passed in may be ignored if the parameter already knows the source from which its value should be extracted.

Parameters:

source - source Object to use to extract the parameters value

Throws:

CMException

loadValueFromSource

public java.lang.Object loadValueFromSource(java.lang.Object source,
                                            int valueType)
                                     throws CMException

Loads this parameter's value from a source. The object passed in may be ignored if the parameter already knows the source from which its value should be extracted.

Parameters:

source - source Object to use to extract the parameters value

valueType - the type of value to extract. (e.g. actual value or a display value)

Throws:

CMException

setContext

public void setContext(IContext context)

Sets the parameter's context

setDataType

public void setDataType(int newDataType)

Sets the SQL data type of the parameter

setSource

public void setSource(IParameterSource source)

Sets the object from which this parameter was generated. This value may be null

setToken

public void setToken(java.lang.String token)
              throws CMException

Sets the literal token that was used to denote this parameter in code

Throws:

CMException

setValue

public void setValue(java.lang.Object value)
              throws CMException

Sets the value of the parameter

Throws:

CMException