Interface OntologyList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface OntologyList extends OsidList

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

while (ol.hasNext()) {
     Ontology ontology = ol.getNextOntology();
}
or 
while (ol.hasNext()) {
     Ontology[] ontologies = ol.getNextOntologies(ol.available());
}

  • Method Summary

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

    Methods inherited from interface Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • getNextOntology

      Ontology getNextOntology() throws OperationFailedException
      Gets the next Ontology in this list.
      Returns:
      the next Ontology in this list. The hasNext() method should be used to test that a next Ontology 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.

    • getNextOntologies

      Ontology[] getNextOntologies(long n) throws OperationFailedException
      Gets the next set of Ontology elements in this list which must be less than or equal to the return from available() .
      Parameters:
      n - the number of Ontology elements requested which must be less than or equal to available()
      Returns:
      an array of Ontology 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.