planetj.dataengine.parameter
Class ParameterManager

java.lang.Object
  planetj.dataengine.parameter.ParameterManager

All Implemented Interfaces:

java.lang.Cloneable, IDisplayParameter, IParameter, java.io.Serializable

public abstract class ParameterManager

extends java.lang.Object

implements IDisplayParameter

Contains methods for working with parameters

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

Method Summary

protected static java.lang.String	buildContextSpecificId(int index) Builds the context specific ID of this parameter.
static java.lang.String	buildUniqueID(int contextId, int parameterId) Builds a unqiue ID for a parameter
static java.lang.String	buildUniqueID(int contextId, java.lang.String parameterId) Builds a unqiue ID for a parameter
static void	clearParameters(java.util.Iterator params) Clears all the values of all the parameters
java.lang.Object	clone() Required for compatability reasons
static boolean	isDisplayParameter(IParameter param) Tests if the parameter should be displayed to the user
static boolean	isDisplayParameter(java.lang.String parameterID, IContext context) Tests if the parameter should be displayed to the user
static boolean	isParameterContextSpecificId(java.lang.String id) Tests if the String is a parameter context specific ID
static boolean	isSQLParameter(IParameter param) Tests if the parameter should be passed as a parameter to SQL

Methods inherited from class java.lang.Object

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

Methods inherited from interface planetj.dataengine.parameter.IDisplayParameter

getDisplayField, getDisplayField, getDisplayFieldDescriptor, getOperationString, isDisplay, setOperationString

Methods inherited from interface planetj.dataengine.parameter.IParameter

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

Method Detail

buildContextSpecificId

protected static final java.lang.String buildContextSpecificId(int index)

Builds 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

buildUniqueID

public static final java.lang.String buildUniqueID(int contextId,
                                                   int parameterId)

Builds a unqiue ID for a parameter

buildUniqueID

public static final java.lang.String buildUniqueID(int contextId,
                                                   java.lang.String parameterId)

Builds a unqiue ID for a parameter

clearParameters

public static void clearParameters(java.util.Iterator params)
                            throws CMException

Clears all the values of all the parameters

Parameters:

params - An iteration of IParamter objects

Throws:

CMException

clone

public java.lang.Object clone()

Required for compatability reasons

Specified by:

clone in interface IParameter

isDisplayParameter

public static final boolean isDisplayParameter(java.lang.String parameterID,
                                               IContext context)

Tests if the parameter should be displayed to the user

isDisplayParameter

public static final boolean isDisplayParameter(IParameter param)

Tests if the parameter should be displayed to the user

isParameterContextSpecificId

public static final boolean isParameterContextSpecificId(java.lang.String id)

Tests if the String is a parameter context specific ID

isSQLParameter

public static final boolean isSQLParameter(IParameter param)

Tests if the parameter should be passed as a parameter to SQL