planetj.dataengine.parameter
Class FieldOrUsageIdParameter

java.lang.Object
  planetj.dataengine.parameter.AbstractParameter
      planetj.dataengine.parameter.FieldOrUsageIdParameter

All Implemented Interfaces:

java.lang.Cloneable, IJDBCSQLParameter, INamedParameter, IParameter, java.io.Serializable

Direct Known Subclasses:

RowParameter, UserParameter

public abstract class FieldOrUsageIdParameter

extends AbstractParameter

implements INamedParameter, IJDBCSQLParameter

A parameter which can get its values based on a usage id or a field name

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, PARAMETER_VALUE_ACTUAL, PARAMETER_VALUE_DISPLAY, PARAMETER_VALUE_UNKNOWN

Constructor Summary

FieldOrUsageIdParameter()

Method Summary

java.lang.String	getParameterName() Gets the name of this parameter (may be null).
protected java.lang.Object	getValueKey() Gets the value key.
boolean	isFieldNameParameter() Tests if this parameter extracts its value based on a field name
boolean	isUsageIdParameter() Tests if this parameter extracts its value based on a usage id
protected void	setValueKey(java.lang.Object valueKey) Sets the value key.

Methods inherited from class planetj.dataengine.parameter.AbstractParameter

clearValue, clone, cloneParameter, equals, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getDefaultValueAsString, getId, getSource, getTargetFieldDescriptor, getToken, getValue, hasAssignedValue, hashCode, isSQLParameter, isValueLoaded, loadValueFromSource, loadValueFromSource, setContext, setContextIndex, setContextInternal, setDataType, setDefaultValueAsString, setSource, setSQLParameter, setToken, setTokenInternal, setValue, setValueInternal, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

isSQLParameter, setSQLParameter

Constructor Detail

FieldOrUsageIdParameter

public FieldOrUsageIdParameter()

Method Detail

getParameterName

public java.lang.String getParameterName()

Gets the name of this parameter (may be null).

Specified by:

getParameterName in interface INamedParameter

getValueKey

protected java.lang.Object getValueKey()

Gets the value key. This is either an Integer (for the usage id case) or a String (for the field name case) which is used to read the value from the source

isFieldNameParameter

public boolean isFieldNameParameter()

Tests if this parameter extracts its value based on a field name

isUsageIdParameter

public boolean isUsageIdParameter()

Tests if this parameter extracts its value based on a usage id

setValueKey

protected void setValueKey(java.lang.Object valueKey)

Sets the value key. This is either an Integer (for the usage id case) or a String (for the field name case)