oracle.jbo.client.remote

Class AttributeDefImpl

java.lang.Object

oracle.jbo.common.PropertiesHelper

oracle.jbo.common.AttributeDefHelper

oracle.jbo.client.remote.AttributeDefImpl

All Implemented Interfaces:

java.io.Serializable, AttributeDef, AttributeHints, ExprWrappable, GenericHints, Properties

public class AttributeDefImpl
extends AttributeDefHelper
implements AttributeHints

The AttributeDefHelper class implement the AttributeDef interface

See Also:

RowImpl, Serialized Form

Nested Class Summary

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

AttributeHints.ControlType

Field Summary

Fields inherited from class oracle.jbo.common.AttributeDefHelper

HISTORY_TYPE_RESERVED_IDS

Fields inherited from class oracle.jbo.common.PropertiesHelper

mProperties

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_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, 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_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	displayInShortForm(LocaleContext locale) Returns true if the attribute is to displayed in the short(summary) form.
ViewObject	getAccessorVO(ViewObject originVO) For an accessor attribute, this method creates a View Object that works for the View Link definition.
java.lang.String	getCategory(LocaleContext locale) Returns the category that this attribute belongs to
java.util.ArrayList	getCompOpers()
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.String	getDefinitionState(LocaleContext locale) Retrives the definition state string that indicates if this object is deprecated.
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
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	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.util.Map	getOperators(LocaleContext locale)
java.lang.String	getPayloadHint(LocaleContext locale) Retrieves the payload hint that dictates whether this attribute should be included in service payload or not.
java.util.Hashtable	getProperties() Returns all Properties
java.lang.Object	getProperty(java.lang.String hintName) Retrieves the specified property, if it exists.
java.lang.Object	getProperty(java.lang.String hintName, LocaleContext locale)
java.lang.String	getTooltip(LocaleContext locale) Retrives the tooltip text to be used for this attribute
AttributeHints	getUIHelper() return the AttributeHints interface implemented by this class
boolean	hasFormatInformation(LocaleContext locale) Return true if any format hints have been defined for this attribute.
boolean	isAutoSubmit(LocaleContext locale) Returns the autoSubmit value for this attribute
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	setProperty(java.lang.String hintName, java.lang.Object hintValue)

Methods inherited from class oracle.jbo.common.AttributeDefHelper

convertUpdateableFlagToString, convertUpdateableStringToFlag, getAttributeKind, getColumnName, getColumnNameForQuery, getElemSQLType, getElemType, getIndex, getJavaType, getJavaTypeName, getLOVName, getName, getPrecision, getScale, getSQLType, getTypeGroup, getUpdateableFlag, isDiscrColumn, isFromReference, isMandatory, isPrimaryKey, isQueriable, isSelected, parseFormattedAttribute, setName

Methods inherited from class oracle.jbo.common.PropertiesHelper

closeObject, getImageLoc, isReadOnly, refreshProperties, refreshProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.AttributeHints

getLOVName

Methods inherited from interface oracle.jbo.Properties

refreshProperty

Method Detail

getProperties

public java.util.Hashtable getProperties()

Returns all Properties

Specified by:

getProperties in interface Properties

Overrides:

getProperties in class PropertiesHelper

Returns:

a hashtable of properties.

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

getCompOpers

public java.util.ArrayList getCompOpers()

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

getProperty

public java.lang.Object getProperty(java.lang.String hintName,
                           LocaleContext locale)

Specified by:

getProperty in interface Properties

Overrides:

getProperty in class PropertiesHelper

getProperty

public java.lang.Object getProperty(java.lang.String hintName)

Description copied from interface: Properties

Retrieves the specified property, if it exists.

Specified by:

getProperty in interface Properties

Overrides:

getProperty in class PropertiesHelper

Parameters:

hintName - Property name.

Returns:

the value of the property, if any, otherwise null.

setProperty

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

Overrides:

setProperty in class PropertiesHelper

getLabel

public 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 java.lang.String getTooltip(LocaleContext locale)

Retrives the tooltip text to be used for this attribute

Specified by:

getTooltip in interface GenericHints

getLabelPlural

public 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 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 int getControlType(LocaleContext locale)

Returns the preferred control type for this attribute

Specified by:

getControlType in interface AttributeHints

getDisplayWidth

public int getDisplayWidth(LocaleContext locale)

Returns the display width for this attribute

Specified by:

getDisplayWidth in interface AttributeHints

getDisplayHeight

public int getDisplayHeight(LocaleContext locale)

Returns the display width for this attribute

Specified by:

getDisplayHeight in interface AttributeHints

isAutoSubmit

public boolean isAutoSubmit(LocaleContext locale)

Returns the autoSubmit value for this attribute

Specified by:

isAutoSubmit in interface AttributeHints

getFieldOrder

public double getFieldOrder(LocaleContext locale)

Returns the field order for this attribute

Specified by:

getFieldOrder in interface AttributeHints

getCategory

public 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 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 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 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 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 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 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 java.lang.String getFormatterClassName(LocaleContext locale)

returns the formatter object stored in the ui hints

Specified by:

getFormatterClassName in interface AttributeHints

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

Overrides:

getAccessorVO in class AttributeDefHelper

Parameters:

originVO - the View Object that owns the accessor

Returns:

a ViewObject instance.

getListBindingDef

public ListBindingDef getListBindingDef()

Specified by:

getListBindingDef in interface AttributeDef