com.infoengine.object
Class IeGroup

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

All Implemented Interfaces:

Cloneable, Externalizable, Serializable

public class IeGroup

extends IeObject

implements Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.infoengine.object.IeObject

_attributes, _children, _hasChanged, _meta, _name, _type, INITIAL_LIST_SIZE, INITIAL_MAP_SIZE, USE_COLLECTIONS

Constructor Summary

IeGroup()
Constructs a new IeGroup

IeGroup(String name)
Constructs a new IeGroup and sets the group name to the given String.

Method Summary

void	addNode(IeNode node) Adds a node to the group.
Object	deepClone() Returns a deep copy of the group.
IeNode	firstNode() Returns the first node contained in the group.
IeNode	getNode(String name) Returns a node by name.
IeNode	getNodeAt(int index) Returns the node located at a specified index.
int	getNodeCount() Returns the number of nodes contained in the group.
String	getNodeName() Returns the DOM node name of this object.
Enumeration	getNodes() Returns all of the nodes contained in the group.
IeNode	lastNode() Returns the last node contained in the group.
void	removeAllNodes() Removes all of the nodes contained in the group.
void	removeNode(IeNode node) Removes a specified node from the group.
void	removeNode(String name) Removes a node by name.
void	setNodeAt(IeNode node, int index) Sets the node at a specified index.

Methods inherited from class com.infoengine.object.IeObject

_addChild, _addMeta, _getMeta, _removeChild, _setMeta, addAtt, addChild, addMeta, addMeta, addMeta, addMeta, addMetaDatum, addMetaValue, addMetaValues, appendMetaDatum, canonicalize, canonicalize, clearChildren, clone, containsChild, containsMetaValue, deepCopy, findChild, firstAtt, firstChild, firstMetaValue, getAtt, getAttAt, getAttByMeta, getAttCount, getAttribute, getAtts, getChildAt, getChildCount, getChildren, getHasChanged, getMeta, getMetaNames, getMetaValue, getMetaValueAt, getMetaValueCount, getMetaValues, getName, getTagName, getType, hasChildren, indexOfChild, indexOfMetaValue, lastAtt, lastChild, lastMetaValue, newList, newList, newMap, newMap, readExternal, removeAllAtts, removeAllChildren, removeAllMeta, removeAllMetaValues, removeAtt, removeAtt, removeAttAt, removeAttribute, removeChild, removeChildAt, removeMeta, removeMetaValue, removeMetaValueAt, removeName, removeType, replaceChild, setAttAt, setAttribute, setChildAt, setHasChanged, setMeta, setMeta, setMeta, setMeta, setMetaValue, setMetaValueAt, setName, setType, shallowCopy, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

IeGroup

public IeGroup()

Constructs a new IeGroup

IeGroup

public IeGroup(String name)

Constructs a new IeGroup and sets the group name to the given String.

Parameters:

name - the name of the group object

Method Detail

addNode

public void addNode(IeNode node)

Adds a node to the group.

Parameters:

node - the node to be added

firstNode

public IeNode firstNode()

Returns the first node contained in the group.

Returns:

The first node, or null if the group does not contain any nodes

getNode

public IeNode getNode(String name)

Returns a node by name.

Parameters:

name - the name of the node to be returned

Returns:

The named node, or null if the group does not contain the node

getNodes

public Enumeration getNodes()

Returns all of the nodes contained in the group.

Returns:

The nodes contained in the group

getNodeAt

public IeNode getNodeAt(int index)

Returns the node located at a specified index.

Parameters:

index - the index of the node to be returned

Returns:

The node located at the specified index, or null if the index exceeds the number of nodes contained in the group

getNodeCount

public int getNodeCount()

Returns the number of nodes contained in the group.

Returns:

The number of nodes in the group

lastNode

public IeNode lastNode()

Returns the last node contained in the group.

Returns:

The last node, or null if the group does not contain any nodes

removeAllNodes

public void removeAllNodes()

Removes all of the nodes contained in the group.

removeNode

public void removeNode(String name)

Removes a node by name.

Parameters:

name - the name of the node to be removed

removeNode

public void removeNode(IeNode node)

Removes a specified node from the group.

Parameters:

node - the node to be removed

setNodeAt

public void setNodeAt(IeNode node,
                      int index)

Sets the node at a specified index.

Parameters:

node - the new node to be set

index - the index at which to set the new node

getNodeName

public String getNodeName()

Returns the DOM node name of this object.

Overrides:

getNodeName in class IeObject

Returns:

The DOM node name of this object.

deepClone

public final Object deepClone()

Returns a deep copy of the group.

Overrides:

deepClone in class IeObject

Returns:

The deep copy