oracle.jbo.common

Class VariableImpl

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.common.VariableImpl

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:

BoundParameter, DCVariableImpl

public class VariableImpl
extends NamedObjectImpl
implements Variable, ValidationManager, AttributeHints, JboReservedVarNames, java.io.Serializable, DefPersistable, ResourceBundleOwner, DiffMergeable, ComponentOperationsManager, PropertyManager

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 ExpressionDef	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
VariableImpl() Default constructor for this class.
VariableImpl(java.lang.String name)
VariableImpl(java.lang.String name, java.lang.Class javaType)
VariableImpl(java.lang.String name, java.lang.Object defaultValue, byte updateable, boolean notNull, java.lang.Class javaType)
VariableImpl(VariableImpl var)

Method Summary

Modifier and Type	Method and Description
java.util.Map	_getDomainContext()
void	addValidator(JboValidatorInterface listener) Add a JboValidatorInterface to the listener list.
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
void	applyDiffContents(DifferDetails dif, DiffResolver resolver) When diff/merge operation is requested, we have the following three def objects:
DifferDetails	beginDiffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) This method is the entry point call when the diffing process begins on the document-level def.
java.lang.Object	clone()
java.lang.Object	convertToJava(java.lang.Object data) Converts a value from the database type to its corresponding Java type and returns the result.
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.
DifferDetails	diffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) The work-horse method performing diff between two defs of this def type.
boolean	displayInShortForm(LocaleContext locale) Returns true if the attribute is to displayed in the short(summary) form.
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.
DifferDetails	ensureDifferDetails(DifferDetails difDetails) Ensures that we have a valid DifferDetails.
java.lang.Object	evaluateTransientExpression(VariableManagerOwnerBase owner)
ViewObject	getAccessorVO(ViewObject originVO) For an accessor attribute, this method creates a View Object that works for the View Link definition.
byte	getAttributeKind() Gets the attribute value.
AttributeDef.AttributeStorageEnum	getAttributeStorage()
java.lang.String	getCategory(LocaleContext locale) Returns the category that this attribute belongs to
java.lang.String	getColumnName() Overridden to return null in Variable implementations.
java.lang.String	getColumnNameForQuery() Overridden to return null in Variable implementations.
java.lang.String	getColumnType() This method is used if the variable is of array type to get to the type name created in the database to store the array values.
ComponentOperationsManager	getComponentOperationsManager()
java.lang.String[][]	getCompOpers(LocaleContext locale) Returns a Map of operators for this attribute.
int	getControlType(LocaleContext locale) Returns the preferred control type for this attribute
java.lang.Object	getDefaultValue() Returns the default value of the attribute.
java.lang.String	getDefinitionState(LocaleContext locale) Retrives the definition state string that indicates if this object is deprecated.
DefinitionManager	getDefManager()
int	getDefScope()
java.lang.String	getDefTypeName() Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
int	getDisplayHeight(LocaleContext locale) Returns the display width for this attribute
java.lang.String	getDisplayHint(LocaleContext locale) Retrieves the displya hint that dictates whether this attributr should be visible or not.
int	getDisplayWidth(LocaleContext locale) Returns the display width for this attribute
int	getElemSQLType() Overridden to return -1.
java.lang.Class	getElemType() Returns the class type for the elements if this variable stores array types.
ExprEval	getExprEval()
java.lang.Object	getExtendedData()
double	getFieldOrder(LocaleContext locale) Returns the field order for this attribute
java.lang.String	getFormat(LocaleContext locale) returns the format string stored in the ui hints
java.lang.String	getFormattedAttribute(AttributeList attrList, LocaleContext locale) Returns the formatted value for the attribute.
Formatter	getFormatter(LocaleContext locale) returns the formatter object stored in the ui hints
java.lang.String	getFormatterClassName(LocaleContext locale) returns the formatter object stored in the ui hints
java.lang.String	getHint(LocaleContext locale, java.lang.String sHintName) Return defaulted hint value
java.lang.String	getHintValue(LocaleContext locale, java.lang.String sHintName) Return non-defaulted hint value
java.lang.String	getIdentificationAttributeName() return the attribute name for identification on an xml element.
int	getIndex() Overridden to return -1 for index.
java.lang.Class	getJavaType() Returns the Java type of the attribute.
java.lang.String	getJavaTypeName() Returns the name of the Java type of the attribute, mainly for design time.
java.lang.String	getLabel(LocaleContext locale) Retrieves the label to be used in any attribute prompts
java.lang.String	getLabelPlural(LocaleContext locale) Retrives the label plural text to be used for this attribute
ListBindingDef	getListBindingDef()
java.lang.String	getLocaleName(LocaleContext locale, java.lang.String sName) function for retrieving the locale name of a hint
java.lang.String	getLOVName() Gets the name of the LOV (list of values) associated with this attribute definition.
java.lang.String	getMergeableFullName() Returns the fully qualified name of the diff-mergeable definition object.
java.lang.String	getMergeableName() Returns the diff-mergeable definition's name (short form).
OperationDefinitions	getOperationDefinitions()
java.util.Map	getOperators(LocaleContext locale)
DefPersistable	getOrigObject()
java.lang.String	getPayloadHint(LocaleContext locale) Retrieves the payload hint that dictates whether this attribute should be included in service payload or not.
int	getPrecision() Gets the attribute's precision.
ResourceBundleDef	getResourceBundleDef()
ResourceBundleDef	getResourceBundleDef(java.lang.String resBundleId)
java.lang.String	getResourcePrefix()
OperationDefinitions	getRowOperationDefinitions()
int	getScale() Gets the attribute's scale value: the number of digits to the right or left of the decimal point, depending on whether the scale value is positive or negative.
OperationDefinitions	getScriptOperationDefinitions()
OperationDefinitions	getScriptRowOperationDefinitions()
java.lang.String	getSerializerClassName() Gets the name of the custom value serializer class.
static Session	getSession(VariableManagerOwnerBase owner)
int	getSQLType() Overridden to return -1;
StructureDef	getStructureDef()
static StructureDef	getStructureDef(VariableManagerOwnerBase owner)
java.lang.String	getTooltip(LocaleContext locale) Retrives the tooltip text to be used for this attribute
java.lang.String	getTransientExpression()
ExpressionDef	getTransientExpressionDef()
AttributeHints	getUIHelper() return the AttributeHints interface implemented by this class
byte	getUpdateableFlag() Returns whether the attribute is updateable.
java.util.ArrayList	getValidators() Get the list of JboValidatorInterface objects registered with this attribute
ValueSerializer	getValueSerializer() Gets an instance of the custom value serializer class.
java.lang.String	getVariableKind()
VariableManager	getVariableManager()
java.lang.Object	getXMLContentValue(org.w3c.dom.Element varElem) Converts an XML element to an instance of this variable's Java type.
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
boolean	hasFormatInformation(LocaleContext locale) Return true if any format hints have been defined for this attribute.
void	initDefaultValueNoConversion(java.lang.String val) *** For internal framework use only *** only for testing purposes
void	initFromXML(DefElement xmlElement) *** For internal framework use only ***
void	initFromXML(DefElement xmlElement, boolean bDesignTime) *** For internal framework use only ***
protected void	initialize(VariableImpl fromVar)
static java.lang.Object	internalGetExprVarVal(java.lang.String varName, VariableManagerOwnerBase owner, java.lang.Object propertyBase)
static boolean	internalHasExprVarVal(java.lang.String varName, VariableManagerOwnerBase owner, java.lang.Object propertyBase)
void	internalSetVariableKind(java.lang.String kind)
boolean	isAutoSubmit(LocaleContext locale) Returns the autoSubmit value for this attribute
boolean	isDefinedDefaultValue() Passivation uses this to tell if the current value is not the definition default.
boolean	isDirty() This method returns if an Object is modified from last save/load
boolean	isDiscrColumn() Tests if an attribute is a discriminator.
boolean	isDynamicCodeSourceEnabled()
boolean	isMandatory() Returns whether the attribute is not null.
boolean	isNew() This method returns if this object is previously persisted.
boolean	isNewRecurse()
boolean	isNotCloned()
boolean	isPassivationNeeded() The framework calls this api when building the sparse list of variables that need passivation.
boolean	isPrimaryKey() Overridden to return false;
boolean	isQueriable() Returns true for Variables that are bound as where-clause parameters
boolean	isSelected()
boolean	isSkipWrite()
boolean	isWriteObject(DefPersistable parentObj, DefWriter defWriter)
protected void	loadCustomProperties(DefElement xmlElement, java.util.Map givenMap)
protected ExpressionDef	loadExpressionDef(DefElement xmlElement)
protected void	loadProperties(DefElement xmlElement)
protected void	loadSchemaProperties(DefElement xmlElement, java.util.Map givenMap)
ExprDef	lookupExprDef(OwnerType type, java.lang.String path) Search for an ExprDef in the ComponentOperationsManager's namespace.
void	mergePropertyMap(java.util.Map m)
java.lang.Object	parseFormattedAttribute(java.lang.String sValue, LocaleContext locale) Strips off the formatting from a string and constructs an instance of the attribute's domain using the 'clean' string as a parameter of the contructor.
void	removeProperty(java.lang.String hintName, LocaleContext locale)
void	removeValidator(JboValidatorInterface listener) Removes a JboValidatorInterface from the listener list.
protected boolean	requiresNamePrefixedResId()
void	resolve()
void	setColumnType(java.lang.String columnType) This method is used to set the name of the table created in the database to store the array values.
void	setDefaultValue(java.lang.Object val)
void	setDirty(boolean b) This method marks the Object dirty
void	setElemType(java.lang.String elementTypeName) Sets the class type for the elements if this variable stores array types.
void	setExtendedData(java.lang.Object data)
void	setJavaType(java.lang.Class cls)
void	setJavaTypeName(java.lang.String typeName) *** For internal framework use only ***
void	setMandatory(boolean b)
void	setName(java.lang.String name) Name this object.
void	setNew(boolean b) This method marks the as previously persisted.
void	setNewRecurse(boolean b)
void	setOrigObject(DefPersistable oldObj)
protected void	setPassivationNeeded(boolean flag) *** For internal framework use only ***
void	setPrecisionScale(int prec, int scale) Sets the attribute's precision and scale.
void	setProperty(java.lang.String hintName, java.lang.Object hintValue, LocaleContext locale)
protected void	setPropertyExpression(java.lang.String name, java.lang.String expr)
void	setPropertyMap(java.util.Map m) Replaces all properties.
void	setSerializerClassName(java.lang.String className) Sets the name of the custom value serializer class.
void	setSkipWrite(boolean b)
void	setTransientExpression(java.lang.String expr)
void	setTransientExpressionDef(ExpressionDef exprDef) Add an expression to the variable.
void	setUpdateableFlag(byte updateable)
void	setVariableKind(java.lang.String kind)
void	setVariableManager(VariableManager manager)
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
void	writeObject(DefWriter jos) Objects should write their persistence output in this method

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

mTransientExpressionDef

protected ExpressionDef mTransientExpressionDef

Constructor Detail

VariableImpl

public VariableImpl()

Default constructor for this class.

VariableImpl

public VariableImpl(java.lang.String name)

VariableImpl

public VariableImpl(java.lang.String name,
                    java.lang.Class javaType)

VariableImpl

public VariableImpl(java.lang.String name,
                    java.lang.Object defaultValue,
                    byte updateable,
                    boolean notNull,
                    java.lang.Class javaType)

VariableImpl

public VariableImpl(VariableImpl var)

Method Detail

createClone

protected VariableImpl createClone()

createExpressionDef

protected ExpressionDef createExpressionDef(java.lang.String expr)

loadExpressionDef

protected ExpressionDef loadExpressionDef(DefElement xmlElement)

clone

public java.lang.Object clone()

Specified by:

clone in interface Variable

Overrides:

clone in class java.lang.Object

setName

public void setName(java.lang.String name)

Description copied from class: NamedObjectImpl

Name this object.

Specified by:

setName in interface Variable

Overrides:

setName in class NamedObjectImpl

Parameters:

name - the name to be given to this object.

getMergeableName

public java.lang.String getMergeableName()

Description copied from interface: DiffMergeable

Returns the diff-mergeable definition's name (short form).

Specified by:

getMergeableName in interface DiffMergeable

Returns:

name of the def object

getMergeableFullName

public java.lang.String getMergeableFullName()

Description copied from interface: DiffMergeable

Returns the fully qualified name of the diff-mergeable definition object. It must uniquely identify the def object.

Specified by:

getMergeableFullName in interface DiffMergeable

Returns:

full name of the def object

getVariableManager

public VariableManager getVariableManager()

Specified by:

getVariableManager in interface Variable

setVariableManager

public void setVariableManager(VariableManager manager)

Specified by:

setVariableManager in interface Variable

resolve

public void resolve()

Specified by:

resolve in interface Variable

getVariableKind

public java.lang.String getVariableKind()

Specified by:

getVariableKind in interface Variable

isNotCloned

public boolean isNotCloned()

For internal use only. Application developers should not use this

internalSetVariableKind

public void internalSetVariableKind(java.lang.String kind)

For internal use only. Application developers should not use this

setVariableKind

public void setVariableKind(java.lang.String kind)

Specified by:

setVariableKind in interface Variable

getExtendedData

public java.lang.Object getExtendedData()

Specified by:

getExtendedData in interface Variable

setExtendedData

public void setExtendedData(java.lang.Object data)

Specified by:

setExtendedData in interface Variable

getUpdateableFlag

public byte getUpdateableFlag()

Returns whether the attribute is updateable.

Specified by:

getUpdateableFlag in interface AttributeDef

Returns:

true if this is an editable attribute; false otherwise.

setUpdateableFlag

public void setUpdateableFlag(byte updateable)

Specified by:

setUpdateableFlag in interface Variable

isMandatory

public boolean isMandatory()

Returns whether the attribute is not null.

Specified by:

isMandatory in interface AttributeDef

Returns:

true if this is attribute not null; false otherwise.

setMandatory

public void setMandatory(boolean b)

Specified by:

setMandatory in interface Variable

getPrecision

public int getPrecision()

Gets the attribute's precision.

For strings, precision is maximum allowed length. For numeric values, precision is the number of significant digits.

Specified by:

getPrecision in interface AttributeDef

Returns:

the precision value, or 0 if unspecified.

getScale

public int getScale()

Gets the attribute's scale value: the number of digits to the right or left of the decimal point, depending on whether the scale value is positive or negative.

Scale value is meaningful only for numeric attributes.

Specified by:

getScale in interface AttributeDef

Returns:

the scale value. The default is -127.

setPrecisionScale

public void setPrecisionScale(int prec,
                              int scale)

Sets the attribute's precision and scale.

For strings, precision is maximum allowed length. For numeric values, precision is the number of significant digits.

Scale is the number of digits to the right or left of the decimal point, depending on whether the scale value is positive or negative. Scale is meaning only for numeric attributes.

Specified by:

setPrecisionScale in interface Variable

Parameters:

prec - the precision value, or 0 if unspecified.

scale - the scale value. The default is -127.

getJavaType

public java.lang.Class getJavaType()

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

Returns:

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

setJavaType

public void setJavaType(java.lang.Class cls)

Specified by:

setJavaType in interface Variable

getJavaTypeName

public java.lang.String getJavaTypeName()

Returns the name of the Java type of the attribute, mainly for design time.

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.

Specified by:

getJavaTypeName in interface Variable

setJavaTypeName

public void setJavaTypeName(java.lang.String typeName)

*** For internal framework use only ***

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the default value of the attribute.

The default value for an attribute is expressed in terms of the Java type system, rather than the storage type system.

Specified by:

getDefaultValue in interface Variable

Returns:

the default value for the attribute, or null if none.

setDefaultValue

public void setDefaultValue(java.lang.Object val)

Specified by:

setDefaultValue in interface Variable

initDefaultValueNoConversion

public void initDefaultValueNoConversion(java.lang.String val)

*** For internal framework use only *** only for testing purposes

convertToJava

public java.lang.Object convertToJava(java.lang.Object data)

Converts a value from the database type to its corresponding Java type and returns the result.

This method uses AttributeDefImpl() metadata to convert a database value to the corresponding Java value.

Specified by:

convertToJava in interface Variable

Parameters:

data - a storage value to be converted.

Returns:

an object of the Java type defined for this attribute.

addValidator

public void addValidator(JboValidatorInterface listener)

Add a JboValidatorInterface to the listener list.

Specified by:

addValidator in interface ValidationManager

Parameters:

listener - The Validator to be added

getValidators

public java.util.ArrayList getValidators()

Get the list of JboValidatorInterface objects registered with this attribute

Specified by:

getValidators in interface ValidationManager

Returns:

ArrayList List of Validators

removeValidator

public void removeValidator(JboValidatorInterface listener)

Removes a JboValidatorInterface from the listener list.

Parameters:

listener - The Validator to be removed

initialize

@Concealed
protected void initialize(VariableImpl fromVar)

For internal use only. Application developers should not use this

initFromXML

public void initFromXML(DefElement xmlElement)

*** For internal framework use only ***

initFromXML

public void initFromXML(DefElement xmlElement,
                        boolean bDesignTime)

*** For internal framework use only ***

ensureDifferDetails

public DifferDetails ensureDifferDetails(DifferDetails difDetails)

Description copied from interface: DiffMergeable

Ensures that we have a valid DifferDetails.

This method is to create a DifferDetails object to be used for diffing if necessary. The difDetails may come in as null. By calling this method, we can ensure that a non-null difDetails is there. So, instead of writing:

    if (difDetails == null)
    {
       difDetails = new DifferDetails(..);
    }
    difDetails.addDiffDetail(..);
 

we can write

    (difDetails = diffMergeable.ensureDifferDetails(difDetails)).addDiffDetail(..);
 

Specified by:

ensureDifferDetails in interface DiffMergeable

Parameters:

difDetails - the incoming DifferDetails. It may be null.

Returns:

the same difDetails if it wasn't null coming in, or a new DifferDetails if the incoming difDetails was null

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

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

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

beginDiffObjects

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

Description copied from interface: DiffMergeable

This method is the entry point call when the diffing process begins on the document-level def. This document-level def may perform its setup or preparation operations and then traverse into nested (children) DiffMergeable's. 'this' object is the changed definition.

Specified by:

beginDiffObjects in interface DiffMergeable

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

diffObjects

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

Description copied from interface: DiffMergeable

The work-horse method performing diff between two defs of this def type. Most typically, it will call diffContents to diff scalar values and diffChildren to diff children objects. The children objects themselves are expected to be DiffMergeable. 'this' object is the changed definition.

Specified by:

diffObjects in interface DiffMergeable

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

applyDiffContents

public void applyDiffContents(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

When diff/merge operation is requested, we have the following three def objects:

orgDef - original def object (from the branch point) editDef - def object into which changes are to be merge toMergeDef - def object to be merged (source of changes) For sandbox refresh operation, orgDef comes from the branch point, editDef from the sandbox, toMergeDef from the mainline of the repos. With these three defs, we first diff editDef against orgDef, producing editDifDetails.

Similarly, toMergeDef is diffed against orgDef, producing toMergeDifDetails. The diff engine then walks through these two sets of diffs and identifies conflicts. After the conflicts are all resolved, we apply appropriate changes to editDef.

applyDiffContents is called to apply changes to scalar values. dif contains the changed values to be applied to 'this' object. Use sample code like the following:

    public void applyDiffContents(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();
       Object[] updValues;

       // DIFF_STRING_ELEMS from the above example code
       for (int j = 0; j < DIFF_STRING_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_STRING_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyStringVal1((String) updValues[0]);
                break;
             case 1:
                 setMyStringVal2((String) updValues[0]);
                break;
             }
          }
       }

       for (int j = 0; j < DIFF_INT_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_INT_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyIntVal((Integer) updValues[0]);
                break;
             }
          }
       }
    }
 

Notice that the index specified in the case statement is the array index of the attr in the String, int, or boolean array.

Specified by:

applyDiffContents in interface DiffMergeable

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation

applyDiffChildren

public void applyDiffChildren(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

Applies changes to children defs. dif contains the changes to be applied to the children. For each child def, this method should first retrieve the diff details for the child, which is of type DifferChildren. Then, it should call DifferChildren.applyDiffChanges(oracle.jbo.mom.DiffChildrenMerge, oracle.jbo.mom.DiffResolver) to perform the change operation.

applyChanges() requires a DiffChildrenMerge object, which has the insert, update, and remove methods. 'this' def object must provide implmementation of these operations.

Here is a sample:

    public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();

       if (detailMap != null)
       {
          DifferChildren difChild1 = (DifferChildren) detailMap.getValue(<XML-tag-for-Child1>);

          if (difVCs != null)
          {
             DiffChildrenMerge dm = new DiffChildrenMerge()
             {
                public void insertChild(Object id, Object value)
                {
                   .. perform insert op for Child1 ..
                }

                public void updateChild(Object id, Object value, Object oldValue)
                {
                   .. perform update op for Child1 ..
                }

                public void removeChild(Object id)
                {
                   .. perform remove op for Child1 ..
                }
             };

             difChild1.applyDiffChanges(dm, resolver);
          }

          // Similarly for Child2
       }
    }
 

Specified by:

applyDiffChildren in interface DiffMergeable

setPassivationNeeded

protected void setPassivationNeeded(boolean flag)

*** For internal framework use only ***

isPassivationNeeded

public boolean isPassivationNeeded()

The framework calls this api when building the sparse list of variables that need passivation.

Specified by:

isPassivationNeeded in interface Variable

isDefinedDefaultValue

public boolean isDefinedDefaultValue()

Passivation uses this to tell if the current value is not the definition default.

Specified by:

isDefinedDefaultValue in interface Variable

removeProperty

public void removeProperty(java.lang.String hintName,
                           LocaleContext locale)

Overrides:

removeProperty in class NamedObjectImpl

setProperty

public void setProperty(java.lang.String hintName,
                        java.lang.Object hintValue,
                        LocaleContext locale)

Overrides:

setProperty in class NamedObjectImpl

setPropertyMap

public void setPropertyMap(java.util.Map m)

Description copied from class: NamedObjectImpl

Replaces all properties.

All existing properties are lost.

Overrides:

setPropertyMap in class NamedObjectImpl

setPropertyExpression

protected void setPropertyExpression(java.lang.String name,
                                     java.lang.String expr)

Overrides:

setPropertyExpression in class NamedObjectImpl

mergePropertyMap

public void mergePropertyMap(java.util.Map m)

Overrides:

mergePropertyMap in class NamedObjectImpl

loadProperties

protected void loadProperties(DefElement xmlElement)

Parameters:

xmlElement - The XML element to load from.

loadCustomProperties

protected void loadCustomProperties(DefElement xmlElement,
                                    java.util.Map givenMap)

loadSchemaProperties

protected void loadSchemaProperties(DefElement xmlElement,
                                    java.util.Map givenMap)

getUIHelper

public AttributeHints getUIHelper()

return the AttributeHints interface implemented by this class

Specified by:

getUIHelper in interface AttributeDef

See Also:

AttributeHints

getLocaleName

public java.lang.String getLocaleName(LocaleContext locale,
                                      java.lang.String sName)

Description copied from interface: AttributeHints

function for retrieving the locale name of a hint

Specified by:

getLocaleName in interface AttributeHints

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

Specified by:

getResourceBundleDef in interface ResourceBundleOwner

Specified by:

getResourceBundleDef in interface ValidationManager

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef(java.lang.String resBundleId)

Specified by:

getResourceBundleDef in interface ValidationManager

getStructureDef

public StructureDef getStructureDef()

Specified by:

getStructureDef in interface ValidationManager

getResourcePrefix

public java.lang.String getResourcePrefix()

Specified by:

getResourcePrefix in interface ResourceBundleOwner

getCompOpers

public java.lang.String[][] getCompOpers(LocaleContext locale)

Description copied from interface: AttributeHints

Returns a Map of operators for this attribute.

Specified by:

getCompOpers in interface AttributeHints

requiresNamePrefixedResId

protected boolean requiresNamePrefixedResId()

Overrides:

requiresNamePrefixedResId in class NamedObjectImpl

getLabel

public final java.lang.String getLabel(LocaleContext locale)

Retrieves the label to be used in any attribute prompts

Specified by:

getLabel in interface GenericHints

getOperators

public java.util.Map getOperators(LocaleContext locale)

getTooltip

public final java.lang.String getTooltip(LocaleContext locale)

Retrives the tooltip text to be used for this attribute

Specified by:

getTooltip in interface GenericHints

getLabelPlural

public final java.lang.String getLabelPlural(LocaleContext locale)

Retrives the label plural text to be used for this attribute

Specified by:

getLabelPlural in interface GenericHints

getDefinitionState

public java.lang.String getDefinitionState(LocaleContext locale)

Retrives the definition state string that indicates if this object is deprecated. The two possible values are: DEFINITION_STATE_ACTIVE DEFINITION_STATE_DEPRECATED

Specified by:

getDefinitionState in interface GenericHints

getDisplayHint

public final java.lang.String getDisplayHint(LocaleContext locale)

Retrieves the displya hint that dictates whether this attributr should be visible or not. The two possible values are: ATTRIBUTE_DISPLAY_HINT_DISPLAY = "Display"; ATTRIBUTE_DISPLAY_HINT_HIDE = "Hide";

Specified by:

getDisplayHint in interface AttributeHints

getPayloadHint

public java.lang.String getPayloadHint(LocaleContext locale)

Retrieves the payload hint that dictates whether this attribute should be included in service payload or not. The possible values are:

• ATTRIBUTE_PAYLOAD_HINT_HIDE
• null

Specified by:

getPayloadHint in interface AttributeHints

getControlType

public final int getControlType(LocaleContext locale)

Returns the preferred control type for this attribute

Specified by:

getControlType in interface AttributeHints

getDisplayWidth

public final int getDisplayWidth(LocaleContext locale)

Returns the display width for this attribute

Specified by:

getDisplayWidth in interface AttributeHints

getDisplayHeight

public final int getDisplayHeight(LocaleContext locale)

Returns the display width for this attribute

Specified by:

getDisplayHeight in interface AttributeHints

isAutoSubmit

public final boolean isAutoSubmit(LocaleContext locale)

Returns the autoSubmit value for this attribute

Specified by:

isAutoSubmit in interface AttributeHints

getFieldOrder

public final double getFieldOrder(LocaleContext locale)

Returns the field order for this attribute

Specified by:

getFieldOrder in interface AttributeHints

getCategory

public final java.lang.String getCategory(LocaleContext locale)

Returns the category that this attribute belongs to

Specified by:

getCategory in interface AttributeHints

getHint

public java.lang.String getHint(LocaleContext locale,
                                java.lang.String sHintName)

Return defaulted hint value

Specified by:

getHint in interface AttributeHints

getHintValue

public java.lang.String getHintValue(LocaleContext locale,
                                     java.lang.String sHintName)

Return non-defaulted hint value

Specified by:

getHintValue in interface GenericHints

getFormat

public final java.lang.String getFormat(LocaleContext locale)

Description copied from interface: AttributeHints

returns the format string stored in the ui hints

Specified by:

getFormat in interface AttributeHints

getFormatter

public final Formatter getFormatter(LocaleContext locale)

Description copied from interface: AttributeHints

returns the formatter object stored in the ui hints

Specified by:

getFormatter in interface AttributeHints

hasFormatInformation

public final boolean hasFormatInformation(LocaleContext locale)

Description copied from interface: AttributeHints

Return true if any format hints have been defined for this attribute. This function should eb used to bracket any calls to the formatting api.

Specified by:

hasFormatInformation in interface AttributeHints

getFormattedAttribute

public final java.lang.String getFormattedAttribute(AttributeList attrList,
                                                    LocaleContext locale)

Description copied from interface: AttributeHints

Returns the formatted value for the attribute. The AttributeList parameter will usually be an instance of the oracle.jbo.Row class.

Specified by:

getFormattedAttribute in interface AttributeHints

parseFormattedAttribute

public final java.lang.Object parseFormattedAttribute(java.lang.String sValue,
                                                      LocaleContext locale)

Description copied from interface: AttributeHints

Strips off the formatting from a string and constructs an instance of the attribute's domain using the 'clean' string as a parameter of the contructor.

Specified by:

parseFormattedAttribute in interface AttributeHints

displayInShortForm

public final boolean displayInShortForm(LocaleContext locale)

Description copied from interface: AttributeHints

Returns true if the attribute is to displayed in the short(summary) form.

Specified by:

displayInShortForm in interface AttributeHints

getFormatterClassName

public final java.lang.String getFormatterClassName(LocaleContext locale)

returns the formatter object stored in the ui hints

Specified by:

getFormatterClassName in interface AttributeHints

getAttributeKind

public byte getAttributeKind()

Description copied from interface: AttributeDef

Gets the attribute value.

Specified by:

getAttributeKind in interface AttributeDef

Specified by:

getAttributeKind in interface Variable

Returns:

ATTR_VARIABLE

getAttributeStorage

public AttributeDef.AttributeStorageEnum getAttributeStorage()

Specified by:

getAttributeStorage in interface AttributeDef

getColumnName

public java.lang.String getColumnName()

Overridden to return null in Variable implementations.

Specified by:

getColumnName in interface AttributeDef

Specified by:

getColumnName in interface Variable

Returns:

the name of the column.

getColumnNameForQuery

public java.lang.String getColumnNameForQuery()

Overridden to return null in Variable implementations.

Specified by:

getColumnNameForQuery in interface AttributeDef

Specified by:

getColumnNameForQuery in interface Variable

Returns:

the column name to be used in query.

getSQLType

public int getSQLType()

Overridden to return -1;

Specified by:

getSQLType in interface AttributeDef

Specified by:

getSQLType in interface Variable

Returns:

the JDBC type.

See Also:

Types

isPrimaryKey

public boolean isPrimaryKey()

Overridden to return false;

Specified by:

isPrimaryKey in interface AttributeDef

Specified by:

isPrimaryKey in interface Variable

Returns:

true if this is either a Primary Key attribute or part of the attributes that constitute the Primary Key for a given row.

getElemSQLType

public int getElemSQLType()

Overridden to return -1.

Specified by:

getElemSQLType in interface AttributeDef

Specified by:

getElemSQLType in interface Variable

Returns:

the jdbc type (java.sql.Types.*) of this attribute's elements, or java.sql.Types.NULL if this attribute is not an array attribute.

getIndex

public int getIndex()

Overridden to return -1 for index.

Specified by:

getIndex in interface AttributeDef

Returns:

the index of the attribute row's definition object.

getColumnType

public java.lang.String getColumnType()

This method is used if the variable is of array type to get to the type name created in the database to store the array values. For example the sql should look like where ATTR.COLUMNNAME in (select column_value from table(cast(:VAR.NAME as VAR.COLUMNTYPE)))

Specified by:

getColumnType in interface Variable

Returns:

The table name created in the database to store array values

setColumnType

public void setColumnType(java.lang.String columnType)

This method is used to set the name of the table created in the database to store the array values. For example the sql should look like where ATTR.COLUMNNAME in (select column_value from table(cast(:VAR.NAME as VAR.COLUMNTYPE)))

Specified by:

setColumnType in interface Variable

Parameters:

columnType - The table name created in the database to store array values

getElemType

public java.lang.Class getElemType()

Returns the class type for the elements if this variable stores array types.

Specified by:

getElemType in interface AttributeDef

Returns:

The Class whose instances become the elements of the array

setElemType

public void setElemType(java.lang.String elementTypeName)

Sets the class type for the elements if this variable stores array types.

Parameters:

elementTypeName - The Class whose instances become the elements of the array

isDiscrColumn

public boolean isDiscrColumn()

Description copied from interface: AttributeDef

Tests if an attribute is a discriminator. Discriminating attributes are those whose values determine the (sub)type representing the entity.

Specified by:

isDiscrColumn in interface AttributeDef

Returns:

true if this is a Discriminator Column; false otherwise.

isSelected

public boolean isSelected()

Specified by:

isSelected in interface AttributeDef

isQueriable

public boolean isQueriable()

Returns true for Variables that are bound as where-clause parameters

Specified by:

isQueriable in interface AttributeDef

Returns:

true if this attribute is queriable.

getAccessorVO

public ViewObject getAccessorVO(ViewObject originVO)

Description copied from interface: AttributeDef

For an accessor attribute, this method creates a View Object that works for the View Link definition.

Specified by:

getAccessorVO in interface AttributeDef

Parameters:

originVO - the View Object that owns the accessor

Returns:

a ViewObject instance.

getStructureDef

public static final StructureDef getStructureDef(VariableManagerOwnerBase owner)

getSession

public static final Session getSession(VariableManagerOwnerBase owner)

getTransientExpression

public java.lang.String getTransientExpression()

Specified by:

getTransientExpression in interface Variable

getTransientExpressionDef

public ExpressionDef getTransientExpressionDef()

Specified by:

getTransientExpressionDef in interface Variable

setTransientExpression

public void setTransientExpression(java.lang.String expr)

Specified by:

setTransientExpression in interface Variable

setTransientExpressionDef

public void setTransientExpressionDef(ExpressionDef exprDef)

Description copied from interface: Variable

Add an expression to the variable. Use ExpressionDef.createVariableExpression(String) to create an expression.

Specified by:

setTransientExpressionDef in interface Variable

getExprEval

public ExprEval getExprEval()

evaluateTransientExpression

public java.lang.Object evaluateTransientExpression(VariableManagerOwnerBase owner)

Specified by:

evaluateTransientExpression in interface Variable

getLOVName

public java.lang.String getLOVName()

Description copied from interface: AttributeDef

Gets the name of the LOV (list of values) associated with this attribute definition.

Specified by:

getLOVName in interface AttributeDef

Specified by:

getLOVName in interface AttributeHints

Returns:

the name of the LOV (may be null)

getListBindingDef

public ListBindingDef getListBindingDef()

Specified by:

getListBindingDef in interface AttributeDef

setSerializerClassName

public void setSerializerClassName(java.lang.String className)

Description copied from interface: Variable

Sets the name of the custom value serializer class. The class must implement the ValueSerializer interface.

Specified by:

setSerializerClassName in interface Variable

Parameters:

className - name of the custom value serializer class

getSerializerClassName

public java.lang.String getSerializerClassName()

Description copied from interface: Variable

Gets the name of the custom value serializer class.

Specified by:

getSerializerClassName in interface Variable

Returns:

name of the custom value serializer class, or null if it is not defined.

getValueSerializer

public ValueSerializer getValueSerializer()

Description copied from interface: Variable

Gets an instance of the custom value serializer class.

Specified by:

getValueSerializer in interface Variable

Returns:

an instance of the custom value serializer class, or null if it is not defined.

See Also:

VariableValueManager.writeVarsToXML(Document, Element, boolean)

getXMLContentValue

public java.lang.Object getXMLContentValue(org.w3c.dom.Element varElem)

Description copied from interface: Variable

Converts an XML element to an instance of this variable's Java type.

Specified by:

getXMLContentValue in interface Variable

Parameters:

varElem - an XML element containing the serialized variable value

Returns:

a Java object representing this variable value.

See Also:

VariableValueManager.readVarsFromXML(Element)

internalGetExprVarVal

public static java.lang.Object internalGetExprVarVal(java.lang.String varName,
                                                     VariableManagerOwnerBase owner,
                                                     java.lang.Object propertyBase)

internalHasExprVarVal

public static boolean internalHasExprVarVal(java.lang.String varName,
                                            VariableManagerOwnerBase owner,
                                            java.lang.Object propertyBase)

isDirty

public boolean isDirty()

Description copied from interface: DefPersistable

This method returns if an Object is modified from last save/load

Specified by:

isDirty in interface DefPersistable

Returns:

Returns true if the Object is dirty. Returns false otherwise.

setDirty

public void setDirty(boolean b)

Description copied from interface: DefPersistable

This method marks the Object dirty

Specified by:

setDirty in interface DefPersistable

Parameters:

b - If true the Object is marked Dirty.

isNew

public boolean isNew()

Description copied from interface: DefPersistable

This method returns if this object is previously persisted.

Specified by:

isNew in interface DefPersistable

Returns:

true if the Object is previously persisted. Returns false otherwise.

setNew

public void setNew(boolean b)

Description copied from interface: DefPersistable

This method marks the as previously persisted. By default all objects are new objects. When the object is persisted first time, that object is marked as 'not new' object

Specified by:

setNew in interface DefPersistable

Parameters:

b - If true the Object is marked as new object.

isNewRecurse

public boolean isNewRecurse()

Specified by:

isNewRecurse in interface DefPersistable

setNewRecurse

public void setNewRecurse(boolean b)

Specified by:

setNewRecurse in interface DefPersistable

isSkipWrite

public boolean isSkipWrite()

Specified by:

isSkipWrite in interface DefPersistable

setSkipWrite

public void setSkipWrite(boolean b)

Specified by:

setSkipWrite in interface DefPersistable

isWriteObject

public boolean isWriteObject(DefPersistable parentObj,
                             DefWriter defWriter)

Specified by:

isWriteObject in interface DefPersistable

getOrigObject

public DefPersistable getOrigObject()

Specified by:

getOrigObject in interface DefPersistable

setOrigObject

public void setOrigObject(DefPersistable oldObj)

Specified by:

setOrigObject in interface DefPersistable

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

getDefTypeName

public java.lang.String getDefTypeName()

Description copied from interface: DiffMergeable

Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".

Specified by:

getDefTypeName in interface DiffMergeable

Returns:

XML def type name

getXMLElementTag

public java.lang.String getXMLElementTag()

Description copied from interface: PersistentDefinition

Returns a piece of static info for the type of object this is invoked upon. Examples are PreparedStatements for insert, update, delete, and String containing a base the select statement for retrieving instances of this type through the SQLInputStream

Specified by:

getXMLElementTag in interface PersistentDefinition

Returns:

returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

getIdentificationAttributeName

public java.lang.String getIdentificationAttributeName()

Description copied from interface: PersistentDefinition

return the attribute name for identification on an xml element. Note, for most def objects, the string "Name" should be returned; for someone that has no "Name" attribute, you need to designate one. e.g. For adfmcatalog.xml, "fullName" is returned For most other metadatas, "Name" is returned

Specified by:

getIdentificationAttributeName in interface PersistentDefinition

writeObject

public void writeObject(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeObject in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

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

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

Parameters:

jos - the Output storage for persistence

_getDomainContext

public java.util.Map _getDomainContext()

Specified by:

_getDomainContext in interface Variable

getOperationDefinitions

public OperationDefinitions getOperationDefinitions()

Specified by:

getOperationDefinitions in interface OperationContainer

getRowOperationDefinitions

public OperationDefinitions getRowOperationDefinitions()

Specified by:

getRowOperationDefinitions in interface OperationContainer

getScriptOperationDefinitions

public OperationDefinitions getScriptOperationDefinitions()

Specified by:

getScriptOperationDefinitions in interface OperationContainer

getScriptRowOperationDefinitions

public OperationDefinitions getScriptRowOperationDefinitions()

Specified by:

getScriptRowOperationDefinitions in interface OperationContainer

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

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

Returns:

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

lookupExprDef

public ExprDef lookupExprDef(OwnerType type,
                             java.lang.String path)

Description copied from interface: ComponentOperationsManager

Search for an ExprDef in the ComponentOperationsManager's namespace.

Specified by:

lookupExprDef in interface ComponentOperationsManager

Parameters:

type - the OwnerType of the expression

path - the ExprDef.getPath() of the expression

isDynamicCodeSourceEnabled

public boolean isDynamicCodeSourceEnabled()

Specified by:

isDynamicCodeSourceEnabled in interface ComponentOperationsManager

getDefScope

public int getDefScope()

Specified by:

getDefScope in interface ComponentOperationsManager

getDefManager

public DefinitionManager getDefManager()

Specified by:

getDefManager in interface ComponentOperationsManager

getComponentOperationsManager

public ComponentOperationsManager getComponentOperationsManager()

For internal use only. Application developers should not use this