|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.5.0) E10653-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.jbo.common.NamedObjectImpl
oracle.jbo.mom.DefinitionObject
oracle.adf.model.generic.AttributeDefImpl
public class AttributeDefImpl
The AttributeDefHelper class implement the AttributeDef interface
RowImpl
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface oracle.jbo.AttributeHints |
---|
AttributeHints.ControlType |
Field Summary |
---|
Fields inherited from class oracle.jbo.mom.DefinitionObject |
---|
DEF_MDS_CLIENT_KEY, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAP |
Fields inherited from class oracle.jbo.common.NamedObjectImpl |
---|
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX |
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.GenericHints |
---|
PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP |
Constructor Summary | |
---|---|
AttributeDefImpl(java.lang.String nm, java.lang.String type, java.lang.String accName, boolean editable, int index) Deprecated. since 10.1.2. Use a constructor variant that takes StructureDefImpl. |
|
AttributeDefImpl(StructureDefImpl def, java.lang.String nm, java.lang.String cnm, int idx, java.lang.String typ, java.lang.String cnmType, byte upd, boolean pk, boolean reqd, java.lang.String elemClzName) Construct a new instance. |
Method Summary | |
---|---|
void |
addValidator(JboValidatorInterface intf) |
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. |
byte |
getAttributeKind() Gets the attribute value. |
java.lang.String |
getColumnName() Gets the name of the database column the attribute represents. |
java.lang.String |
getColumnNameForQuery() Gets the column name to be used in query statement. |
java.lang.Class |
getColumnType() |
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 |
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() Returns the jdbc type of the elements of this attribute. |
java.lang.Class |
getElemType() Returns the element type of the 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 |
int |
getIndex() Gets the index of the attribute in the context of a StoreInfo instance. |
java.lang.Class |
getJavaType() Gets the Java class of the object stored for this attribute definition. |
java.lang.String |
getJavaTypeName() |
java.lang.String |
getLabel(LocaleContext locale) Retrieves the label to be used in any attribute prompts |
java.lang.String |
getLabelPlural(LocaleContext locale) Retrieves the label plural to be used in any attribute prompts |
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 |
getName() Get the name of this object. |
java.util.Map |
getOperators(LocaleContext locale) |
int |
getPrecision() Gets the precision of a numeric or string attribute. |
ResourceBundleDef |
getResourceBundleDef() |
java.lang.String |
getResourcePrefix() |
int |
getScale() Get the scale value of a numeric attribute. |
int |
getSQLType() Gets the JDBC type of the attribute. |
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 |
byte |
getUpdateableFlag() Tests if an attribute can be modified. |
java.util.ArrayList |
getValidators() |
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 |
boolean |
isDiscrColumn() Tests if an attribute is a discriminator. |
boolean |
isMandatory() Return true if this attribute does not allow null values. |
boolean |
isPrimaryKey() Tests if an attribute is a Primary Key. |
boolean |
isQueriable() Tests if an attribute is queriable. |
boolean |
isSelected() |
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 |
setPrecisionScale(int prec, int scale) Use setPrecisionScale(int, int, boolean) to indicate if this def should imply applying precision validation as well. |
void |
setPrecisionScale(int prec, int scale, boolean applyValidation) |
void |
validate(AttributeList al, java.lang.Object newValue) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.jbo.Properties |
---|
getProperties, getProperty, getProperty, refreshProperty |
Methods inherited from interface oracle.jbo.rules.ValidationManager |
---|
getFullName |
Constructor Detail |
---|
public AttributeDefImpl(java.lang.String nm, java.lang.String type, java.lang.String accName, boolean editable, int index)
nm
- The AttributeDefImpl instance name. Must be unique for for the parent StructureDefImpl instance.type
- The type of the value that is returned by this AttributeDefImpl instance.accName
- The name that should be used to acquire the AttributeDefImpl value from the owning StructureDefImpl. If The owning StructureDefImpl instance is dynamic then this should be a map key. If the owning StructureDefImpl instance references a a JavaBean then this should be a JavaBean property name.editable
- a boolean indicating if the AttributeDefImpl value is editable.index
- The index of the AttributeDefImpl instance in its owning StructureDefImpl instance.public AttributeDefImpl(StructureDefImpl def, java.lang.String nm, java.lang.String cnm, int idx, java.lang.String typ, java.lang.String cnmType, byte upd, boolean pk, boolean reqd, java.lang.String elemClzName)
def
- instance to which this attribute definition belongs.nm
- The AttributeDefImpl instance name. Must be unique for for the parent StructureDefImpl instance.cnm
- Name of the source to which this attribute is mapped to in the source data objects for this definitionidx
- Index of this attribute within the structure definition.typ
- The type of the value that is returned by this AttributeDefImpl instance.cnmType
- The type of the value that the source data objects provide for this attribute.upd
- One of the three udpateable flags in AttributeDef.pk
- Whether this attribute should be a primarykey participantreqd
- Whether this attribute requires a non-null value.elemClzName
- Name of the class to which the objects in this attribute belongs if this attribute represents a collection type attribute (e.g., Array domain)Method Detail |
---|
public void setPrecisionScale(int prec, int scale)
public void setPrecisionScale(int prec, int scale, boolean applyValidation)
public AttributeHints getUIHelper()
getUIHelper
in interface AttributeDef
AttributeHints
public java.lang.String getLocaleName(LocaleContext locale, java.lang.String sName)
AttributeHints
getLocaleName
in interface AttributeHints
public java.lang.String[][] getCompOpers(LocaleContext locale)
AttributeHints
getCompOpers
in interface AttributeHints
public java.lang.String getLabel(LocaleContext locale)
getLabel
in interface GenericHints
public java.lang.String getLabelPlural(LocaleContext locale)
getLabelPlural
in interface GenericHints
public java.util.Map getOperators(LocaleContext locale)
public java.lang.String getTooltip(LocaleContext locale)
getTooltip
in interface GenericHints
public java.lang.String getDisplayHint(LocaleContext locale)
getDisplayHint
in interface AttributeHints
public int getControlType(LocaleContext locale)
getControlType
in interface AttributeHints
public int getDisplayWidth(LocaleContext locale)
getDisplayWidth
in interface AttributeHints
public int getDisplayHeight(LocaleContext locale)
getDisplayHeight
in interface AttributeHints
public java.lang.String getHint(LocaleContext locale, java.lang.String sHintName)
getHint
in interface AttributeHints
public java.lang.String getHintValue(LocaleContext locale, java.lang.String sHintName)
getHintValue
in interface GenericHints
public java.lang.String getFormat(LocaleContext locale)
AttributeHints
getFormat
in interface AttributeHints
public Formatter getFormatter(LocaleContext locale)
AttributeHints
getFormatter
in interface AttributeHints
public boolean hasFormatInformation(LocaleContext locale)
AttributeHints
hasFormatInformation
in interface AttributeHints
public java.lang.String getFormattedAttribute(AttributeList attrList, LocaleContext locale)
AttributeHints
getFormattedAttribute
in interface AttributeHints
public java.lang.Object parseFormattedAttribute(java.lang.String sValue, LocaleContext locale)
AttributeHints
parseFormattedAttribute
in interface AttributeHints
public boolean displayInShortForm(LocaleContext locale)
AttributeHints
displayInShortForm
in interface AttributeHints
public java.lang.String getFormatterClassName(LocaleContext locale)
getFormatterClassName
in interface AttributeHints
public boolean isAutoSubmit(LocaleContext locale)
isAutoSubmit
in interface AttributeHints
public java.lang.String getName()
NamedObjectImpl
getName
in interface AttributeDef
getName
in interface ValidationManager
getName
in class NamedObjectImpl
public java.lang.String getColumnName()
AttributeDef
getColumnName
in interface AttributeDef
public java.lang.Class getColumnType()
public java.lang.String getColumnNameForQuery()
AttributeDef
getColumnNameForQuery
in interface AttributeDef
public int getIndex()
AttributeDef
StoreInfo
instance.getIndex
in interface AttributeDef
public java.lang.Class getJavaType()
AttributeDef
getJavaType
in interface AttributeDef
public java.lang.String getJavaTypeName()
public int getSQLType()
AttributeDef
getSQLType
in interface AttributeDef
Types
public byte getAttributeKind()
AttributeDef
getAttributeKind
in interface AttributeDef
ATTR
constants defined for this class.public boolean isDiscrColumn()
AttributeDef
isDiscrColumn
in interface AttributeDef
public boolean isSelected()
isSelected
in interface AttributeDef
public boolean isQueriable()
AttributeDef
Queriable attributes are those that may have a filter condition for the WHERE clause If this method returns false, the attribute will not be used in constructing the WHERE clause of SQL statements to fetch data.
isQueriable
in interface AttributeDef
true
if this attribute is queriable.public byte getUpdateableFlag()
AttributeDef
getUpdateableFlag
in interface AttributeDef
READONLY
, UPDATEABLE
, or UPDATEABLE_WHILE_NEW
.public boolean isPrimaryKey()
AttributeDef
isPrimaryKey
in interface AttributeDef
true
if this is either a Primary Key attribute or part of the attributes that constitute the Primary Key for a given row.public boolean isMandatory()
isMandatory
in interface AttributeDef
true
if this attribute cannot store a null valuepublic int getPrecision()
AttributeDef
'Precision' for a string is the maximum length.
getPrecision
in interface AttributeDef
public int getScale()
AttributeDef
getScale
in interface AttributeDef
public java.lang.Class getElemType()
For VARRAYs, this method returns the class name of the elements that are in the VARRAY.
Element type is relevant only if the attribute is an array attribute.
getElemType
in interface AttributeDef
public int getElemSQLType()
For VARRAYs, this method returns the jdbc type of the elements that are in the VARRAY.
Element type is relevant only if the attribute is an array attribute.
getElemSQLType
in interface AttributeDef
public ViewObject getAccessorVO(ViewObject originVO)
AttributeDef
getAccessorVO
in interface AttributeDef
originVO
- the View Object that owns the accessorViewObject
instance.public void addValidator(JboValidatorInterface intf)
addValidator
in interface ValidationManager
public java.util.ArrayList getValidators()
getValidators
in interface ValidationManager
public void validate(AttributeList al, java.lang.Object newValue)
public java.lang.String getLOVName()
AttributeDef
getLOVName
in interface AttributeDef
public ListBindingDef getListBindingDef()
getListBindingDef
in interface AttributeDef
public ResourceBundleDef getResourceBundleDef()
getResourceBundleDef
in interface ResourceBundleOwner
getResourceBundleDef
in interface ValidationManager
public java.lang.String getResourcePrefix()
getResourcePrefix
in interface ResourceBundleOwner
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.5.0) E10653-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |