planetj.dataengine.parameter
Class ParameterManager

java.lang.Object
  |
  +--planetj.dataengine.parameter.ParameterManager

All Implemented Interfaces:

Cloneable, IDisplayParameter, IParameter, Serializable

public abstract class ParameterManager

extends 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

Method Summary

static String	buildUniqueID(int contextId, int parameterId) Builds a unqiue ID for a parameter
static String	buildUniqueID(int contextId, String parameterId) Builds a unqiue ID for a parameter
static void	clearParameters(Iterator params) Clears all the values of all the parameters
Object	clone() Required for compatability reasons
static boolean	isDisplayParameter(IParameter param) Tests if the parameter should be displayed to the user
static boolean	isDisplayParameter(String parameterID, IContext context) Tests if the parameter should be displayed to the user
static boolean	isParameterContextSpecificId(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, 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, loadValueFromSource, setContext, setDataType, setSource, setToken, setValue

Method Detail

buildUniqueID

public static final String buildUniqueID(int contextId,
                                         int parameterId)

Builds a unqiue ID for a parameter

buildUniqueID

public static final String buildUniqueID(int contextId,
                                         String parameterId)

Builds a unqiue ID for a parameter

clearParameters

public static void clearParameters(Iterator params)
                            throws CMException

Clears all the values of all the parameters

Parameters:

params - An iteration of IParamter objects

CMException

clone

public Object clone()

Required for compatability reasons

Specified by:

clone in interface IParameter

Overrides:

clone in class Object

isDisplayParameter

public static final boolean isDisplayParameter(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(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