Skip navigation links

oracle.jbo
Interface Variable

All Superinterfaces:

AttributeDef, ExprWrappable, Properties

All Known Implementing Classes:

DCVariableImpl, VariableImpl

public interface Variable

extends AttributeDef

Defines a named variable. Variable extends AttributeDef so that various AttributeDef support including validation, properties and bindings are made available to Variable too. However there is no support or inclusion of Variable in StructureDef apis.

Since:

JDeveloper 10.1.3

Field Summary

static java.lang.String	VAR_KIND_VIEW_CRITERIA_PARAM
static java.lang.String	VAR_KIND_WHERE_CLAUSE_PARAM
static java.lang.String	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

Method Summary

java.util.Map	_getDomainContext()
java.lang.Object	clone()
java.lang.Object	convertToJava(java.lang.Object data)
java.lang.Object	evaluateTransientExpression(VariableManagerOwnerBase owner)
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	getColumnType() This method is used if the variable is of array type to get to the type name created in the database to store the array values.
java.lang.Object	getDefaultValue()
int	getElemSQLType() Overridden to return -1;
java.lang.Object	getExtendedData()
java.lang.String	getJavaTypeName()
java.lang.String	getSerializerClassName() Gets the name of the custom value serializer class.
int	getSQLType() Overridden to return -1;
java.lang.String	getTransientExpression()
ValueSerializer	getValueSerializer() Gets an instance of the custom value serializer class.
java.lang.String	getVariableKind()
VariableManager	getVariableManager()
java.lang.Object	getXMLContentValue(Element varElem) Converts an XML element to an instance of this variable's Java type.
boolean	isDefinedDefaultValue() Passivation uses this to tell if the current value is the meta-data default.
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;
void	setColumnType(java.lang.String columnType) This method is used to set the name of the table created in the database to store the array values.
void	setDefaultValue(java.lang.Object val)
void	setExtendedData(java.lang.Object data)
void	setJavaType(java.lang.Class cls)
void	setMandatory(boolean b)
void	setName(java.lang.String name)
void	setPrecisionScale(int prec, int scale)
void	setSerializerClassName(java.lang.String className) Sets the name of the custom value serializer class.
void	setTransientExpression(java.lang.String expr)
void	setUpdateableFlag(byte updateable)
void	setVariableKind(java.lang.String kind)
void	setVariableManager(VariableManager manager)

Methods inherited from interface oracle.jbo.AttributeDef

getAccessorVO, getElemType, getIndex, getJavaType, getListBindingDef, getLOVName, getName, getPrecision, getScale, getUIHelper, getUpdateableFlag, isDiscrColumn, isMandatory, isQueriable, isSelected

Methods inherited from interface oracle.jbo.Properties

getProperties, getProperty, getProperty, refreshProperty

Field Detail

VAR_KIND_WHERE_CLAUSE_PARAM

static final java.lang.String VAR_KIND_WHERE_CLAUSE_PARAM

See Also:

Constant Field Values

VAR_KIND_VIEW_CRITERIA_PARAM

static final java.lang.String VAR_KIND_VIEW_CRITERIA_PARAM

See Also:

Constant Field Values

VAR_KIND_WHERE_OR_CRIT_PARAM

static final java.lang.String VAR_KIND_WHERE_OR_CRIT_PARAM

See Also:

Constant Field Values

Method Detail

clone

java.lang.Object clone()

setName

void setName(java.lang.String name)

getVariableManager

VariableManager getVariableManager()

setVariableManager

void setVariableManager(VariableManager manager)

getJavaTypeName

java.lang.String getJavaTypeName()

getVariableKind

java.lang.String getVariableKind()

setVariableKind

void setVariableKind(java.lang.String kind)

getExtendedData

java.lang.Object getExtendedData()

setExtendedData

void setExtendedData(java.lang.Object data)

getDefaultValue

java.lang.Object getDefaultValue()

setDefaultValue

void setDefaultValue(java.lang.Object val)

setPrecisionScale

void setPrecisionScale(int prec,
                       int scale)

setUpdateableFlag

void setUpdateableFlag(byte updateable)

setMandatory

void setMandatory(boolean b)

setJavaType

void setJavaType(java.lang.Class cls)

convertToJava

java.lang.Object convertToJava(java.lang.Object data)

getAttributeKind

byte getAttributeKind()

Description copied from interface: AttributeDef

Gets the attribute value.

Specified by:

getAttributeKind in interface AttributeDef

Returns:

ATTR_VARIABLE

getColumnName

java.lang.String getColumnName()

Overridden to return null in Variable implementations.

Specified by:

getColumnName in interface AttributeDef

Returns:

the name of the column.

getColumnType

java.lang.String getColumnType()

This method is used if the variable is of array type to get to the type name created in the database to store the array values. For example the sql should look like where ATTR.COLUMNNAME in (select column_value from table(cast(:VAR.NAME as VAR.COLUMNTYPE)))

Returns:

The table name created in the database to store array values

setColumnType

void setColumnType(java.lang.String columnType)

This method is used to set the name of the table created in the database to store the array values. For example the sql should look like where ATTR.COLUMNNAME in (select column_value from table(cast(:VAR.NAME as VAR.COLUMNTYPE)))

Parameters:

columnType - The table name created in the database to store array values

getColumnNameForQuery

java.lang.String getColumnNameForQuery()

Overridden to return null in Variable implementations.

Specified by:

getColumnNameForQuery in interface AttributeDef

Returns:

the column name to be used in query.

getSQLType

int getSQLType()

Overridden to return -1;

Specified by:

getSQLType in interface AttributeDef

Returns:

the JDBC type.

See Also:

Types

isPrimaryKey

boolean isPrimaryKey()

Overridden to return false;

Specified by:

isPrimaryKey in interface AttributeDef

Returns:

true if this is either a Primary Key attribute or part of the attributes that constitute the Primary Key for a given row.

getElemSQLType

int getElemSQLType()

Overridden to return -1;

Specified by:

getElemSQLType in interface AttributeDef

Returns:

the jdbc type (java.sql.Types.*) of this attribute's elements, or java.sql.Types.NULL if this attribute is not an array attribute.

isPassivationNeeded

boolean isPassivationNeeded()

Tells the framework whether or not to include this definition in the passivation snapshot that is about to occur. Each snapshot only includes objects that couldn't be recreated from their meta-data. Each variable has the concept of whether or not it is currently "dirty". i.e. The definition of the variable has somehow changed since it was last loaded from it's meta-data definition, or it was created dynamically.

isDefinedDefaultValue

boolean isDefinedDefaultValue()

Passivation uses this to tell if the current value is the meta-data default.

getTransientExpression

java.lang.String getTransientExpression()

setTransientExpression

void setTransientExpression(java.lang.String expr)

evaluateTransientExpression

java.lang.Object evaluateTransientExpression(VariableManagerOwnerBase owner)

_getDomainContext

java.util.Map _getDomainContext()

For internal use only. Application developers should not use this

internal framework use only Returns a context object that will be used by the ADFbc data object to instantiate the right types.

setSerializerClassName

void setSerializerClassName(java.lang.String className)

Sets the name of the custom value serializer class. The class must implement the ValueSerializer interface.

Parameters:

className - name of the custom value serializer class

getSerializerClassName

java.lang.String getSerializerClassName()

Gets the name of the custom value serializer class.

Returns:

name of the custom value serializer class, or null if it is not defined.

getValueSerializer

ValueSerializer getValueSerializer()

Gets an instance of the custom value serializer class.

Returns:

an instance of the custom value serializer class, or null if it is not defined.

Throws:

JboException - if an error occurs loading the custom class or instantiating the object

See Also:

VariableValueManager.writeVarsToXML(Document, Element, boolean)

getXMLContentValue

java.lang.Object getXMLContentValue(Element varElem)

Converts an XML element to an instance of this variable's Java type.

Parameters:

varElem - an XML element containing the serialized variable value

Returns:

a Java object representing this variable value.

See Also:

VariableValueManager.readVarsFromXML(Element)

Skip navigation links