com.infoengine.object
Class IeObject

java.lang.Object
  com.infoengine.object.IeObject

All Implemented Interfaces:

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

Direct Known Subclasses:

IeAtt, IeCollection, IeGroup, IeNode, IeRequest

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

This is the base class for the Info*Engine classes that are used in defining groups and their components.

See Also:

Serialized Form

Constructor Summary

IeObject()
Constructs a new instance without a name.

IeObject(java.lang.String name)
Constructs a new instance with a name.

Method Summary

void	addAtt(IeAtt att) Adds an attribute to the object.
void	addMeta(java.lang.String key, byte[] value) Adds meta-information of type byte array to the object.
void	addMeta(java.lang.String key, java.util.Date value) Adds meta-information of type Date to the object.
void	addMeta(java.lang.String key, java.lang.Number value) Adds meta-information of type Number to the object.
void	addMeta(java.lang.String key, java.lang.String value) Adds meta-information of type String to the object.
void	addMetaDatum(java.lang.String key, IeDatum value) Adds meta-information of type IeDatum to the object.
void	addMetaValue(java.lang.String key, java.lang.Object o) Add/append an object to a possibly multi-valued meta-information item, or create a vector and add it to the meta-information item.
void	addMetaValues(java.lang.String key, java.util.Vector v) Add elements of a vector to a possibly multi-valued meta-information item.
void	appendMetaDatum(java.lang.String key, IeDatum value) Appends a value to the pre-existing value defined for a specified meta-information item.
java.lang.String	canonicalize()
void	canonicalize(java.lang.StringBuffer sb) append canonical string representation to a StringBuffer
java.lang.Object	clone() Returns a shallow copy of the object.
boolean	containsMetaValue(java.lang.String key, java.lang.Object value) Determines whether an object is contained within a meta-information item.
java.lang.Object	deepClone() Returns a deep copy of the object.
java.lang.Object	deepCopy(IeObject newObject) Returns a deep copy of the object.
IeAtt	firstAtt() Returns the first attribute associated with the object.
java.lang.Object	firstChild() Returns the object that is the first child of this object.
java.lang.Object	firstMetaValue(java.lang.String key) Returns the first value contained in a meta-information item.
IeAtt	getAtt(java.lang.String name) Returns an attribute specified by name.
IeAtt	getAttAt(int index) Returns the attribute located at a particular index.
IeAtt	getAttByMeta(java.lang.String name, java.lang.Object value) Returns the attribute containing a specific metadata name and value.
int	getAttCount() Returns the number of attributes associated with the object.
java.lang.String	getAttribute(java.lang.String name) Returns the value of a named attribute.
java.util.Enumeration	getAtts() Returns all of the attributes associated with the object.
int	getChildCount() Returns the number of objects that are immediate children of this object.
java.util.Enumeration	getChildren() Returns all of the objects that are immediate children of this object.
boolean	getHasChanged() Indicates whether this object has changed.
IeMeta	getMeta(java.lang.String key) Returns the value of a meta-information item.
java.util.Enumeration	getMetaNames() Return the names of all meta-information items associated with the object instance.
java.lang.Object	getMetaValue(java.lang.String key) Returns the value of a meta-information item.
java.lang.Object	getMetaValueAt(java.lang.String key, int index) Returns the value of a multi-valued meta-information item located at a specified index.
int	getMetaValueCount(java.lang.String key) Returns the number of values contained within a meta-information item.
java.util.Enumeration	getMetaValues(java.lang.String key) Returns all of the values contained within a meta-information item.
java.lang.String	getName() Returns the name of the object.
java.lang.String	getNodeName() Returns the name of this node.
java.lang.String	getTagName() Returns the name of the element.
java.lang.String	getType() Returns the type of the object.
boolean	hasChildren() Indicates whether this object has any children.
int	indexOfMetaValue(java.lang.String key, java.lang.Object value) Returns the index of a particular value of a meta-information item.
IeAtt	lastAtt() Returns the last attribute of the object.
java.lang.Object	lastChild() Returns the object that is the last child of this object.
java.lang.Object	lastMetaValue(java.lang.String key) Returns the last value contained in a meta-information item.
void	readExternal(java.io.ObjectInput in)
void	removeAllAtts() Removes all attributes of the object.
void	removeAllMeta() Removes all meta-information items from the object instance.
void	removeAllMetaValues(java.lang.String key) Removes all values of a meta-information item.
void	removeAtt(IeAtt att) Removes a particular attribute from the object.
void	removeAtt(java.lang.String name) Removes a particular attribute specified by name.
void	removeAttAt(int index) Removes the attribute located at a particular index.
void	removeAttribute(java.lang.String name) Removes an attribute from this DOM object.
void	removeChild(java.lang.Object o) Removes a particular child of this object.
void	removeMeta(java.lang.String key) Removes a meta-information item from the object instance.
void	removeMetaValue(java.lang.String key, java.lang.Object o) Removes a particular value from a meta-information item.
void	removeMetaValueAt(java.lang.String key, int index) Removes the value located at a particular index of a meta-information item.
void	removeName() Removes the object's name by setting it to null.
void	removeType() Removes the object's type by setting it to an empty string.
IeObject	replaceChild(IeObject newChild, IeObject oldChild) Replaces the specified child object with a new one.
void	setAttAt(IeAtt att, int index) Sets the attribute located at a particular index.
void	setAttribute(java.lang.String name, java.lang.String value) Sets a named attribute to a specified value.
void	setHasChanged(boolean hasChanged) Sets the modification flag.
void	setMeta(java.lang.String key, byte[] value) Set meta-information of type byte array on the object.
void	setMeta(java.lang.String key, java.util.Date value) Set meta-information of type Date on the object.
void	setMeta(java.lang.String key, java.lang.Number value) Set meta-information of type Number on the object.
void	setMeta(java.lang.String key, java.lang.String value) Set meta-information of type String on the object.
void	setMetaValue(java.lang.String s, java.lang.Object value) Set the value of a meta-information item.
void	setMetaValueAt(java.lang.String key, java.lang.String o, int index) Set the value located at a particular index of a multi-valued meta-information item.
void	setName(java.lang.String name) Sets the name of the object.
void	setType(java.lang.String type) Sets the type of the object.
java.lang.Object	shallowCopy(IeObject newObject) Returns a shallow copy of the object (without children).
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

IeObject

public IeObject()

Constructs a new instance without a name.

IeObject

public IeObject(java.lang.String name)

Constructs a new instance with a name.

Parameters:

name - the name to be assigned to the object

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

addMeta

public void addMeta(java.lang.String key,
                    java.lang.String value)

Adds meta-information of type String to the object.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

addMeta

public void addMeta(java.lang.String key,
                    java.util.Date value)

Adds meta-information of type Date to the object.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

addMeta

public void addMeta(java.lang.String key,
                    java.lang.Number value)

Adds meta-information of type Number to the object.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

addMeta

public void addMeta(java.lang.String key,
                    byte[] value)

Adds meta-information of type byte array to the object.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

addMetaDatum

public void addMetaDatum(java.lang.String key,
                         IeDatum value)

Adds meta-information of type IeDatum to the object.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

appendMetaDatum

public void appendMetaDatum(java.lang.String key,
                            IeDatum value)

Appends a value to the pre-existing value defined for a specified meta-information item.

Parameters:

key - the name of the meta-information item

value - the value to be appended

getMeta

public IeMeta getMeta(java.lang.String key)

Returns the value of a meta-information item.

Parameters:

key - the name of the meta-information item to return

Returns:

The value of the specified meta-information item

getMetaNames

public java.util.Enumeration getMetaNames()

Return the names of all meta-information items associated with the object instance.

Returns:

The names of all meta-information items

getNodeName

public java.lang.String getNodeName()

Returns the name of this node. Subclasses should override this method.

Returns:

The name of this node.

removeAllMeta

public void removeAllMeta()

Removes all meta-information items from the object instance.

removeMeta

public void removeMeta(java.lang.String key)

Removes a meta-information item from the object instance.

Parameters:

key - the name of the meta-information item to remove

replaceChild

public IeObject replaceChild(IeObject newChild,
                             IeObject oldChild)

Replaces the specified child object with a new one.

Parameters:

newChild - the new child object

oldChild - the child to be replaced

Returns:

The replaced object, or null if the old child is not found

setMeta

public void setMeta(java.lang.String key,
                    java.util.Date value)

Set meta-information of type Date on the object. If a meta-information item of the same name already exists on the object, it is replaced.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

setMeta

public void setMeta(java.lang.String key,
                    java.lang.String value)

Set meta-information of type String on the object. If a meta-information item of the same name already exists on the object, it is replaced.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

setMeta

public void setMeta(java.lang.String key,
                    byte[] value)

Set meta-information of type byte array on the object. If a meta-information item of the same name already exists on the object, it is replaced.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

setMeta

public void setMeta(java.lang.String key,
                    java.lang.Number value)

Set meta-information of type Number on the object. If a meta-information item of the same name already exists on the object, it is replaced.

Parameters:

key - the name of the meta-information item

value - the value of the meta-information item

addMetaValue

public void addMetaValue(java.lang.String key,
                         java.lang.Object o)

Add/append an object to a possibly multi-valued meta-information item, or create a vector and add it to the meta-information item.

Parameters:

key - the name of the meta-information item

o - the object to be added/appended

addMetaValues

public void addMetaValues(java.lang.String key,
                          java.util.Vector v)

Add elements of a vector to a possibly multi-valued meta-information item.

Parameters:

key - the name of the meta-information item

v - the vector containing objects to be added

containsMetaValue

public boolean containsMetaValue(java.lang.String key,
                                 java.lang.Object value)

Determines whether an object is contained within a meta-information item.

Parameters:

key - the name of the meta-information item

value - the value to test for containment

Returns:

true if the value is contained within the meta-information item

firstMetaValue

public java.lang.Object firstMetaValue(java.lang.String key)

Returns the first value contained in a meta-information item.

Parameters:

key - the name of the meta-information item

Returns:

The first value contained in the item

getMetaValue

public java.lang.Object getMetaValue(java.lang.String key)

Returns the value of a meta-information item. Use this method when you know that the meta-information item is single-valued.

Parameters:

key - the name of the meta-information item

Returns:

The value of the meta-information item

getMetaValueAt

public java.lang.Object getMetaValueAt(java.lang.String key,
                                       int index)

Returns the value of a multi-valued meta-information item located at a specified index.

Parameters:

key - the name of the meta-information item

index - the index of the value to return

Returns:

The value located at the specified index

getMetaValueCount

public int getMetaValueCount(java.lang.String key)

Returns the number of values contained within a meta-information item.

Parameters:

key - the name of the meta-information item

Returns:

The number of values contained within the item

getMetaValues

public java.util.Enumeration getMetaValues(java.lang.String key)

Returns all of the values contained within a meta-information item.

Parameters:

key - the name of the meta-information item

Returns:

All of the values contained within the item

indexOfMetaValue

public int indexOfMetaValue(java.lang.String key,
                            java.lang.Object value)

Returns the index of a particular value of a meta-information item.

Parameters:

key - the name of the meta-information item

value - the value for which to find the index

Returns:

The index of the value within the item

lastMetaValue

public java.lang.Object lastMetaValue(java.lang.String key)

Returns the last value contained in a meta-information item.

Parameters:

key - the name of the meta-information item

Returns:

The last value contained in the item

removeMetaValue

public void removeMetaValue(java.lang.String key,
                            java.lang.Object o)

Removes a particular value from a meta-information item.

Parameters:

key - the name of the meta-information item

o - the value to be removed

removeMetaValueAt

public void removeMetaValueAt(java.lang.String key,
                              int index)

Removes the value located at a particular index of a meta-information item.

Parameters:

key - the name of the meta-information item

index - the index of the value to be removed

removeAllMetaValues

public void removeAllMetaValues(java.lang.String key)

Removes all values of a meta-information item.

Parameters:

key - the name of the meta-information item

setMetaValue

public void setMetaValue(java.lang.String s,
                         java.lang.Object value)

Set the value of a meta-information item. If a meta-information item of the same name already exists on the object, its value is replaced.

Parameters:

key - the name of the meta-information item

value - the value to be set

setMetaValueAt

public void setMetaValueAt(java.lang.String key,
                           java.lang.String o,
                           int index)

Set the value located at a particular index of a multi-valued meta-information item.

Parameters:

key - the name of the meta-information item

o - the value to be set

index - the index of the value to be set

getChildren

public final java.util.Enumeration getChildren()

Returns all of the objects that are immediate children of this object.

Returns:

The immediate children of this object

removeChild

public final void removeChild(java.lang.Object o)

Removes a particular child of this object.

Parameters:

o - the child to be removed

addAtt

public void addAtt(IeAtt att)

Adds an attribute to the object.

Parameters:

att - the attribute to be added

firstAtt

public IeAtt firstAtt()

Returns the first attribute associated with the object.

Returns:

The first attribute of the object

getAtt

public IeAtt getAtt(java.lang.String name)

Returns an attribute specified by name.

Parameters:

name - the name of the attribute to return

Returns:

The named attribute

getAtts

public java.util.Enumeration getAtts()

Returns all of the attributes associated with the object.

Returns:

All attributes of the object

getAttAt

public IeAtt getAttAt(int index)

Returns the attribute located at a particular index.

Parameters:

index - the index of the attribute to be returned

Returns:

The attribute referenced by the index

getAttByMeta

public IeAtt getAttByMeta(java.lang.String name,
                          java.lang.Object value)

Returns the attribute containing a specific metadata name and value.

Parameters:

name - The name of the metadata.

value - The value of the metadata.

Returns:

The attribute containing the metadata name/value pair, or null if no attribute contains the specified name/value pair.

getAttCount

public int getAttCount()

Returns the number of attributes associated with the object.

Returns:

The number of attributes of the object

lastAtt

public IeAtt lastAtt()

Returns the last attribute of the object.

Returns:

The last attribute of the object

removeAllAtts

public void removeAllAtts()

Removes all attributes of the object.

removeAtt

public void removeAtt(java.lang.String name)

Removes a particular attribute specified by name.

Parameters:

name - the name of the attribute to be removed

removeAtt

public void removeAtt(IeAtt att)

Removes a particular attribute from the object.

Parameters:

att - the attribute to be removed

removeAttAt

public void removeAttAt(int index)

Removes the attribute located at a particular index.

Parameters:

index - the index of the attribute to be removed

setAttAt

public void setAttAt(IeAtt att,
                     int index)

Sets the attribute located at a particular index.

Parameters:

att - the new attribute to be set

index - the index of the attribute to be set

deepClone

public java.lang.Object deepClone()

Returns a deep copy of the object.

Returns:

The deep copy

shallowCopy

public final java.lang.Object shallowCopy(IeObject newObject)

Returns a shallow copy of the object (without children).

Parameters:

newObject - base object in which to generate the shallow copy

Returns:

The shallow copy

deepCopy

public final java.lang.Object deepCopy(IeObject newObject)

Returns a deep copy of the object.

Parameters:

newObject - base object in which to generate the deep copy

Returns:

The deep copy

clone

public final java.lang.Object clone()

Returns a shallow copy of the object.

Overrides:

clone in class java.lang.Object

Returns:

The shallow copy

getName

public java.lang.String getName()

Returns the name of the object.

Returns:

The name of the object, or null if the object has no name

setName

public void setName(java.lang.String name)

Sets the name of the object.

Parameters:

name - the name to set

removeName

public void removeName()

Removes the object's name by setting it to null.

getType

public java.lang.String getType()

Returns the type of the object.

Returns:

The object's type

setType

public void setType(java.lang.String type)

Sets the type of the object.

Parameters:

type - the type to set

removeType

public void removeType()

Removes the object's type by setting it to an empty string.

firstChild

public java.lang.Object firstChild()

Returns the object that is the first child of this object.

Returns:

The first child of this object

lastChild

public java.lang.Object lastChild()

Returns the object that is the last child of this object.

Returns:

The last child of this object

getChildCount

public int getChildCount()

Returns the number of objects that are immediate children of this object.

Returns:

The number of children associated with this object

hasChildren

public boolean hasChildren()

Indicates whether this object has any children.

Returns:

true if this object has any children

getHasChanged

public boolean getHasChanged()

Indicates whether this object has changed.

Returns:

true if this object has changed

setHasChanged

public void setHasChanged(boolean hasChanged)

Sets the modification flag.

Parameters:

hasChanged - true to indicate that the object has changed

getTagName

public java.lang.String getTagName()

Returns the name of the element.

Returns:

the name of the element

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Returns the value of a named attribute.

Parameters:

name - the name of the attribute to retrieve

Returns:

The attribute value, or null if the attribute is not found

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

Sets a named attribute to a specified value.

Parameters:

name - the name of the attribute to be set

value - the value to set

Throws:

DOMException - if attribute value can not be set

removeAttribute

public void removeAttribute(java.lang.String name)

Removes an attribute from this DOM object.

Parameters:

name - the name of the attribute to be removed

canonicalize

public java.lang.String canonicalize()

Returns:

canonical string representation

canonicalize

public void canonicalize(java.lang.StringBuffer sb)

append canonical string representation to a StringBuffer

Parameters:

sb - - the StringBuffer