|
Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client 11g Release 1 (11.1.1) E17503-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.jbo.server.NamedObjectImpl
oracle.jbo.common.VariableImpl
public class VariableImpl
Field Summary | |
---|---|
static java.lang.Class |
CLASS_INSTANCE
|
Fields inherited from class oracle.jbo.server.NamedObjectImpl |
---|
mObjName, mParent, mProperties, mUserData, RES_ID_SUFFIX |
Fields inherited from interface oracle.jbo.Variable |
---|
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.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 |
Constructor Summary | |
---|---|
VariableImpl()
|
|
VariableImpl(java.lang.String name)
|
|
VariableImpl(java.lang.String name,
java.lang.Object defaultValue,
byte updateable,
boolean notNull,
java.lang.Class javaType)
|
Method Summary | |
---|---|
java.lang.Object |
convertToJava(java.lang.Object data)
|
boolean |
displayInShortForm(LocaleContext locale)
Returns true if the attribute is to displayed in the short(summary) form. |
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. |
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[][] |
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()
|
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 element type of the attribute. |
ExprEval |
getExprEval()
|
java.lang.Object |
getExtendedData()
|
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 |
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. |
int |
getPrecision()
Gets the precision of a numeric or string attribute. |
int |
getScale()
Get the scale value of a numeric attribute. |
int |
getSQLType()
Overridden to return -1; |
StructureDef |
getStructureDef(VariableManagerOwnerBase owner)
|
java.lang.String |
getTooltip(LocaleContext locale)
Retrives the tooltip text to be used for this attribute |
java.lang.String |
getTransientExpression()
|
AttributeHints |
getUIHelper()
Returns the user interface hints interface for retrieving hint * information such as labels, prompts,... |
byte |
getUpdateableFlag()
Tests if an attribute can be modified. |
java.lang.String |
getVariableKind()
|
VariableManager |
getVariableManager()
|
boolean |
hasFormatInformation(LocaleContext locale)
Return true if any format hints have been defined for this attribute. |
boolean |
isDefinedDefaultValue()
Passivation uses this to tell if the current value is the meta-data default. |
boolean |
isDefValExpression()
Is the default value an expression? |
boolean |
isDirty()
|
boolean |
isDiscrColumn()
Tests if an attribute is a discriminator. |
boolean |
isMandatory()
Tests if an attribute does not allow null values. |
boolean |
isPassivationNeeded()
Tells the framework whether or not to include this definition in the passivation snapshot that is about to occur. |
boolean |
isPrimaryKey()
Overridden to return false; |
boolean |
isQueriable()
Tests if an attribute is queriable. |
boolean |
isSelected()
Tests if an attribute is transient. |
static VariableImpl |
loadFromXml(org.kxml2.io.KXmlParser parser)
Load a Variable definition from a chunk of XML |
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 |
setDefaultValue(java.lang.Object val)
|
void |
setDirty(boolean b)
|
void |
setExtendedData(java.lang.Object data)
|
void |
setJavaType(java.lang.Class cls)
|
void |
setMandatory(boolean b)
|
void |
setName(java.lang.String name)
Name this object. |
void |
setPrecisionScale(int prec,
int sc)
|
void |
setTransientExpression(java.lang.String expr)
|
void |
setUpdateableFlag(byte updateable)
|
void |
setVariableKind(java.lang.String k)
|
void |
setVariableManager(VariableManager manager)
|
Methods inherited from class java.lang.Object |
---|
equals, 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 |
Field Detail |
---|
public static final java.lang.Class CLASS_INSTANCE
Constructor Detail |
---|
public VariableImpl()
public VariableImpl(java.lang.String name)
public VariableImpl(java.lang.String name, java.lang.Object defaultValue, byte updateable, boolean notNull, java.lang.Class javaType)
Method Detail |
---|
public java.lang.Object convertToJava(java.lang.Object data)
convertToJava
in interface Variable
public byte getAttributeKind()
AttributeDef
getAttributeKind
in interface AttributeDef
getAttributeKind
in interface Variable
public java.lang.String getColumnName()
Variable
getColumnName
in interface AttributeDef
getColumnName
in interface Variable
public java.lang.String getColumnNameForQuery()
Variable
getColumnNameForQuery
in interface AttributeDef
getColumnNameForQuery
in interface Variable
public java.lang.Object getDefaultValue()
getDefaultValue
in interface Variable
public int getElemSQLType()
Variable
getElemSQLType
in interface AttributeDef
getElemSQLType
in interface Variable
public java.lang.Object getExtendedData()
getExtendedData
in interface Variable
public java.lang.String getJavaTypeName()
getJavaTypeName
in interface Variable
public int getSQLType()
Variable
getSQLType
in interface AttributeDef
getSQLType
in interface Variable
java.sql.Types
public java.lang.String getVariableKind()
getVariableKind
in interface Variable
public VariableManager getVariableManager()
getVariableManager
in interface Variable
public boolean isDefinedDefaultValue()
Variable
isDefinedDefaultValue
in interface Variable
public boolean isPassivationNeeded()
Variable
isPassivationNeeded
in interface Variable
public boolean isPrimaryKey()
Variable
isPrimaryKey
in interface AttributeDef
isPrimaryKey
in interface Variable
true
if this is either a Primary Key attribute or part of the
attributes that constitute the Primary Key for a given row.public void setDefaultValue(java.lang.Object val)
setDefaultValue
in interface Variable
public void setExtendedData(java.lang.Object data)
setExtendedData
in interface Variable
public void setJavaType(java.lang.Class cls)
setJavaType
in interface Variable
public void setMandatory(boolean b)
setMandatory
in interface Variable
public void setPrecisionScale(int prec, int sc)
setPrecisionScale
in interface Variable
public void setUpdateableFlag(byte updateable)
setUpdateableFlag
in interface Variable
public void setVariableKind(java.lang.String k)
setVariableKind
in interface Variable
public void setVariableManager(VariableManager manager)
setVariableManager
in interface Variable
public java.lang.Class getElemType()
AttributeDef
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 getIndex()
AttributeDef
StoreInfo
instance.
getIndex
in interface AttributeDef
public java.lang.Class getJavaType()
AttributeDef
getJavaType
in interface AttributeDef
public int getPrecision()
AttributeDef
'Precision' for a string is the maximum length.
getPrecision
in interface AttributeDef
public int getScale()
AttributeDef
getScale
in interface AttributeDef
public AttributeHints getUIHelper()
AttributeDef
getUIHelper
in interface AttributeDef
AttributeHints
public byte getUpdateableFlag()
AttributeDef
getUpdateableFlag
in interface AttributeDef
READONLY
, UPDATEABLE
, or
UPDATEABLE_WHILE_NEW
.public boolean isMandatory()
AttributeDef
isMandatory
in interface AttributeDef
true
if this attribute cannot store a null valuepublic 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 boolean isSelected()
AttributeDef
isSelected
in interface AttributeDef
true
if this attribute is transient.public void setName(java.lang.String name)
NamedObjectImpl
setName
in interface Variable
setName
in class NamedObjectImpl
name
- the name to be given to this object.public static final VariableImpl loadFromXml(org.kxml2.io.KXmlParser parser)
parser
- A KXmlParser object positioned at the start of a public boolean isDefValExpression()
public ViewObject getAccessorVO(ViewObject originVO)
AttributeDef
getAccessorVO
in interface AttributeDef
originVO
- the View Object that owns the accessor
ViewObject
instance.public boolean isDiscrColumn()
AttributeDef
isDiscrColumn
in interface AttributeDef
public void setTransientExpression(java.lang.String expr)
setTransientExpression
in interface Variable
public final java.lang.String getFormat(LocaleContext locale)
AttributeHints
getFormat
in interface AttributeHints
public final Formatter getFormatter(LocaleContext locale)
AttributeHints
getFormatter
in interface AttributeHints
public final java.lang.String getFormatterClassName(LocaleContext locale)
getFormatterClassName
in interface AttributeHints
public final boolean hasFormatInformation(LocaleContext locale)
AttributeHints
hasFormatInformation
in interface AttributeHints
public final java.lang.Object parseFormattedAttribute(java.lang.String sValue, LocaleContext locale)
AttributeHints
parseFormattedAttribute
in interface AttributeHints
public ExprEval getExprEval()
public final boolean displayInShortForm(LocaleContext locale)
AttributeHints
displayInShortForm
in interface AttributeHints
public java.lang.String[][] getCompOpers(LocaleContext locale)
AttributeHints
getCompOpers
in interface AttributeHints
public final int getControlType(LocaleContext locale)
getControlType
in interface AttributeHints
public final int getDisplayHeight(LocaleContext locale)
getDisplayHeight
in interface AttributeHints
public final java.lang.String getDisplayHint(LocaleContext locale)
getDisplayHint
in interface AttributeHints
public final int getDisplayWidth(LocaleContext locale)
getDisplayWidth
in interface AttributeHints
public final java.lang.String getFormattedAttribute(AttributeList attrList, LocaleContext locale)
AttributeHints
getFormattedAttribute
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 final java.lang.String getLabel(LocaleContext locale)
getLabel
in interface AttributeHints
public java.lang.String getLocaleName(LocaleContext locale, java.lang.String sName)
AttributeHints
getLocaleName
in interface AttributeHints
public final java.lang.String getTooltip(LocaleContext locale)
getTooltip
in interface AttributeHints
public java.lang.String getLOVName()
AttributeDef
getLOVName
in interface AttributeDef
public ListBindingDef getListBindingDef()
getListBindingDef
in interface AttributeDef
public java.lang.Object evaluateTransientExpression(VariableManagerOwnerBase owner)
evaluateTransientExpression
in interface Variable
public java.lang.String getTransientExpression()
getTransientExpression
in interface Variable
public StructureDef getStructureDef(VariableManagerOwnerBase owner)
public boolean isDirty()
public void setDirty(boolean b)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client 11g Release 1 (11.1.1) E17503-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |