|
Oracle ADF Model and Business Components API Reference 10.1.2 B14022-01 | ||||||||||
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
The AttributeDefHelper class implement the AttributeDef interface
RowImpl
Field Summary |
Fields inherited from class oracle.jbo.mom.DefinitionObject |
mBaseDefObject, mExtendedDefObjects, mObjectResolved |
Fields inherited from class oracle.jbo.common.NamedObjectImpl |
mFullName, mObjName, mParent, mProperties |
Fields inherited from interface oracle.jbo.AttributeDef |
ATTR_ASSOCIATED_ROW, ATTR_ASSOCIATED_ROWITERATOR, ATTR_DYNAMIC, ATTR_ENTITY_DERIVED, ATTR_PERSISTENT, ATTR_SQL_DERIVED, ATTR_TRANSIENT, READONLY, UPDATEABLE, UPDATEABLE_WHILE_NEW |
Constructor Summary | |
AttributeDefImpl(java.lang.String name,
java.lang.String type,
java.lang.String accName,
boolean editable,
int index)
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. |
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. |
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 |
getLocaleName(LocaleContext locale,
java.lang.String sName)
function for retrieving the locale name of a hint |
java.lang.String |
getName()
Gets the name of the attribute. |
int |
getPrecision()
Gets the precision of a numeric or string attribute. |
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 |
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. |
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)
|
void |
validate(AttributeList al,
java.lang.Object newValue)
|
Methods inherited from class oracle.jbo.mom.DefinitionObject |
addExtendedDefObject, finishedLoading, getBaseDefObject, getContainerDef, getContainerName, getExtendedDefObjects, hasExtendedDefObjects, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, loadProperties, resolveReferences, setBaseDefObject, setName, setObjectResolved, setParent |
Methods inherited from class oracle.jbo.common.NamedObjectImpl |
getFullName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, refreshProperty, setFullName, setPropertiesMap, setProperty |
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, refreshProperty |
Constructor Detail |
public AttributeDefImpl(java.lang.String name, java.lang.String type, java.lang.String accName, boolean editable, int index) throws java.lang.ClassNotFoundException
name
- 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.Method Detail |
public void setPrecisionScale(int prec, int scale)
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 getLabel(LocaleContext locale)
getLabel
in interface AttributeHints
public java.lang.String getTooltip(LocaleContext locale)
getTooltip
in interface AttributeHints
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 AttributeHints
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 getName()
AttributeDef
getName
in interface AttributeDef
getName
in class NamedObjectImpl
public java.lang.String getColumnName()
AttributeDef
getColumnName
in interface AttributeDef
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 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 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)
|
Oracle ADF Model and Business Components API Reference 10.1.2 B14022-01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.