oracle.dacf.dataset
Class AttributeInfo

java.lang.Object
  oracle.dacf.dataset.DacObject
      oracle.dacf.dataset.ProducerObject
          oracle.dacf.dataset.InfoObject
              oracle.dacf.dataset.ColumnInfo
                  oracle.dacf.dataset.AttributeInfo

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ViewAccessorInfo

public class AttributeInfo

extends ColumnInfo

This class contains those properties necessary to support LOV lookups and initializations and default value initialization. AttributeInfo is derived from ColumnInfo, so it has a notion of a SQL type and column name. An AttributeInfo is an attribute of a query and can make reference to an LOV. When an LOV is used to populate a column or set of columns, that reference to the LOV is attached to the AttributeInfo.

An AttributeInfo column can have default values. This allows a default value for a column to be set when a new row is instantiated. AttributeInfo columns may be queriable; that is, you can set a WHERE clause for them.

All other column-specific properties are inherited from the ColumnInfo class.

Version:

SDK

Field Summary

Fields inherited from class oracle.dacf.dataset.ColumnInfo

DEFAULT, ERR_PROD_CODE, UPDATEABLE_IF_NEW

Fields inherited from class oracle.dacf.dataset.InfoObject

_updateMode, LEVEL_APPLICATION, LEVEL_ATTRIBUTE, LEVEL_COLUMN, LEVEL_QUERY_VIEW, LEVEL_ROOT, LEVEL_ROW, LEVEL_ROWSET, LEVEL_SESSION, PROPERTIES_COLUMN_NAME, UPDATEABLE_FALSE, UPDATEABLE_MAX_VAL, UPDATEABLE_TRUE, UPDATEABLE_UNDEFINED

Fields inherited from class oracle.dacf.dataset.ProducerObject

_openLock

Fields inherited from class oracle.dacf.dataset.DacObject

EMPTY_PREFIX, INITIAL_CAPACITY, ITEMNAME_DELIMITER

Constructor Summary

	AttributeInfo() Public constructor.
	AttributeInfo(int sqlType) Constructor requiring the java.sql.Type of the AttributeInfo.
protected	AttributeInfo(java.lang.String colName) Constructor requiring the name of the AttributeInfo column.

Method Summary

java.lang.Object	clone() Clones the object.
java.lang.String	getDefaultValue() Returns the default or initial value for the AttributeInfo.
LOVInterface	getLOV() Returns the LOV currently in use.
java.lang.String	getLOVForeignKeyName() Gets the foreign key name to be used in the LOV WHERE clause.
java.lang.String	getName() Returns the name of the DacObject.
RowSetInfo	getRowSetInfo() Returns the parent RowSetInfo.
protected void	internalValidation(int eventLevel) Internal: Applications should not use this method.
boolean	isDisplayLOVOnNavigateIn() Returns true if the LOV dialog will be displayed when focus shifts to a control bound to this object.
boolean	isQueryable() Returns true if the attribute is queryable.
void	publishAttribute() Publishes the Attribute and its child items on the InfoBus.
void	publishAttribute(boolean activate) Deprecated. Use publishAttribute()
void	revokeAttribute() Revokes the Attribute and its child items on the InfoBus.
void	setDefaultValue(java.lang.String nuDefaultValue) Sets the default or initial value.
void	setDisplayLOVOnNavigateIn(boolean displayOn) Set to true to display the LOV dialog in response to a navigated-in event on a control bound to this object.
void	setLOV(LOVInterface lov) Specifies the LOV which should be used for selection or validation.
void	setLOVForeignKeyName(java.lang.String lovForeignKeyName) Sets the foreign key name to be used in the LOV WHERE clause.
void	setName(java.lang.String st) Sets the InfoBus bind name of the object.
void	setQueryable(boolean queryable) Sets the queryable property for the attribute.
void	validate() Internal: Applications should not use this method.

Methods inherited from class oracle.dacf.dataset.ColumnInfo

closeCheck, closeChildren, closeDataItems, closeProducerObject, createPropertyColumn, getAttributeDef, getColumnAlignment, getColumnIndex, getColumnName, getColumnWidth, getDataItem, getDisplayable, getDisplayed, getFormatString, getFormatter, getFormatterInfo, getImmediateAccess, getLabel, getSQLType, isDirty, isNullAllowed, isPrimaryKey, isSortingEnabled, isUpdateable, isUpdateableIfNew, isValid, openChildren, openDataItems, openProducerObject, setColumnAlignment, setColumnName, setColumnWidth, setDirty, setDisplayable, setDisplayed, setFormatString, setFormatter, setFormatterInfo, setLabel, setSortingEnabled, setUpdateableIfNew, setValid, setViewObject

Methods inherited from class oracle.dacf.dataset.InfoObject

addChangeListener, addValidationListener, areParentsValid, clearDirty, createChild, fireValidationEvent, forceValid, getChangeListeners, getLocale, getUpdateMode, getValidationListeners, isActive, processValidationEvent, removeChangeListener, removeValidationListener, setActive, setLocale, setUpdateable, toString, validate, validate

Methods inherited from class oracle.dacf.dataset.ProducerObject

addChild, addClonedDataItem, close, findDataItem, findProducerObject, findProducerObject, getClonedDataItems, getDataItemImpl, getDataProducer, getDataSourceName, getFullName, isAClonedDataItem, isOpen, open, publishDataItem, publishDataItem, removeChild, removeClonedDataItem, revokeDataItem, setClonedDataItems, setDataItem, setDataSourceName, setOpen

Methods inherited from class oracle.dacf.dataset.DacObject

addChild, findDescendant, genCloneName, getChild, getChildIndex, getChildren, getNumOfChildren, getParent, getPrefix, insertChildAt, removeChild, removeChildren, setChildren, setParent, setPrefix

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeInfo

public AttributeInfo()

Public constructor.

AttributeInfo

public AttributeInfo(int sqlType)

Constructor requiring the java.sql.Type of the AttributeInfo.

Parameters:

sqlType - the SQL type of the attribute, according to java.sql.Types.

AttributeInfo

protected AttributeInfo(java.lang.String colName)

Constructor requiring the name of the AttributeInfo column.

Parameters:

colName - the name of the AttributeInfo column.

Method Detail

clone

public java.lang.Object clone()

Clones the object.

The LOV cannot be recursively cloned. The caller of AttributeInfo.clone() is responsible for creating and initializing the LOV, and setting the LOV on the cloned AttributeInfo.

Overrides:

clone in class ColumnInfo

setName

public void setName(java.lang.String st)

Description copied from class: ProducerObject

Sets the InfoBus bind name of the object.

Overrides:

setName in class ColumnInfo

getName

public java.lang.String getName()

Description copied from class: DacObject

Returns the name of the DacObject.

Overrides:

getName in class ColumnInfo

setDefaultValue

public void setDefaultValue(java.lang.String nuDefaultValue)

Sets the default or initial value.

The default or initial value is the value given to an Attribute whenever a new row is created in the rowset.

Parameters:

nuDefaultValue - the default or initial value as a String.

See Also:

getDefaultValue()

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default or initial value for the AttributeInfo.

The default or initial value is the value given to an Attribute whenever a new row is created in the RowSet.

Returns:

the default or initial value as a String.

See Also:

setDefaultValue(String nuDefaultValue)

setLOV

public void setLOV(LOVInterface lov)

Specifies the LOV which should be used for selection or validation.

Parameters:

lov - the LOV object to be used.

getLOV

public LOVInterface getLOV()

Returns the LOV currently in use.

isDisplayLOVOnNavigateIn

public boolean isDisplayLOVOnNavigateIn()

Returns true if the LOV dialog will be displayed when focus shifts to a control bound to this object.

Returns:

true if LOV should display on navigated-in event; false otherwise.

setDisplayLOVOnNavigateIn

public void setDisplayLOVOnNavigateIn(boolean displayOn)

Set to true to display the LOV dialog in response to a navigated-in event on a control bound to this object.

Parameters:

displayOn - true to display the LOV on a navigated-in event; false otherwise.

setLOVForeignKeyName

public void setLOVForeignKeyName(java.lang.String lovForeignKeyName)

Sets the foreign key name to be used in the LOV WHERE clause.

getLOVForeignKeyName

public java.lang.String getLOVForeignKeyName()

Gets the foreign key name to be used in the LOV WHERE clause.

Returns:

the foreign key name.

getRowSetInfo

public RowSetInfo getRowSetInfo()

Returns the parent RowSetInfo.

Returns:

the parent RowSetInfo.

publishAttribute

public void publishAttribute()

Publishes the Attribute and its child items on the InfoBus.

This method will cause the Attribute to be opened if it hasn't been previously opened.

publishAttribute

public void publishAttribute(boolean activate)

Deprecated. Use publishAttribute()

revokeAttribute

public void revokeAttribute()

Revokes the Attribute and its child items on the InfoBus.

See Also:

publishAttribute()

validate

public void validate()
              throws ValidationException

Description copied from class: InfoObject

Internal: Applications should not use this method.

Overrides:

validate in class InfoObject

Throws:

ValidationException

internalValidation

protected void internalValidation(int eventLevel)
                           throws ValidationException

Internal: Applications should not use this method.

Empty, default implementation. Subclasses will override to perform class specific validation strategies.

Overrides:

internalValidation in class InfoObject

Throws:

ValidationException

isQueryable

public boolean isQueryable()

Returns true if the attribute is queryable.

Queryable attributes can be used to restrict the query populating the rowset and will be displayed by the FindDialog.

Returns:

true if the attribute is queryable; false otherwise.

setQueryable

public void setQueryable(boolean queryable)

Sets the queryable property for the attribute.

Queryable attributes can be used to restrict the query populating the rowset and will be displayed by the FindDialog.

Parameters:

queryable - true if the attribute is queryable; false otherwise.