oracle.jbo.server

Class BoundParameter

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.common.VariableImpl

oracle.jbo.server.BoundParameter

All Implemented Interfaces:

java.io.Serializable, AttributeDef, AttributeHints, ResourceBundleOwner, ComponentOperationsManager, JIReservedVarNames, GenericHints, JboReservedVarNames, DiffMergeable, DefPersistable, PersistentDefinition, OperationContainer, Properties, PropertyManager, ValidationManager, ExprWrappable, Variable

Direct Known Subclasses:

AttrFinderParameter, ExprFinderParameter

public class BoundParameter
extends VariableImpl

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.jbo.AttributeDef

AttributeDef.AttributeStorageEnum

Nested classes/interfaces inherited from interface oracle.jbo.AttributeHints

AttributeHints.ControlType

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	BPARAM_DIFF_STRING_ELEMS
static java.lang.String	PARAM_OPTIONAL
static java.lang.String	PARAM_REQUIRED
static java.lang.String	PARAM_SELECTIVELY_REQUIRED

Fields inherited from class oracle.jbo.common.VariableImpl

mTransientExpressionDef

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX

Fields inherited from interface oracle.jbo.Variable

VAR_KIND_VIEW_CRITERIA_IN_MEM_CLAUSE_PARAM, VAR_KIND_VIEW_CRITERIA_PARAM, VAR_KIND_WHERE_CLAUSE_PARAM, VAR_KIND_WHERE_OR_CRIT_PARAM

Fields inherited from interface oracle.jbo.AttributeDef

ATTR_ASSOCIATED_ROW, ATTR_ASSOCIATED_ROWITERATOR, ATTR_DYNAMIC, ATTR_ENTITY_DERIVED, ATTR_HIDDEN, ATTR_PERSISTENT, ATTR_ROWSET, ATTR_SQL_DERIVED, ATTR_TRANSIENT, ATTR_VARIABLE, READONLY, UPDATEABLE, UPDATEABLE_WHILE_NEW

Fields inherited from interface oracle.jbo.AttributeHints

ATTRIBUTE_AUTOSUBMIT, ATTRIBUTE_BINDEDITOR_LABEL, ATTRIBUTE_CTL_CATEGORY, ATTRIBUTE_CTL_DISPLAYHEIGHT, ATTRIBUTE_CTL_DISPLAYWIDTH, ATTRIBUTE_CTL_FIELD_ORDER, ATTRIBUTE_CTL_FORMTYPE, ATTRIBUTE_CTL_TYPE, ATTRIBUTE_DEFINITION_STATE, ATTRIBUTE_DISPLAY_HINT, ATTRIBUTE_DISPLAY_HINT_DISPLAY, ATTRIBUTE_DISPLAY_HINT_HIDE, ATTRIBUTE_FORM_TYPE_DETAIL, ATTRIBUTE_FORM_TYPE_SHORT, ATTRIBUTE_LABEL, ATTRIBUTE_LABEL_PLURAL, ATTRIBUTE_LOVNAME, ATTRIBUTE_PAYLOAD_HINT, ATTRIBUTE_PAYLOAD_HINT_HIDE, ATTRIBUTE_PAYLOAD_HINT_SHOW, ATTRIBUTE_REQUIRED_HINT, ATTRIBUTE_REQUIRED_HINT_OPTIONAL, ATTRIBUTE_REQUIRED_HINT_REQUIRED, ATTRIBUTE_REQUIRED_HINT_SELECTIVELY_REQUIRED, ATTRIBUTE_TIMEZONE_ID, ATTRIBUTE_TOOLTIP, CTL_CHECK_BOX, CTL_CHOICE_LIST, CTL_COMBO_BOX, CTL_COMBO_BOX_LOV, CTL_DATE, CTL_DEFAULT, CTL_DELIMITEDIDS_CHOICE, CTL_EDIT, CTL_IMAGE, CTL_INPUT_TEXT_LOV, CTL_LIST_BOX, CTL_NUMBER_EDIT, CTL_RADIO_GROUP, CTLTYPE_CHECKBOX, CTLTYPE_COMBO, CTLTYPE_COMBOLOV, CTLTYPE_DATE, CTLTYPE_DEFAULT, CTLTYPE_DELIMITEDIDS_CHOICE, CTLTYPE_EDIT, CTLTYPE_IMAGE, CTLTYPE_LIST, CTLTYPE_LISTBOX, CTLTYPE_LOV, CTLTYPE_NUMEDIT, CTLTYPE_RADIOGRP, CTLTYPE_TOGGLE, FMT_FORMAT, FMT_FORMATTER, HINT_NAME_AUTOSUBMIT, HINT_NAME_CATEGORY, HINT_NAME_CTL_TYPE, HINT_NAME_DESCRIPTION, HINT_NAME_DISPLAY_HEIGHT, HINT_NAME_DISPLAY_HINT, HINT_NAME_DISPLAY_WIDTH, HINT_NAME_FIELD_ORDER, HINT_NAME_FORMAT, HINT_NAME_LABEL, HINT_NAME_LABEL_PLURAL, HINT_NAME_LOVNAME, HINT_NAME_MANDATORY, HINT_NAME_MAX_LENGTH, HINT_NAME_MAX_VALUE, HINT_NAME_MIN_LENGTH, HINT_NAME_MIN_VALUE, HINT_NAME_PAYLOAD_HINT, HINT_NAME_SECRET, HINT_NAME_TIMEZONEID, HINT_NAME_TOOLTIP, HINT_NAME_UPDATEABLE, HINT_NAME_WATERMARK, INTERNAL_HINT_NAME_AUTOSUBMIT, PNAME_Button, PNAME_ButtonGroup, PNAME_ComboBox, PNAME_ComboBoxLovEdit, PNAME_ENSURE_KEY_ATTR, PNAME_EnumList, PNAME_LovButton, PNAME_ROWNUMATTR, PNAME_SOURCENAME_ACCESSOR, PNAME_SOURCENAME_ATTR, PNAME_TextField

Fields inherited from interface oracle.jbo.GenericHints

DEFINITION_STATE_ACTIVE, DEFINITION_STATE_DEPRECATED, PROPERTY_DEFINITION_STATE, PROPERTY_ERROR_MSG, PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP

Fields inherited from interface oracle.jbo.JboReservedVarNames

RESERVED_VAR_AGG_AVG, RESERVED_VAR_AGG_COUNT, RESERVED_VAR_AGG_MAX, RESERVED_VAR_AGG_MIN, RESERVED_VAR_AGG_SUM, RESERVED_VAR_AGGVAL_PREFIX, RESERVED_VAR_STRUCTURE_DEF

Fields inherited from interface oracle.jbo.expr.JIReservedVarNames

RESERVED_VAR_VALUE

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

FLAG_DIRTY, FLAG_EDITABLE, FLAG_FROM_TIP, FLAG_LOAD_BASE, FLAG_LOAD_HL_DEFS, FLAG_MAJOR_VERSION_CHANGED, FLAG_MINOR_VERSION_CHANGED, FLAG_NEW, FLAG_NEW_RECURSE, FLAG_SKIP_WRITE, XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
BoundParameter()
BoundParameter(BoundParameter param)
BoundParameter(BoundParameter param, boolean resolve)
BoundParameter(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected VariableImpl	createClone()
protected ExpressionDef	createExpressionDef(java.lang.String expr)
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
ExprCodeSource	editCodeSource(ExprCodeSource codeSource) Notify that ComponentOperationsManager that the client expects to edit the CodeSource.
ExprCodeSource	ensureCodeSource(ExprDef exprDef) Ensure a named code source in the operations manager.
java.lang.String	getAttributeName() If this BoundParameter maps to an attribute, returns the name of mapped attribute.
ComponentOperationsManager	getComponentOperationsManager()
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
java.lang.Class	getJavaType() Returns the Java type of the attribute.
protected ExpressionDef	getMappedValue(java.util.HashMap initValues)
java.lang.String	getOwnerName()
java.lang.String	getRequired() For internal framework use only.
int	getSQLType() Overridden to return -1;
protected ExpressionDef	getTransExprToPersist()
VariableManagerOwner	getVariableManagerOwner()
boolean	isUnmapped() Test if the underlying variable is unmapped
protected ExpressionDef	loadExpressionDef(DefElement xmlElement)
void	loadXMLContents(DefElement xmlElement)
static void	loadXMLParameterContents(DefElement xmlElement, java.util.HashMap valueTab) This method loads a variable value mapping Element into a map.
void	resolve()
void	setTransientExpression(java.lang.String expr)
void	setVariableManagerOwner(VariableManagerOwner owner)
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage
void	writeContents(DefWriter jos) Objects should write their persistence output in this method

Methods inherited from class oracle.jbo.common.VariableImpl

_getDomainContext, addValidator, applyDiffChildren, applyDiffContents, beginDiffObjects, clone, convertToJava, diffObjects, displayInShortForm, ensureDifferDetails, evaluateTransientExpression, getAccessorVO, getAttributeKind, getAttributeStorage, getCategory, getColumnName, getColumnNameForQuery, getColumnType, getCompOpers, getControlType, getDefaultValue, getDefinitionState, getDefManager, getDefScope, getDefTypeName, getDisplayHeight, getDisplayHint, getDisplayWidth, getElemSQLType, getElemType, getExprEval, getExtendedData, getFieldOrder, getFormat, getFormattedAttribute, getFormatter, getFormatterClassName, getHint, getHintValue, getIdentificationAttributeName, getIndex, getJavaTypeName, getLabel, getLabelPlural, getListBindingDef, getLocaleName, getLOVName, getMergeableFullName, getMergeableName, getOperationDefinitions, getOperators, getOrigObject, getPayloadHint, getPrecision, getResourceBundleDef, getResourceBundleDef, getResourcePrefix, getRowOperationDefinitions, getScale, getScriptOperationDefinitions, getScriptRowOperationDefinitions, getSerializerClassName, getSession, getStructureDef, getStructureDef, getTooltip, getTransientExpression, getTransientExpressionDef, getUIHelper, getUpdateableFlag, getValidators, getValueSerializer, getVariableKind, getVariableManager, getXMLContentValue, getXMLElementTag, hasFormatInformation, initDefaultValueNoConversion, initFromXML, initFromXML, initialize, internalGetExprVarVal, internalHasExprVarVal, internalSetVariableKind, isAutoSubmit, isDefinedDefaultValue, isDirty, isDiscrColumn, isDynamicCodeSourceEnabled, isMandatory, isNew, isNewRecurse, isNotCloned, isPassivationNeeded, isPrimaryKey, isQueriable, isSelected, isSkipWrite, isWriteObject, loadCustomProperties, loadProperties, loadSchemaProperties, lookupExprDef, mergePropertyMap, parseFormattedAttribute, removeProperty, removeValidator, requiresNamePrefixedResId, setColumnType, setDefaultValue, setDirty, setElemType, setExtendedData, setJavaType, setJavaTypeName, setMandatory, setName, setNew, setNewRecurse, setOrigObject, setPassivationNeeded, setPrecisionScale, setProperty, setPropertyExpression, setPropertyMap, setSerializerClassName, setSkipWrite, setTransientExpressionDef, setUpdateableFlag, setVariableKind, setVariableManager, writeObject

Methods inherited from class oracle.jbo.common.NamedObjectImpl

allocatePropertyMap, getAllProperties, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyExprEval, getPropertyMap, getPropertyNamesSet, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, hasProperty, isPropertyExpression, refreshProperty, removeProperty, resolveObjectProperty, resolvePropertyRaw, setFullName, setParent, setPropertiesMap, setPropertiesMap2, setProperty, setPropertyExpressionMap, setRawPropertyValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.AttributeDef

getName

Methods inherited from interface oracle.jbo.Properties

getProperties, getProperty, getProperty, refreshProperty

Methods inherited from interface oracle.jbo.rules.ValidationManager

getFullName, getName

Methods inherited from interface oracle.jbo.mom.xml.DefPersistable

getFullName

Methods inherited from interface oracle.jbo.ComponentOperationsManager

getFullName

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Field Detail

BPARAM_DIFF_STRING_ELEMS

protected static final java.lang.String[] BPARAM_DIFF_STRING_ELEMS

PARAM_REQUIRED

public static final java.lang.String PARAM_REQUIRED

See Also:

Constant Field Values

PARAM_SELECTIVELY_REQUIRED

public static final java.lang.String PARAM_SELECTIVELY_REQUIRED

See Also:

Constant Field Values

PARAM_OPTIONAL

public static final java.lang.String PARAM_OPTIONAL

See Also:

Constant Field Values

Constructor Detail

BoundParameter

public BoundParameter()

BoundParameter

public BoundParameter(java.lang.String name)

BoundParameter

public BoundParameter(BoundParameter param)

BoundParameter

public BoundParameter(BoundParameter param,
                      boolean resolve)

Method Detail

createClone

protected VariableImpl createClone()

Overrides:

createClone in class VariableImpl

createExpressionDef

protected ExpressionDef createExpressionDef(java.lang.String expr)

Overrides:

createExpressionDef in class VariableImpl

loadExpressionDef

protected ExpressionDef loadExpressionDef(DefElement xmlElement)

Overrides:

loadExpressionDef in class VariableImpl

resolve

public void resolve()

Specified by:

resolve in interface Variable

Overrides:

resolve in class VariableImpl

setTransientExpression

public void setTransientExpression(java.lang.String expr)

Specified by:

setTransientExpression in interface Variable

Overrides:

setTransientExpression in class VariableImpl

getTransExprToPersist

protected ExpressionDef getTransExprToPersist()

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Overrides:

writeContents in class VariableImpl

Parameters:

jos - the Output storage for persistence

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Overrides:

writeChildren in class VariableImpl

Parameters:

jos - the Output storage for persistence

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class VariableImpl

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class VariableImpl

loadXMLParameterContents

@Concealed
public static void loadXMLParameterContents(DefElement xmlElement,
                                                       java.util.HashMap valueTab)

This method loads a variable value mapping Element into a map. It also loads DCParameterDef's xml attribute into the map.

For internal use only. Application developers should not use this

loadXMLContents

public void loadXMLContents(DefElement xmlElement)

getMappedValue

protected ExpressionDef getMappedValue(java.util.HashMap initValues)

getRequired

@Concealed
public java.lang.String getRequired()

For internal framework use only.

For internal use only. Application developers should not use this

getAttributeName

@Concealed
public java.lang.String getAttributeName()

If this BoundParameter maps to an attribute, returns the name of mapped attribute. Otherwise, return the viewcriteria variable name.

For internal use only. Application developers should not use this

isUnmapped

public boolean isUnmapped()

Test if the underlying variable is unmapped

Returns:

true, if the underlying variable is unmapped

getOwnerName

public java.lang.String getOwnerName()

setVariableManagerOwner

public void setVariableManagerOwner(VariableManagerOwner owner)

getVariableManagerOwner

public VariableManagerOwner getVariableManagerOwner()

getJavaType

public java.lang.Class getJavaType()

Description copied from class: VariableImpl

Returns the Java type of the attribute.

For example, if the attribute is of type String, this method returns java.lang.String; if it is of type Number, it returns oracle.jbo.domain.Number.

Subclasses should override this method because Entities without accessors should also be able to get their types from attribute descriptors and beans.

Specified by:

getJavaType in interface AttributeDef

Overrides:

getJavaType in class VariableImpl

Returns:

the attribute's Java class, or Object for attributes which have no accessor methods available.

getSQLType

public int getSQLType()

Description copied from class: VariableImpl

Overridden to return -1;

Specified by:

getSQLType in interface AttributeDef

Specified by:

getSQLType in interface Variable

Overrides:

getSQLType in class VariableImpl

Returns:

the JDBC type.

See Also:

Types

diffContents

public DifferDetails diffContents(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of scalar values. Typically, scalar attr values are grouped into String, int, and boolean arrays -- one set coming from 'this' definition and the other set coming from orgDef. Then, help methods on DifferBase can be used to diff the attr values and accumulate the details of diff in difDetails.

Here is example code snippet:

    private static final String DIFF_STRING_ELEMS[] =
    {
       "MyStringVal1",
       "MyStringVal2"
    };

    private static final String DIFF_INT_ELEMS[] =
    {
       "MyIntVal",
    }

    public DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       <Your-def-class> orgDefImpl = (<Your-def-class>) orgDef;

       final String editStringValues[] =
       {
          this.getMyStringVal1(),
          this.getMyStringVal2()
       };

       String orgStringValues[] = null;

       if (orgDef != null)
       {
          String orgV[] =
          {
             orgDefImpl.getMyStringVal1(),
             orgDefImpl.getMyStringVal2()
          };

          orgStringValues = orgV;
       }

       final int editIntValues[] =
       {
          this.getMyIntVal(),
       };

       int orgIntValues[] = null;

       if (orgDef != null)
       {
          int orgV[] =
          {
             orgDefImpl.getMyIntVal()
          };

          orgIntValues = orgV;
       }

       difDetails = DifferBase.diffStringArray(this, DIFF_STRING_ELEMS, editStringValues, orgStringValues, difDetails);
       difDetails = DifferBase.diffIntArray(this, DIFF_INT_ELEMS, editIntValues, orgIntValues, difDetails);

       return difDetails;
   }
 

Specified by:

diffContents in interface DiffMergeable

Overrides:

diffContents in class VariableImpl

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

diffChildren

public DifferDetails diffChildren(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of children defs. This def should enumerate through all its children and diff them and accumulate details of diff into difDetails and return it at the end.

For example, if this def has Child1 and Child2, its implementation should look something like:

    public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);

       return difDetails;
    }
 

where diffChildrenChild1() uses DifferChildren's helper method diffChildrenList to diff the child defs.

Specified by:

diffChildren in interface DiffMergeable

Overrides:

diffChildren in class VariableImpl

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

ensureCodeSource

public ExprCodeSource ensureCodeSource(ExprDef exprDef)

Description copied from interface: ComponentOperationsManager

Ensure a named code source in the operations manager. Returns a copy of an existing CodeSource or a new CodeSource. The client must invoke #updateCodeSource to update the component operations manager with any updates that are made to this CodeSource.

Specified by:

ensureCodeSource in interface ComponentOperationsManager

Overrides:

ensureCodeSource in class VariableImpl

Parameters:

exprDef - a null exprDef may be used to indicate the a built-in code source.

editCodeSource

public ExprCodeSource editCodeSource(ExprCodeSource codeSource)

Description copied from interface: ComponentOperationsManager

Notify that ComponentOperationsManager that the client expects to edit the CodeSource.

Specified by:

editCodeSource in interface ComponentOperationsManager

Overrides:

editCodeSource in class VariableImpl

Returns:

an editable version of the CodeSource. All edits should be made to this version of the CodeSoruce.

getComponentOperationsManager

public ComponentOperationsManager getComponentOperationsManager()

Overrides:

getComponentOperationsManager in class VariableImpl