net.sourceforge.esw.collection
Interface IMetaCollection

All Superinterfaces:

java.lang.Cloneable, ICloneable, INode, ISupportObject, java.io.Serializable

All Known Implementing Classes:

MetaCollection, NodeMetaCollection

public interface IMetaCollection

extends INode

Provides the abilities to retrieve data from any data source, anywhere within the enterprise.

An IMetaCollection instance is an INode instance. All the abilities of the INode architecture are availiable to the IMetaCollection architecture. Since nearly all data structures can be represented as a graph of one sort or another, IMetaCollection instances can contain any kind of data.

Once you set an ITransducer instance on an IMetaCollection you can get() and put() (transduce) data from/to the specified external data source.

Initially, IMetaCollection instances have a DefaultTransducer instance assigned to it during their creational pattern. This DefaultTransducer instance throws TransducerExceptions during any get or put method invocation to handle accedental use of transduction without a viable ITransducer instance assigned to this IMetaCollection instance.

To create an instance of this IMetaCollection, see MetaFactory.createMetaCollection().

Examples:

    IMetaCollection meta = MetaFactory.createMetaCollection();
 

See Also:

MetaFactory, INode, ITransducer

Method Summary

void	get() Gets the data referrences by the current ITransducer instance into this IMetaCollection instance.
ITransducer	getTransducer() Returns the ITransducer instance used by this IMetaCollection instance during the put() or get() method invocations.
void	put() Puts the data contained within this IMetaCollection instance into the data source referenced by the current ITransducer instance.
void	setTransducer(ITransducer aTransducer) Sets the ITransducer instance to be used by this IMetaCollection instance during the put() or get() method invocations.

Methods inherited from interface net.sourceforge.esw.graph.INode

acceptVisitor, add, add, addParent, clear, containsID, get, get, getList, getParents, getValue, isEmpty, iterator, remove, removeParent, setValue, size

Methods inherited from interface net.sourceforge.esw.util.ISupportObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, getID, getProperty, getPropertySize, propertyKeys, removeProperty, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setID, setProperty

Methods inherited from interface net.sourceforge.esw.util.ICloneable

clone

Method Detail

setTransducer

public void setTransducer(ITransducer aTransducer)

Sets the ITransducer instance to be used by this IMetaCollection instance during the put() or get() method invocations.

Fires a IMetaResources.TRANSDUCER_PROPERTY property change event.

Parameters:

aTransducer - the ITransducer instance to be used for transduction.

See Also:

getTransducer()

getTransducer

public ITransducer getTransducer()

Returns the ITransducer instance used by this IMetaCollection instance during the put() or get() method invocations.

Returns:

the ITransducer instance for this IMetaCollection instance.

See Also:

setTransducer( ITransducer )

put

public void put()
         throws TransducerException

Puts the data contained within this IMetaCollection instance into the data source referenced by the current ITransducer instance.

Throws:

TransducerException - if an error occurred during the execution of put on the ITransducer instance.

See Also:

get()

get

public void get()
         throws TransducerException

Gets the data referrences by the current ITransducer instance into this IMetaCollection instance.

Throws:

TransducerException - if an error occurred during the execution of get on the ITransducer instance.

See Also:

put()