oracle.dacf.dataset
Class DataItemImpl

java.lang.Object
  oracle.dacf.dataset.DacObject
      oracle.dacf.dataset.DataItemImpl

All Implemented Interfaces:

java.lang.Cloneable, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, DataItemValidate

Direct Known Subclasses:

PropertyAccess, QueryCriteriaRowset, QueryCriteriaValue, oracle.dacf.dataset.RowsetAccessImpl, SingleValueImpl

public abstract class DataItemImpl

extends DacObject

implements java.lang.Cloneable, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, DataItemValidate

This class is the base class for all InfoBus data item implementations.

This class provides implementations for the DataItem, DataItemChangeManager, and DataItemValidate interfaces.

Field Summary

Fields inherited from class oracle.dacf.dataset.DacObject

EMPTY_PREFIX, INITIAL_CAPACITY, ITEMNAME_DELIMITER

Constructor Summary

protected	DataItemImpl()
protected	DataItemImpl(java.lang.String name, javax.infobus.InfoBusEventListener source)
protected	DataItemImpl(java.lang.String name, javax.infobus.InfoBusEventListener source, ProducerObject producerObject, DacObject parent) Creates a data item with a given name and InfoBus data source.

Method Summary

void	addDataItemChangeListener(javax.infobus.DataItemChangeListener l) Adds a listener for DataItemChange events.
java.lang.Object	clone() Copies the data item.
protected void	doPostRollback() Internal: Applications should not use this method.
protected void	doPreRollback() Internal: Applications should not use this method.
protected javax.infobus.DataItem	findDataItem(java.lang.String name) Find the DataItem indicated by name.
protected void	fireItemsAvailable(javax.infobus.InfoBus ib, java.lang.String prefix, javax.infobus.InfoBusDataProducer src) Publishes the availability of the DataItems on the InfoBus.
protected void	fireItemsAvailable(javax.infobus.InfoBus ib, java.lang.String prefix, javax.infobus.InfoBusDataProducer src, boolean doKids) Deprecated.
protected void	fireItemsRevoked(javax.infobus.InfoBus ib, java.lang.String prefix, javax.infobus.InfoBusDataProducer src) Revokes the availability of the DataItems on the InfoBus.
protected javax.infobus.DataItemChangeManagerSupport	getDataItemChangeSupport() Returns the InfoBus object that fires DataItemChange events.
ProducerObject	getProducerObject() Returns the data object that created this data item.
java.lang.Object	getProperty(java.lang.String propertyName) Returns a property of the data item.
javax.infobus.InfoBusEventListener	getSource() Returns the InfoBus data source that produced this data item.
boolean	isPublished() Indicates whether the DataItem has been published on the InfoBus.
protected void	postRollback() Internal: Applications should not use this method.
protected void	preRollback() Internal: Applications should not use this method.
protected void	publish()
protected void	publish(boolean publishKids)
void	release() Disposes of this data item, and any of its sub-items.
void	removeDataItemChangeListener(javax.infobus.DataItemChangeListener l) Removes a DataItemChange listener.
protected void	revoke()
protected void	setProducerObject(ProducerObject producerObject) Sets the data object that created this data item.
void	setSource(javax.infobus.InfoBusEventListener src) Returns the InfoBus data source that produced this data item.
protected void	shutdown() Internal: Applications should not use this method.
java.lang.String	toString() Returns a string representation of the data item for debugging.
void	validateItem() Validates the data item.

Methods inherited from class oracle.dacf.dataset.DacObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DataItemImpl

protected DataItemImpl()

DataItemImpl

protected DataItemImpl(java.lang.String name,
                       javax.infobus.InfoBusEventListener source)

DataItemImpl

protected DataItemImpl(java.lang.String name,
                       javax.infobus.InfoBusEventListener source,
                       ProducerObject producerObject,
                       DacObject parent)

Creates a data item with a given name and InfoBus data source.

Parameters:

name - The name of the data item.

source - The InfoBus data source for the data item.

Method Detail

clone

public java.lang.Object clone()

Copies the data item.

Overrides:

clone in class DacObject

Returns:

A copy of the data item.

getProducerObject

public final ProducerObject getProducerObject()

Returns the data object that created this data item.

Returns:

The data object that created this data item.

shutdown

protected void shutdown()

Internal: Applications should not use this method.

setProducerObject

protected void setProducerObject(ProducerObject producerObject)

Sets the data object that created this data item.

findDataItem

protected javax.infobus.DataItem findDataItem(java.lang.String name)

Find the DataItem indicated by name.

The name is generally of the form: oracle/Session/Iterator/Column and will contain that portion that has yet to be resolved

preRollback

protected void preRollback()

Internal: Applications should not use this method.

Caches the current row number. This method provides a hook to help calculatethe currency.

doPreRollback

protected void doPreRollback()

Internal: Applications should not use this method.

postRollback

protected void postRollback()

Internal: Applications should not use this method.

doPostRollback

protected void doPostRollback()

Internal: Applications should not use this method.

publish

protected void publish()

publish

protected void publish(boolean publishKids)

isPublished

public boolean isPublished()

Indicates whether the DataItem has been published on the InfoBus.

Returns:

true if the DataItem has been published on the InfoBus.

revoke

protected void revoke()

fireItemsAvailable

protected void fireItemsAvailable(javax.infobus.InfoBus ib,
                                  java.lang.String prefix,
                                  javax.infobus.InfoBusDataProducer src)

Publishes the availability of the DataItems on the InfoBus.

Parameters:

ib - The InfoBus to publish upon

prefix - The DataItem name prefix to be prepended to this object's name.

src - The InfoBusDataProducer source object.

fireItemsAvailable

protected void fireItemsAvailable(javax.infobus.InfoBus ib,
                                  java.lang.String prefix,
                                  javax.infobus.InfoBusDataProducer src,
                                  boolean doKids)

Deprecated.

fireItemsRevoked

protected void fireItemsRevoked(javax.infobus.InfoBus ib,
                                java.lang.String prefix,
                                javax.infobus.InfoBusDataProducer src)

Revokes the availability of the DataItems on the InfoBus.

Parameters:

ib - The InfoBus to publish upon

prefix - The DataItem name prefix to be prepended to this object's name.

src - The InfoBusDataProducer source object.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Returns a property of the data item.

DataItemProperties defines the properties supported.

Specified by:

getProperty in interface javax.infobus.DataItem

Parameters:

propertyName - The name of the property.

Returns:

The value of the property.

getSource

public javax.infobus.InfoBusEventListener getSource()

Returns the InfoBus data source that produced this data item.

Specified by:

getSource in interface javax.infobus.DataItem

Returns:

The InfoBus data source.

setSource

public void setSource(javax.infobus.InfoBusEventListener src)

Returns the InfoBus data source that produced this data item.

Returns:

The InfoBus data source.

release

public void release()

Disposes of this data item, and any of its sub-items.

Specified by:

release in interface javax.infobus.DataItem

addDataItemChangeListener

public final void addDataItemChangeListener(javax.infobus.DataItemChangeListener l)

Adds a listener for DataItemChange events.

Specified by:

addDataItemChangeListener in interface javax.infobus.DataItemChangeManager

Parameters:

l - The listener to add.

removeDataItemChangeListener

public void removeDataItemChangeListener(javax.infobus.DataItemChangeListener l)

Removes a DataItemChange listener.

Specified by:

removeDataItemChangeListener in interface javax.infobus.DataItemChangeManager

Parameters:

l - The listener to remove.

validateItem

public void validateItem()
                  throws javax.infobus.InvalidDataException

Validates the data item.

Specified by:

validateItem in interface DataItemValidate

Throws:

javax.infobus.InvalidDataException - If the data item is invalid.

getDataItemChangeSupport

protected final javax.infobus.DataItemChangeManagerSupport getDataItemChangeSupport()

Returns the InfoBus object that fires DataItemChange events.

Subclasses can use this object to fire change events to the data item's change listeners.

Returns:

The DataItemChangeSupport object.

toString

public java.lang.String toString()

Returns a string representation of the data item for debugging.

Returns:

A string representation of the data item.