org.osid.ontology

Interface OntologyNodeList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface OntologyNodeList
extends OsidList

Like all OsidLists, OntologyNodeList provides a means for accessing OntologyNode elements sequentially either one at a time or many at a time. Examples:

       
       
       while (onl.hasNext()) {
            OntologyNode node = onl.getNextOntologyNode();
       }
       
                   
       
  

or

       
       
       while (onl.hasNext()) {
            OntologyNode[] nodes = onl.getNextOntologyNodes(onl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
OntologyNode	getNextOntologyNode() Gets the next OntologyNode in this list.
OntologyNode[]	getNextOntologyNodes(long n) Gets the next set of OntologyNode elements in this list which must be less than or equal to the return from available().

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextOntologyNode

OntologyNode getNextOntologyNode()
                                 throws OperationFailedException

Gets the next OntologyNode in this list.

Returns:

the next OntologyNode in this list. The hasNext() method should be used to test that a next OntologyNode is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextOntologyNodes

OntologyNode[] getNextOntologyNodes(long n)
                                    throws OperationFailedException

Gets the next set of OntologyNode elements in this list which must be less than or equal to the return from available().

Parameters:

n - the number of OntologyNode elements requested which must be less than or equal to available()

Returns:

an array of OntologyNode elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.