com.infoengine.object
Class IeMeta

java.lang.Object
  com.infoengine.object.IeMeta

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class IeMeta
extends java.lang.Object
implements java.io.Externalizable, java.lang.Cloneable

See Also:

Serialized Form

Constructor Summary

IeMeta()
default no arg constructor to be used for de-serialization

IeMeta(java.lang.String name)
Constructs a new IeMeta object with a specified name.

Method Summary

void	addDatum(IeDatum datum) Adds a datum to the meta.
void	addDatums(java.util.Vector v) Appends a Vector of datums to the meta.
IeDatum	firstDatum() Returns the first datum contained in the meta.
IeDatum	getDatum() Returns the first datum contained in the meta.
IeDatum	getDatumAt(int index) Returns the datum located at a specified index.
int	getDatumCount() Returns the number of datums contained in the meta.
java.util.Enumeration	getDatums() Returns all of the datums contained in the meta.
java.lang.String	getName() Returns the name of this meta.
java.lang.String	getNodeName()
boolean	hasChildNodes()
int	indexOfDatum(IeDatum datum) Returns the index of a specified datum.
IeDatum	lastDatum() Returns the last datum contained in the meta.
void	readExternal(java.io.ObjectInput in)
void	removeAllDatums() Removes all of the datums contained in the meta.
void	removeDatum(IeDatum datum) Removes a specified datum from the meta.
void	removeDatumAt(int index) Removes the datum located at a specified index of the meta.
void	setDatum(IeDatum datum) Removes any pre-existing datums contained within the meta, then sets the specified datum as the only datum in the meta.
void	setDatumAt(IeDatum datum, int index) Sets the datum located at a specified index of the meta.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IeMeta

public IeMeta()

default no arg constructor to be used for de-serialization

IeMeta

public IeMeta(java.lang.String name)

Constructs a new IeMeta object with a specified name.

Method Detail

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

addDatum

public void addDatum(IeDatum datum)

Adds a datum to the meta.

Parameters:

datum - the datum to be added

addDatums

public void addDatums(java.util.Vector v)

Appends a Vector of datums to the meta.

Parameters:

v - the Vector of datums to be appended

firstDatum

public IeDatum firstDatum()

Returns the first datum contained in the meta.

Returns:

The first datum, or null if the meta does not contain any datums

getDatum

public IeDatum getDatum()

Returns the first datum contained in the meta.

Returns:

The first datum, or null if the meta does not contain any datums

getDatums

public java.util.Enumeration getDatums()

Returns all of the datums contained in the meta.

Returns:

The datums contained in the meta

getDatumAt

public IeDatum getDatumAt(int index)

Returns the datum located at a specified index.

Parameters:

index - the index of the datum to be returned

Returns:

The datum located at the specified index, or null if the index exceeds the number of datums contained in the meta

getDatumCount

public int getDatumCount()

Returns the number of datums contained in the meta.

Returns:

The number of datums in the meta

indexOfDatum

public int indexOfDatum(IeDatum datum)

Returns the index of a specified datum.

Parameters:

datum - the datum for which to return an index

Returns:

The index of the specified datum, or -1 if the datum is not found in the meta

lastDatum

public IeDatum lastDatum()

Returns the last datum contained in the meta.

Returns:

The last datum, or null if the meta does not contain any datums

removeAllDatums

public void removeAllDatums()

Removes all of the datums contained in the meta.

removeDatum

public void removeDatum(IeDatum datum)

Removes a specified datum from the meta.

Parameters:

datum - the datum to be removed

removeDatumAt

public void removeDatumAt(int index)

Removes the datum located at a specified index of the meta.

Parameters:

index - the index of the datum to be removed

setDatum

public void setDatum(IeDatum datum)

Removes any pre-existing datums contained within the meta, then sets the specified datum as the only datum in the meta.

Parameters:

datum - the datum to set

setDatumAt

public void setDatumAt(IeDatum datum,
                       int index)

Sets the datum located at a specified index of the meta.

Parameters:

datum - the new datum to be set

index - the index of the datum to be set

getName

public java.lang.String getName()

Returns the name of this meta.

Returns:

The name of this meta

getNodeName

public java.lang.String getNodeName()

hasChildNodes

public boolean hasChildNodes()