|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.jbo.domain.DomainAttributeDef
public class DomainAttributeDef
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface oracle.jbo.AttributeHints |
---|
AttributeHints.ControlType |
Field Summary |
---|
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 | |
---|---|
DomainAttributeDef(java.lang.String name,
java.lang.String columnName,
int index,
java.lang.Class javaType,
int sqlType,
java.lang.String sqlTypeName,
int scale,
int precision,
boolean isMandatory)
|
|
DomainAttributeDef(java.lang.String name,
java.lang.String columnName,
int index,
java.lang.Class javaType,
int sqlType,
java.lang.String sqlTypeName,
int scale,
int precision,
boolean isMandatory,
java.lang.String entityDefName)
|
Method Summary | |
---|---|
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 kind. |
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.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()
Return -1; |
java.lang.Class |
getElemType()
Return null; |
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 |
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 |
getName()
Gets the name of the attribute. |
java.util.Map |
getOperators(LocaleContext locale)
|
int |
getPrecision()
Gets the precision of a numeric or string attribute. |
java.util.Hashtable |
getProperties()
Gets the table of 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 |
getReferencedObjectDefName()
|
int |
getScale()
Get the scale value of a numeric attribute. |
int |
getSQLType()
Gets the JDBC type of the attribute. |
java.lang.String |
getSQLTypeName()
|
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. |
static Node |
getXMLContentNode(Document xmlDoc,
java.lang.Object attrValue,
boolean isCData)
Deprecated. since 9.0.2 use the other getXMLContentNode() . |
static Node |
getXMLContentNode(Document xmlDoc,
java.lang.Object attrValue,
boolean isCData,
boolean serialize)
|
static Node |
getXMLContentNode(Document xmlDoc,
java.lang.Object attrValue,
boolean isCData,
boolean serialize,
ValueSerializer serializer)
|
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()
Tests if an 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. |
static java.lang.String |
printAttrXMLDefinition(AttributeList row,
java.lang.String attrTag,
AttributeDef ad,
java.util.Hashtable allDefs,
java.io.PrintWriter pw,
boolean bContainees)
|
java.lang.Object |
refreshProperty(java.lang.String hintName)
Retrieves the specified property, if it exists. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DomainAttributeDef(java.lang.String name, java.lang.String columnName, int index, java.lang.Class javaType, int sqlType, java.lang.String sqlTypeName, int scale, int precision, boolean isMandatory)
public DomainAttributeDef(java.lang.String name, java.lang.String columnName, int index, java.lang.Class javaType, int sqlType, java.lang.String sqlTypeName, int scale, int precision, boolean isMandatory, java.lang.String entityDefName)
Method Detail |
---|
public byte getAttributeKind()
getAttributeKind
in interface AttributeDef
ATTR
constants defined for this class.public java.lang.String getName()
getName
in interface AttributeDef
public java.lang.String getColumnName()
getColumnName
in interface AttributeDef
public java.lang.String getColumnNameForQuery()
AttributeDef
getColumnNameForQuery
in interface AttributeDef
public int getIndex()
StoreInfo
instance.
getIndex
in interface AttributeDef
public java.lang.String getSQLTypeName()
public java.lang.Class getJavaType()
getJavaType
in interface AttributeDef
public int getSQLType()
getSQLType
in interface AttributeDef
Types
public int getScale()
getScale
in interface AttributeDef
public int getPrecision()
'Precision' for a string is the maximum length.
getPrecision
in interface AttributeDef
public boolean isDiscrColumn()
AttributeDef
isDiscrColumn
in interface AttributeDef
public boolean isSelected()
isSelected
in interface AttributeDef
public boolean isQueriable()
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()
getUpdateableFlag
in interface AttributeDef
READONLY
, UPDATEABLE
, or UPDATEABLE_WHILE_NEW
.public boolean isPrimaryKey()
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 java.lang.Object getProperty(java.lang.String hintName)
getProperty
in interface Properties
hintName
- Property name.
public java.lang.Object getProperty(java.lang.String hintName, LocaleContext locale)
getProperty
in interface Properties
public java.lang.Object refreshProperty(java.lang.String hintName)
Properties
getProperty
.
refreshProperty
in interface Properties
hintName
- Property name.
null
.public java.lang.String getReferencedObjectDefName()
public java.util.Hashtable getProperties()
getProperties
in interface Properties
public static Node getXMLContentNode(Document xmlDoc, java.lang.Object attrValue, boolean isCData)
public static Node getXMLContentNode(Document xmlDoc, java.lang.Object attrValue, boolean isCData, boolean serialize)
public static Node getXMLContentNode(Document xmlDoc, java.lang.Object attrValue, boolean isCData, boolean serialize, ValueSerializer serializer)
public static java.lang.String printAttrXMLDefinition(AttributeList row, java.lang.String attrTag, AttributeDef ad, java.util.Hashtable allDefs, java.io.PrintWriter pw, boolean bContainees)
public java.lang.Class getElemType()
getElemType
in interface AttributeDef
public int getElemSQLType()
getElemSQLType
in interface AttributeDef
public ViewObject getAccessorVO(ViewObject originVO)
AttributeDef
getAccessorVO
in interface AttributeDef
originVO
- the View Object that owns the accessor
ViewObject
instance.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.util.Map getOperators(LocaleContext locale)
public java.lang.String getTooltip(LocaleContext locale)
getTooltip
in interface GenericHints
public java.lang.String getLabelPlural(LocaleContext locale)
getLabelPlural
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 boolean isAutoSubmit(LocaleContext locale)
isAutoSubmit
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 java.lang.String getLOVName()
AttributeDef
getLOVName
in interface AttributeDef
public ListBindingDef getListBindingDef()
getListBindingDef
in interface AttributeDef
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |