Data Request Broker
2-3-release

fr.gael.drb
Interface DrbNodeList

All Superinterfaces:
DrbSequence
All Known Implementing Classes:
DrbAbstractNodeList, DrbDefaultNodeList

public interface DrbNodeList
extends DrbSequence

Collection of nodes. This interface provides primary operations to handle a collection of DrbNode It is compliant to the NodeList interface specified by W3C Document Object Model ()


Method Summary
 int getLength()
          The number of node in the list.
 DrbNode getNamedItem(String name, int occurence)
          Returns an occurence of item matching a specific name.
 DrbNode item(int index)
          Returns a specific item of the list.
 
Methods inherited from interface fr.gael.drb.DrbSequence
addItem, atomize, getItem, removeItem
 

Method Detail

item

DrbNode item(int index)
Returns a specific item of the list. The item is identified by its position (i.e. index or sequence number) in the list of nodes. The order depends on the implementation as well as from the operation that created the list. The index starts from 0 and shall not be greater or equal to the item count of the list. A null reference is returned if the provided index is outside the list bounds.

Parameters:
index - The position of the item starting from 0 and not greater or equal to the item count in the list.
Returns:
A reference to specified item or null if no such node.

getNamedItem

DrbNode getNamedItem(String name,
                     int occurence)
Returns an occurence of item matching a specific name. The occurence number starts from 1. The name is a local name without any prefix. A null reference is returned if the provided occurrence is outside the list bounds.

Parameters:
name - The name to match.
occurence - The occurence number of the desired child.
Returns:
A reference to specified item or null if no such node.

getLength

int getLength()
The number of node in the list. This number can be 0 if the list is empty but shall never be negative.

Specified by:
getLength in interface DrbSequence
Returns:
The number of nodes in the list.

Data Request Broker - DRB API®
2-3-release

Copyright© 2001-2009 GAEL Consultant. All rights reserved. Use is subject to license terms .