planetj.dataengine.parameter
Class ExecutingContextParameter

java.lang.Object
  |
  +--planetj.dataengine.parameter.AbstractParameter
        |
        +--planetj.dataengine.parameter.ExecutingContextParameter

All Implemented Interfaces:

Cloneable, IExecutingContextSource, IJDBCSQLParameter, IParameter, Serializable

public class ExecutingContextParameter

extends AbstractParameter

implements IJDBCSQLParameter, IExecutingContextSource

A parameter which gets its value from an ExecutingContext

See Also:

Serialized Form

Field Summary

Fields inherited from interface planetj.dataengine.parameter.IParameter

CONTEXT_SPECIFIC_ID_END, CONTEXT_SPECIFIC_ID_START, DEFAULT_DATA_TYPE, ID_START, PARAMETER_INDEX_PREFIX

Constructor Summary

ExecutingContextParameter()

Method Summary

String	getExecutingContextKey() Gets the key with which this parameter's value is stored in the ExecutingContext
Object	loadValueFromSource(Object source) Loads this parameter's value from a source.
void	setToken(String token) Sets the literal token that was used to denote this parameter in code

Methods inherited from class planetj.dataengine.parameter.AbstractParameter

clearValue, clone, cloneParameter, equals, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getDefaultValueAsString, getSource, getTargetFieldDescriptor, getToken, getValue, hashCode, isSQLParameter, setContext, setDataType, setDefaultValueAsString, setSource, setSQLParameter, setValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Methods inherited from interface planetj.dataengine.parameter.IParameter

clearValue, clone, cloneParameter, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getSource, getTargetFieldDescriptor, getToken, getValue, setContext, setDataType, setSource, setValue

Constructor Detail

ExecutingContextParameter

public ExecutingContextParameter()

Method Detail

getExecutingContextKey

public String getExecutingContextKey()
                              throws CMException

Gets the key with which this parameter's value is stored in the ExecutingContext

CMException

loadValueFromSource

public Object loadValueFromSource(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.

Specified by:

loadValueFromSource in interface IParameter

CMException

setToken

public void setToken(String token)
              throws CMException

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

Specified by:

setToken in interface IParameter

Overrides:

setToken in class AbstractParameter

CMException