oracle.dacf.dataset
Class InfoObject

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

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ColumnInfo, ResultSetInfo, SessionInfo

public abstract class InfoObject

extends ProducerObject

implements java.lang.Cloneable

This abstract class defines the root object of the InfoObject tree. This is the base class for:

• SessionInfo
• ResultSetInfo
• RowSetInfo
• LOVRowSetInfo
• ColumnInfo
• AttributeInfo
• LOVAttributeInfo

This class provides functionality for opening and closing a connection between client and server objects. It also provides validation functionality. It is possible to subclass InfoObject, but you must ensure that the Navigation Manager, Validation Manager, Error Manager, and Style Manager will be able to handle the new objects correctly.

InfoObjects can abstract Java Business Objects and add additional funtionality on top of them: validation, navigation, formatting, subsetting, and so on.

Applications should not instantiate this class directly.

Version:

SDK: since JDeveloper 3.0

See Also:

SessionInfo, ResultSetInfo, RowSetInfo, LOVRowSetInfo, ColumnInfo, AttributeInfo, LOVAttributeInfo

Field Summary

protected int	_updateMode Property used to determine whether the InfoObject is updateable.
static int	LEVEL_APPLICATION Integer constant used by the Navigation and Validation Managers.
static int	LEVEL_ATTRIBUTE Integer constant used by the Navigation and Validation Managers.
static int	LEVEL_COLUMN Deprecated. replaced by LEVEL_ATTRIBUTE
static int	LEVEL_QUERY_VIEW Deprecated. replaced by LEVEL_ROWSET
static int	LEVEL_ROOT Integer constant used by the Navigation and Validation Managers.
static int	LEVEL_ROW Integer constant used by the Navigation and Validation Managers.
static int	LEVEL_ROWSET Integer constant used by the Navigation and Validation Managers.
static int	LEVEL_SESSION Integer constant used by the Navigation and Validation Managers.
static java.lang.String	PROPERTIES_COLUMN_NAME String constant used by the Navigation and Validation Managers.
protected static int	UPDATEABLE_FALSE Integer constant used by the Navigation and Validation Managers.
protected static int	UPDATEABLE_MAX_VAL Integer constant used by the Navigation and Validation Managers.
protected static int	UPDATEABLE_TRUE Integer constant used by the Navigation and Validation Managers.
protected static int	UPDATEABLE_UNDEFINED Integer constant used by the Navigation and Validation Managers.

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

protected	InfoObject() Default constructor.
protected	InfoObject(java.lang.String name) Constructor requiring the name of the InfoObject.
protected	InfoObject(java.lang.String n, InfoObject p, InfoObject[] c) Constructor requiring the name of the InfoObject, name of a parent object and an array of one or more child objects.

Method Summary

void	addChangeListener(ChangeListener listener) Adds a Change listener to this InfoObject.
void	addValidationListener(ValidationListener listener) Adds a Validation listener to this InfoObject.
boolean	areParentsValid() Determines if the chain of parent objects are valid.
protected void	clearDirty() Clears the dirty state of the InfoObject and all its children.
java.lang.Object	clone() Clones the DacObject.
protected ProducerObject	createChild(java.lang.String childName) This method is provided to be overriden by the derived classes to support creation of InfoObjects on the fly.
protected void	fireValidationEvent(java.lang.String itemName, int eventLevel, javax.infobus.DataItem item) Causes any attached validation listeners for the specified validation level to be executed.
void	forceValid() Forces an InfoObject and all of its children into a valid state.
protected ChangeListener[]	getChangeListeners() Returns all the registered change listeners
protected java.util.Locale	getLocale() Returns the locale for the InfoObject.
protected int	getUpdateMode() Returns the value of the Updateable tri-state property.
protected ValidationListener[]	getValidationListeners() Returns all of the registered validation listeners.
protected void	internalValidation(int eventLevel) Internal: Applications should not use this method.
boolean	isActive() Deprecated.
boolean	isDirty() Indicates whether the InfoObject is dirty.
boolean	isUpdateable() Returns the updateable property value.
boolean	isValid() Indicates whether the InfoObject is valid.
protected void	processValidationEvent(java.lang.String childItemName, int eventLevel) Deprecated. Non-functional
void	removeChangeListener(ChangeListener listener) Removes a Change listener from this control.
void	removeValidationListener(ValidationListener listener) Removes a Validation listener from this control.
void	setActive(boolean nuActive, boolean propagate) Deprecated.
protected void	setDirty(boolean dirty) Sets the dirty state of the InfoObject.
protected void	setLocale(java.util.Locale nuLocale) Sets the locale for the InfoObject and all of its child objects.
void	setUpdateable(boolean nuUpdateable) Sets the updateable property.
protected void	setValid(boolean valid) Sets the validation state of the InfoObject.
java.lang.String	toString() Returns a string containing the class name and the name of the specific instance.
protected void	validate() Internal: Applications should not use this method.
protected void	validate(int eventLevel) Internal: Applications should not use this method.
protected void	validate(java.lang.String name, int eventLevel, DataItemImpl di) Internal: Applications should not use this method.

Methods inherited from class oracle.dacf.dataset.ProducerObject

addChild, addClonedDataItem, close, closeCheck, closeChildren, closeDataItems, closeProducerObject, findDataItem, findProducerObject, findProducerObject, getClonedDataItems, getDataItem, getDataItemImpl, getDataProducer, getDataSourceName, getFullName, isAClonedDataItem, isOpen, open, openChildren, openDataItems, openProducerObject, publishDataItem, publishDataItem, removeChild, removeClonedDataItem, revokeDataItem, setClonedDataItems, setDataItem, setDataSourceName, setName, setOpen

Methods inherited from class oracle.dacf.dataset.DacObject

addChild, findDescendant, genCloneName, getChild, getChildIndex, getChildren, getName, 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

Field Detail

LEVEL_COLUMN

public static final int LEVEL_COLUMN

Deprecated. replaced by LEVEL_ATTRIBUTE

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_ATTRIBUTE

public static final int LEVEL_ATTRIBUTE

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_ROW

public static final int LEVEL_ROW

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_QUERY_VIEW

public static final int LEVEL_QUERY_VIEW

Deprecated. replaced by LEVEL_ROWSET

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_ROWSET

public static final int LEVEL_ROWSET

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_SESSION

public static final int LEVEL_SESSION

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_APPLICATION

public static final int LEVEL_APPLICATION

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

LEVEL_ROOT

public static final int LEVEL_ROOT

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

PROPERTIES_COLUMN_NAME

public static final java.lang.String PROPERTIES_COLUMN_NAME

String constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

UPDATEABLE_UNDEFINED

protected static final int UPDATEABLE_UNDEFINED

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

UPDATEABLE_FALSE

protected static final int UPDATEABLE_FALSE

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

UPDATEABLE_TRUE

protected static final int UPDATEABLE_TRUE

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

UPDATEABLE_MAX_VAL

protected static final int UPDATEABLE_MAX_VAL

Integer constant used by the Navigation and Validation Managers.

See Also:

Constant Field Values

_updateMode

protected int _updateMode

Property used to determine whether the InfoObject is updateable.

Constructor Detail

InfoObject

protected InfoObject()

Default constructor.

InfoObject

protected InfoObject(java.lang.String name)

Constructor requiring the name of the InfoObject.

Parameters:

name - the name of the InfoObject.

InfoObject

protected InfoObject(java.lang.String n,
                     InfoObject p,
                     InfoObject[] c)

Constructor requiring the name of the InfoObject, name of a parent object and an array of one or more child objects.

Parameters:

n - the name of the InfoObject.

p - the parent object for the InfoObject.

c - an array of child InfoObjects.

Method Detail

clone

public java.lang.Object clone()

Description copied from class: ProducerObject

Clones the DacObject.

The returned clone will not be open. The clone must be opened via open() prior to use.

Overrides:

clone in class ProducerObject

Returns:

the clone

See Also:

ProducerObject.open(boolean openChildren)

setActive

public void setActive(boolean nuActive,
                      boolean propagate)

Deprecated.

isActive

public boolean isActive()

Deprecated.

addValidationListener

public void addValidationListener(ValidationListener listener)

Adds a Validation listener to this InfoObject. The listener will receive ValidateXXX events.

Parameters:

listener - the listener to add.

removeValidationListener

public void removeValidationListener(ValidationListener listener)

Removes a Validation listener from this control.

Parameters:

listener - the listener to remove.

addChangeListener

public void addChangeListener(ChangeListener listener)

Adds a Change listener to this InfoObject. The listener will receive ValidateXXX events.

Parameters:

listener - the listener to add.

removeChangeListener

public void removeChangeListener(ChangeListener listener)

Removes a Change listener from this control.

Parameters:

listener - the listener to remove.

toString

public java.lang.String toString()

Returns a string containing the class name and the name of the specific instance.

Returns:

a string containing the class name and the name of the specific instance.

setUpdateable

public void setUpdateable(boolean nuUpdateable)

Sets the updateable property.

Parameters:

nuUpdateable - the new value of for the updateable property.

See Also:

#getUpdatable(>), #isUpdatable()

isUpdateable

public boolean isUpdateable()

Returns the updateable property value.

Returns:

true if the InfoObject is updatable.

See Also:

setUpdateable(boolean), #getUpdateable()

getUpdateMode

protected int getUpdateMode()

Returns the value of the Updateable tri-state property.

The property can have one of three values:

• UPDATEABLE_UNDEFINED
• UPDATEABLE_FALSE
• UPDATEABLE_TRUE

Returns:

the current value of the _updateMode tri-state.

See Also:

setUpdateable(boolean), isUpdateable()

setLocale

protected void setLocale(java.util.Locale nuLocale)

Sets the locale for the InfoObject and all of its child objects.

Parameters:

nuLocale - the new locale to be used.

See Also:

getLocale()

getLocale

protected java.util.Locale getLocale()

Returns the locale for the InfoObject.

Returns:

the locale for the InfoObject Object.

See Also:

setLocale(Locale nuLocale)

getValidationListeners

protected ValidationListener[] getValidationListeners()

Returns all of the registered validation listeners.

Returns:

an array of the registered validation listeners.

getChangeListeners

protected ChangeListener[] getChangeListeners()

Returns all the registered change listeners

Returns:

an array of the registered change listeners.

processValidationEvent

protected void processValidationEvent(java.lang.String childItemName,
                                      int eventLevel)
                               throws ValidationException

Deprecated. Non-functional

Throws:

ValidationException

validate

protected void validate()
                 throws ValidationException

Internal: Applications should not use this method.

Throws:

ValidationException

validate

protected void validate(int eventLevel)
                 throws ValidationException

Internal: Applications should not use this method.

Throws:

ValidationException

validate

protected void validate(java.lang.String name,
                        int eventLevel,
                        DataItemImpl di)
                 throws ValidationException

Internal: Applications should not use this method.

Parameters:

name - dataitem name

eventLevel - validation level

di - DataItemImpl pointed to by name

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.

Throws:

ValidationException

fireValidationEvent

protected void fireValidationEvent(java.lang.String itemName,
                                   int eventLevel,
                                   javax.infobus.DataItem item)
                            throws ValidationException

Causes any attached validation listeners for the specified validation level to be executed.

Throws:

ValidationException - passes on any thrown ValidationException objects.

isValid

public boolean isValid()

Indicates whether the InfoObject is valid. The validation state of the InfoObject is a logical AND of the validation state of this InfoObject and all of its children's validation states.

See Also:

setValid(boolean)

areParentsValid

public boolean areParentsValid()

Determines if the chain of parent objects are valid.

Recurses up the containment hierarchy checking if any of the parent objects are valid.

Returns:

True if all of the parent objects are valid

See Also:

isValid()

setValid

protected void setValid(boolean valid)

Sets the validation state of the InfoObject. If the InfoObject's validaion state is set to INVALID, then all of the InfoObjects's ancestors will also be set to invalid.

Parameters:

valid - true if the value is valid.

See Also:

isValid()

isDirty

public boolean isDirty()

Indicates whether the InfoObject is dirty. The dirty state of the InfoObject is a logical OR of the dirty state of this InfoObject and all of its children's dirty states.

See Also:

setDirty(boolean)

setDirty

protected void setDirty(boolean dirty)

Sets the dirty state of the InfoObject. If the InfoObject's dirty state is set to true, then all of the InfoObjects's ancestors will be set to dirty also.

Parameters:

dirty - true if the value is dirty.

See Also:

isDirty()

clearDirty

protected void clearDirty()

Clears the dirty state of the InfoObject and all its children.

See Also:

isDirty()

forceValid

public void forceValid()

Forces an InfoObject and all of its children into a valid state. This method is intended for advanced application developers only who need to plug-in a custom rollback algorithm.

See Also:

isValid()

createChild

protected ProducerObject createChild(java.lang.String childName)

This method is provided to be overriden by the derived classes to support creation of InfoObjects on the fly.

Returns:

the child InfoObject.