com.att.gs.codip.ograph
Interface OGOntology

All Superinterfaces:
LogicalResource, OGResource
All Known Implementing Classes:
DAML, OGBaseOntology, OGOntologyImp, OGVirtualOntologyImp, OWL, RDFS, XSD

public interface OGOntology
extends OGResource

This is the interface for the ontology container class.


Method Summary
 void addClass(OGClass theClass)
          Adds the provided class to the ontology.
 void addDatatype(OGDatatype theDatatype)
          Adds the provided data type to the ontology.
 void addImport(OGOntology theImport)
          Adds the provided ontology to the ontology's imports.
 void addLiteral(OGLiteral theLiteral)
          Adds the provided literal to the ontology.
 void addProperty(OGProperty theProperty)
          Adds the provided property to the ontology.
 void addResource(OGResource theResource)
          Adds the provided resource to the ontology.
 java.util.Iterator classes()
          Provides a iterator for the all of the ontology's classes.
 java.util.Iterator classes(OGResource aType)
          Provides a iterator for only the ontology's classes of the provided type.
 boolean containsClass(java.lang.Object theID)
          Checks for the existence of a Class in this ontology whose ID matches the provided ID.
 boolean containsDatatype(java.lang.Object theID)
          Checks for the existence of a Datatype in this ontology whose ID matches the provided ID.
 boolean containsImport(java.lang.Object theID)
          Looks for an imported ontology in this ontology whose ID matches the provided ID.
 boolean containsLiteral(java.lang.Object theID)
          Looks for a literal in this ontology whose ID matches the provided ID.
 boolean containsProperty(java.lang.Object theID)
          Checks for the existence of a property in this ontology whose ID matches the provided ID.
 boolean containsResource(java.lang.Object theID)
          Looks for a resource in this ontology whose ID matches the provided ID.
 OGClass createClass()
          Creates a Class in this ontology with a generated unique ID and adds the Class to the ontology.
 OGClass createClass(OGResource aType)
          Creates a Class in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Class to the ontology.
 OGClass createClass(OGResource aType, java.lang.String theID)
          Looks for, and possibilly creates, a Class in this ontology.
 OGClass createClass(java.lang.String theID)
          Looks for, and possibilly creates, a Class in this ontology.
 OGDatatype createDatatype()
          Creates a Datatype in this ontology with a generated unique ID and adds the Datatype to the ontology.
 OGDatatype createDatatype(OGResource aType)
          Creates a Datatype in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Datatype to the ontology.
 OGDatatype createDatatype(OGResource aType, java.lang.String theID)
          Looks for, and possibilly creates, a Datatype in this ontology.
 OGDatatype createDatatype(java.lang.String theID)
          Looks for, and possibilly creates, a Datatype in this ontology.
 OGLiteral createLiteral()
          Creates a Literal in this ontology with a generated unique ID and adds the Literal to the ontology.
 OGLiteral createLiteral(OGResource aType)
          Creates a Literal in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Literal to the ontology.
 OGLiteral createLiteral(OGResource aType, java.lang.String theID)
          Looks for, and possibilly creates, a Literal in this ontology.
 OGLiteral createLiteral(java.lang.String theID)
          Looks for, and possibilly creates, a Literal in this ontology.
 OGLiteral createLiteralByValue(OGResource aType, java.lang.String theID)
          Looks for, and possibilly creates, a Literal in this ontology.
 OGLiteral createLiteralByValue(java.lang.String theValue)
          Looks for, and possibilly creates, a Literal in this ontology.
 OGProperty createProperty()
          Creates a Property in this ontology with a generated unique ID and adds the Property to the ontology.
 OGProperty createProperty(OGResource aType)
          Creates a Property in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Property to the ontology.
 OGProperty createProperty(OGResource aType, java.lang.String theID)
          Looks for, and possibilly creates, a Property in this ontology.
 OGProperty createProperty(java.lang.String theID)
          Looks for, and possibilly creates, a Property in this ontology.
 OGPropInstance createPropInstance(OGResource aType)
          Creates a Property instance in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Property to the ontology.
 OGPropInstance createPropInstance(OGResource aType, java.lang.String theID)
          Looks for, and possibilly creates, a Property instance in this ontology.
 java.util.Iterator datatypes()
          Provides a iterator for the all of the ontology's data types.
 java.util.Iterator datatypes(OGResource aType)
          Provides a iterator for only the ontology's data types of the provided type.
 OGClass getClass(java.lang.Object theID)
          Looks for a Class in this ontology whose ID matches the provided ID.
 java.util.Collection getClasses(OGResource aType)
          Provides a Collection of the ontology's classes of the provided type.
 OGDatatype getDatatype(java.lang.Object theID)
          Looks for a Datatype in this ontology whose ID matches the provided ID.
 java.util.Collection getDatatypes(OGResource aType)
          Provides a Collection of the ontology's data types of the provided type.
 OGOntology getImport(java.lang.Object theID)
          Looks for an imported ontology in this ontology whose ID matches the provided ID.
 OGOntology[] getImports()
          Accessor for the read only indexed bean property, "imports"
 OGLiteral getLiteral(java.lang.Object theID)
          Looks for a literal in this ontology whose ID matches the provided ID.
 java.util.Collection getLiterals(OGResource aType)
          Provides a Collection of the ontology's literals of the provided type.
 java.util.Collection getProperties(OGResource aType)
          Provides a Collection of the ontology's properties of the provided type.
 OGProperty getProperty(java.lang.Object theID)
          Looks for a property in this ontology whose ID matches the provided ID.
 OGResource getResource(java.lang.Object theID)
          Looks for a resource in this ontology whose ID matches the provided ID.
 java.util.Collection getResources(OGResource aType)
          Provides a Collection of the ontology's resources of the provided type.
 java.lang.String getSourceURI()
          Getter method for the source URI of this ontology.
 java.lang.String getVersionInfo()
          Getter method for the version information of this ontology.
 java.util.Iterator imports()
          Provides a iterator for the all of the ontology's imports.
 java.util.Iterator literals()
          Provides a iterator for the all of the ontology's literals.
 java.util.Iterator literals(OGResource aType)
          Provides a iterator for only the ontology's literals of the provided type.
 OGClass lookupClass(java.lang.Object theID)
          Looks for a matching class in this ontology.
 OGClass lookupClass(java.lang.Object theID, boolean pCreate)
          Looks for, and possibilly creates, a Class in this ontology.
 OGDatatype lookupDatatype(java.lang.Object theID)
          Looks for a matching data type in this ontology.
 OGDatatype lookupDatatype(java.lang.Object theID, boolean pCreate)
          Looks for, and possibilly creates, a Datatype in this ontology.
 OGOntology lookupImport(java.lang.Object theID)
          Looks for an imported ontology by ID.
 OGLiteral lookupLiteral(java.lang.Object theID)
          Looks for a matching literal in this ontology.
 OGLiteral lookupLiteral(java.lang.Object theID, boolean pCreate)
          Looks for, and possibilly creates, a literal in this ontology.
 OGProperty lookupProperty(java.lang.Object theID)
          Looks for a matching property in this ontology.
 OGProperty lookupProperty(java.lang.Object theID, boolean pCreate)
          Looks for, and possibilly creates, a property in this ontology.
 OGResource lookupResource(java.lang.Object theID)
          Looks for a matching resource in this ontology.
 void morph(java.lang.String URI)
          Use this method to convert an Ontology to a new URI
 java.util.Iterator properties()
          Provides a iterator for the all of the ontology's properties.
 java.util.Iterator properties(OGResource aType)
          Provides a iterator for only the ontology's properties of the provided type.
 void removeClass(OGClass theClass)
          Removes the provided class from the ontology.
 void removeDatatype(OGDatatype theDatatype)
          Removes the provided data type from the ontology.
 void removeImport(OGOntology theImport)
          Removes the provided ontology from the ontology's imports.
 void removeLiteral(OGLiteral theLiteral)
          Removes the provided literal from the ontology.
 void removeProperty(OGProperty theProperty)
          Removes the provided property from the ontology.
 void removeResource(OGResource theResource)
          Removes the provided resource from the ontology.
 java.util.Iterator resources()
          Provides a iterator for the all of the ontology's resources.
 java.util.Iterator resources(OGResource aType)
          Provides a iterator for only the ontology's resources of the provided type.
 void setSourceURI(java.lang.String theSourceURI)
          Setter method for the source URI of this ontology.
 void setVersionInfo(java.lang.String theVersionInfo)
          Setter method for the version information of this ontology.
 
Methods inherited from interface com.att.gs.codip.ograph.OGResource
addNewPropInstance, addPropInstance, addType, containsPropInstance, containsType, getComment, getID, getLabel, getLocalName, getNamespace, getOntology, getPropInstance, getPropInstances, getPropInstances, getURI, lookupPropInstance, propInstances, propInstances, removePropInstance, removeType, setComment, setLabel, types
 
Methods inherited from interface com.att.gs.codip.resource.LogicalResource
getType, isLiteralType, isType, setType
 

Method Detail

morph

public void morph(java.lang.String URI)
Use this method to convert an Ontology to a new URI


setSourceURI

public void setSourceURI(java.lang.String theSourceURI)
Setter method for the source URI of this ontology. Public wrapper method for the portected method OGResource.setURI(String) method which is used internally.

Parameters:
theSourceURI - The source URI String.

getSourceURI

public java.lang.String getSourceURI()
Getter method for the source URI of this ontology. Provided for completeness returns the same URI string as getURI()

Returns:
The source URI String.

setVersionInfo

public void setVersionInfo(java.lang.String theVersionInfo)
Setter method for the version information of this ontology.

Parameters:
theVersionInfo - The version information String.

getVersionInfo

public java.lang.String getVersionInfo()
Getter method for the version information of this ontology.

Returns:
The version information String.

lookupClass

public OGClass lookupClass(java.lang.Object theID)
Looks for a matching class in this ontology. Searches this onlology and all imported ontologies for a class whose ID matches the provided ID.

Parameters:
theID - The ID of the sought class.
Returns:
The matching class if found, otherwise returns void.

lookupClass

public OGClass lookupClass(java.lang.Object theID,
                           boolean pCreate)
Looks for, and possibilly creates, a Class in this ontology. Searches this onlology and all imported ontologies for a class whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists.

Parameters:
theID - The ID of the sought class.
pCreate - true causes a new instance to be created if no existing match is found.
Returns:
The matching class if found or created, otherwise returns void.

createClass

public OGClass createClass()
Creates a Class in this ontology with a generated unique ID and adds the Class to the ontology.

Returns:
The matching class created, otherwise returns void.

createClass

public OGClass createClass(java.lang.String theID)
Looks for, and possibilly creates, a Class in this ontology. Searches this onlology and all imported ontologies for a class whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The class if new is added to the Ontology.

Parameters:
theID - The ID of the new class.
Returns:
The matching class if found or created, otherwise returns void.

createClass

public OGClass createClass(OGResource aType)
Creates a Class in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Class to the ontology.

Parameters:
aType - The type of the new class.
Returns:
The matching class created, otherwise returns void.

createClass

public OGClass createClass(OGResource aType,
                           java.lang.String theID)
Looks for, and possibilly creates, a Class in this ontology. Searches this onlology and all imported ontologies for a class whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The class if new is added to the Ontology with the type sets to the passed in type.

Parameters:
aType - The type of the new class.
theID - The ID of the new class.
Returns:
The matching class if found or created, otherwise returns void.

addClass

public void addClass(OGClass theClass)
Adds the provided class to the ontology. The provided class should be added so that it will be included in both class and resource collections as appropriate.

Parameters:
theClass - The class to add to the ontology.

removeClass

public void removeClass(OGClass theClass)
Removes the provided class from the ontology.

Parameters:
theClass - The class to remove to the ontology.

getClass

public OGClass getClass(java.lang.Object theID)
Looks for a Class in this ontology whose ID matches the provided ID. Differs from lookupClass in that the imports are not searched.

Parameters:
theID - The ID of the sought class.
Returns:
The matching class if found, otherwise returns void.

containsClass

public boolean containsClass(java.lang.Object theID)
Checks for the existence of a Class in this ontology whose ID matches the provided ID. The class must be in this ontology, not in its imports.

Parameters:
theID - The ID of the sought class.
Returns:
true if the class exists in this ontology.

classes

public java.util.Iterator classes()
Provides a iterator for the all of the ontology's classes.

Returns:
An iterator over all the ontology's classes.

classes

public java.util.Iterator classes(OGResource aType)
Provides a iterator for only the ontology's classes of the provided type.

Parameters:
aType - The type of classes to include in the iterator.
Returns:
An iterator over some of the ontology's classes.

getClasses

public java.util.Collection getClasses(OGResource aType)
Provides a Collection of the ontology's classes of the provided type.

Parameters:
aType - The type of classes to include in the iterator.
Returns:
A collection of some of the ontology's classes.

lookupDatatype

public OGDatatype lookupDatatype(java.lang.Object theID)
Looks for a matching data type in this ontology. Searches this onlology and all imported ontologies for a data type whose ID matches the provided ID.

Parameters:
theID - The ID of the sought data type.
Returns:
The matching data type if found, otherwise returns void.

lookupDatatype

public OGDatatype lookupDatatype(java.lang.Object theID,
                                 boolean pCreate)
Looks for, and possibilly creates, a Datatype in this ontology. Searches this onlology and all imported ontologies for a data type whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists.

Parameters:
theID - The ID of the sought data type.
pCreate - true causes a new instance to be created if no existing match is found.
Returns:
The matching data type if found or created, otherwise returns void.

createDatatype

public OGDatatype createDatatype()
Creates a Datatype in this ontology with a generated unique ID and adds the Datatype to the ontology.

Returns:
The matching Datatype created, otherwise returns void.

createDatatype

public OGDatatype createDatatype(java.lang.String theID)
Looks for, and possibilly creates, a Datatype in this ontology. Searches this onlology and all imported ontologies for a Datatype whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The Datatype if new is added to the Ontology.

Parameters:
theID - The ID of the new Datatype.
Returns:
The matching Datatype if found or created, otherwise returns void.

createDatatype

public OGDatatype createDatatype(OGResource aType)
Creates a Datatype in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Datatype to the ontology.

Parameters:
aType - The type of the new Datatype.
Returns:
The matching Datatype created, otherwise returns void.

createDatatype

public OGDatatype createDatatype(OGResource aType,
                                 java.lang.String theID)
Looks for, and possibilly creates, a Datatype in this ontology. Searches this onlology and all imported ontologies for a Datatype whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The Datatype if new is added to the Ontology with the type sets to the passed in type.

Parameters:
aType - The type of the new Datatype.
theID - The ID of the new Datatype.
Returns:
The matching Datatype if found or created, otherwise returns void.

addDatatype

public void addDatatype(OGDatatype theDatatype)
Adds the provided data type to the ontology. The provided data type should be added so that it will be included in both data type and resource collections as appropriate.

Parameters:
theDatatype - The data type to add to the ontology.

removeDatatype

public void removeDatatype(OGDatatype theDatatype)
Removes the provided data type from the ontology.

Parameters:
theDatatype - The data type to remove to the ontology.

getDatatype

public OGDatatype getDatatype(java.lang.Object theID)
Looks for a Datatype in this ontology whose ID matches the provided ID. Differs from lookupDatatype in that the imports are not searched.

Parameters:
theID - The ID of the sought data type.
Returns:
The matching data type if found, otherwise returns void.

containsDatatype

public boolean containsDatatype(java.lang.Object theID)
Checks for the existence of a Datatype in this ontology whose ID matches the provided ID. The data type must be in this ontology, not in its imports.

Parameters:
theID - The ID of the sought data type.
Returns:
true if the data type exists in this ontology.

datatypes

public java.util.Iterator datatypes()
Provides a iterator for the all of the ontology's data types.

Returns:
An iterator over all the ontology's data types.

datatypes

public java.util.Iterator datatypes(OGResource aType)
Provides a iterator for only the ontology's data types of the provided type.

Parameters:
aType - The type of data types to include in the iterator.
Returns:
An iterator over some of the ontology's data types.

getDatatypes

public java.util.Collection getDatatypes(OGResource aType)
Provides a Collection of the ontology's data types of the provided type.

Parameters:
aType - The type of data types to include in the iterator.
Returns:
A collection of some of the ontology's data types.

lookupProperty

public OGProperty lookupProperty(java.lang.Object theID)
Looks for a matching property in this ontology. Searches this onlology and all imported ontologies for a property whose ID matches the provided ID.

Parameters:
theID - The ID of the sought property.
Returns:
The matching property if found, otherwise returns void.

lookupProperty

public OGProperty lookupProperty(java.lang.Object theID,
                                 boolean pCreate)
Looks for, and possibilly creates, a property in this ontology. Searches this onlology and all imported ontologies for a property whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists.

Parameters:
theID - The ID of the sought property.
pCreate - true causes a new instance to be created if no existing match is found.
Returns:
The matching property if found or created, otherwise returns void.

createProperty

public OGProperty createProperty()
Creates a Property in this ontology with a generated unique ID and adds the Property to the ontology.

Returns:
The matching Property created, otherwise returns void.

createProperty

public OGProperty createProperty(java.lang.String theID)
Looks for, and possibilly creates, a Property in this ontology. Searches this onlology and all imported ontologies for a Property whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The Property if new is added to the Ontology.

Parameters:
theID - The ID of the new Property.
Returns:
The matching Property if found or created, otherwise returns void.

createProperty

public OGProperty createProperty(OGResource aType)
Creates a Property in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Property to the ontology.

Parameters:
aType - The type of the new Property.
Returns:
The matching Property created, otherwise returns void.

createProperty

public OGProperty createProperty(OGResource aType,
                                 java.lang.String theID)
Looks for, and possibilly creates, a Property in this ontology. Searches this onlology and all imported ontologies for a Property whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The Property if new is added to the Ontology with the type sets to the passed in type.

Parameters:
aType - The type of the new Property.
theID - The ID of the new Property.
Returns:
The matching Property if found or created, otherwise returns void.

createPropInstance

public OGPropInstance createPropInstance(OGResource aType)
Creates a Property instance in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Property to the ontology.

Parameters:
aType - The type of the new Property.
Returns:
The matching Property created, otherwise returns void.

createPropInstance

public OGPropInstance createPropInstance(OGResource aType,
                                         java.lang.String theID)
Looks for, and possibilly creates, a Property instance in this ontology. Searches this onlology for a Property whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The Property if new is added to the Ontology with the type sets to the passed in type.

Parameters:
aType - The type of the new Property.
theID - The ID of the new Property.
Returns:
The matching Property Instance if found or created, otherwise returns void.

addProperty

public void addProperty(OGProperty theProperty)
Adds the provided property to the ontology. The provided property should be added so that it will be included in both property and resource collections as appropriate.

Parameters:
theProperty - The property to add to the ontology.

removeProperty

public void removeProperty(OGProperty theProperty)
Removes the provided property from the ontology.

Parameters:
theProperty - The property from remove to the ontology.

getProperty

public OGProperty getProperty(java.lang.Object theID)
Looks for a property in this ontology whose ID matches the provided ID. Differs from lookupProperty in that the imports are not searched.

Parameters:
theID - The ID of the sought property.
Returns:
The matching property if found, otherwise returns void.

containsProperty

public boolean containsProperty(java.lang.Object theID)
Checks for the existence of a property in this ontology whose ID matches the provided ID. The property must be in this ontology, not in its imports.

Parameters:
theID - The ID of the sought property.
Returns:
true if the property exists in this ontology.

properties

public java.util.Iterator properties()
Provides a iterator for the all of the ontology's properties.

Returns:
An iterator over all the ontology's properties

properties

public java.util.Iterator properties(OGResource aType)
Provides a iterator for only the ontology's properties of the provided type.

Parameters:
aType - The type of properties to include in the iterator.
Returns:
An iterator over some of the ontology's properties.

getProperties

public java.util.Collection getProperties(OGResource aType)
Provides a Collection of the ontology's properties of the provided type.

Parameters:
aType - The type of properties to include in the iterator.
Returns:
A collection of some of the ontology's properties.

lookupLiteral

public OGLiteral lookupLiteral(java.lang.Object theID)
Looks for a matching literal in this ontology. Searches this onlology and all imported ontologies for a literal whose ID matches the provided ID.

Parameters:
theID - The ID of the sought literal.
Returns:
The matching literal if found, otherwise returns void.

lookupLiteral

public OGLiteral lookupLiteral(java.lang.Object theID,
                               boolean pCreate)
Looks for, and possibilly creates, a literal in this ontology. Searches this onlology and all imported ontologies for a literal whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists.

Parameters:
theID - The ID of the sought literal.
pCreate - true causes a new instance to be created if no existing match is found.
Returns:
The matching literal if found or created, otherwise returns void.

createLiteral

public OGLiteral createLiteral()
Creates a Literal in this ontology with a generated unique ID and adds the Literal to the ontology.

Returns:
The matching Literal created, otherwise returns void.

createLiteral

public OGLiteral createLiteral(java.lang.String theID)
Looks for, and possibilly creates, a Literal in this ontology. Searches this onlology and all imported ontologies for a Literal whose ID matches the provided value. May create a new instance with the appropriate ID in this ontology if none exists. The Literal if new is added to the Ontology.

Parameters:
theID - The ID of the new Literal.
Returns:
The matching Literal if found or created, otherwise returns void.

createLiteralByValue

public OGLiteral createLiteralByValue(java.lang.String theValue)
Looks for, and possibilly creates, a Literal in this ontology. Uses the OGLiteral genID method to create the ID for the provided value, then searches this onlology and all imported ontologies for a Literal whose ID matches. May create a new instance with the appropriate ID in this ontology if none exists and set its value. The Literal if new is added to the Ontology.

Parameters:
theValue - The value of the new Literal.
Returns:
The matching Literal if found or created, otherwise returns void.

createLiteral

public OGLiteral createLiteral(OGResource aType)
Creates a Literal in this ontology with a generated unique ID, sets the Clases type to the passed in type and adds the Literal to the ontology.

Parameters:
aType - The type of the new Literal.
Returns:
The matching Literal created, otherwise returns void.

createLiteralByValue

public OGLiteral createLiteralByValue(OGResource aType,
                                      java.lang.String theID)
Looks for, and possibilly creates, a Literal in this ontology. Uses the OGLiteral genID method to create the ID for the provided value, then searches this onlology and all imported ontologies for a Literal whose ID matches. May create a new instance with the appropriate ID and type in this ontology if none exists and sets its value. The Literal if new is added to the Ontology.

Parameters:
aType - The type of the new Literal.
Returns:
The matching Literal if found or created, otherwise returns void.

createLiteral

public OGLiteral createLiteral(OGResource aType,
                               java.lang.String theID)
Looks for, and possibilly creates, a Literal in this ontology. Searches this onlology and all imported ontologies for a Literal whose ID matches the provided ID. May create a new instance with the appropriate ID in this ontology if none exists. The Literal if new is added to the Ontology with the type sets to the passed in type.

Parameters:
aType - The type of the new Literal.
theID - The ID of the new Literal.
Returns:
The matching Literal if found or created, otherwise returns void.

addLiteral

public void addLiteral(OGLiteral theLiteral)
Adds the provided literal to the ontology. The provided literal should be added so that it will be included in both literal and resource collections as appropriate.

Parameters:
theLiteral - The literal to add to the ontology.

removeLiteral

public void removeLiteral(OGLiteral theLiteral)
Removes the provided literal from the ontology.

Parameters:
theLiteral - The literal to remove to the ontology.

getLiteral

public OGLiteral getLiteral(java.lang.Object theID)
Looks for a literal in this ontology whose ID matches the provided ID. Differs from lookupLiteral in that the imports are not searched.

Parameters:
theID - The ID of the sought literal.
Returns:
The matching literal if found, otherwise returns void.

containsLiteral

public boolean containsLiteral(java.lang.Object theID)
Looks for a literal in this ontology whose ID matches the provided ID. The literal must be in this ontology, not in its imports.

Parameters:
theID - The ID of the sought literal.
Returns:
true if the literal exists in this ontology.

literals

public java.util.Iterator literals()
Provides a iterator for the all of the ontology's literals.

Returns:
An iterator over all the ontology's literals.

literals

public java.util.Iterator literals(OGResource aType)
Provides a iterator for only the ontology's literals of the provided type.

Parameters:
aType - The type of literals to include in the iterator.
Returns:
An iterator over some of the ontology's literals.

getLiterals

public java.util.Collection getLiterals(OGResource aType)
Provides a Collection of the ontology's literals of the provided type.

Parameters:
aType - The type of literals to include in the iterator.
Returns:
A collection of some of the ontology's literals.

lookupImport

public OGOntology lookupImport(java.lang.Object theID)
Looks for an imported ontology by ID. Searches this onlology's imports recursively for an imported ontology whose ID matches the provided ID.

Parameters:
theID - The ID of the sought ontology.
Returns:
The matching ontology if found, otherwise returns void.

addImport

public void addImport(OGOntology theImport)
Adds the provided ontology to the ontology's imports. *

Parameters:
theImport - The ontology to add to the imports.

removeImport

public void removeImport(OGOntology theImport)
Removes the provided ontology from the ontology's imports.

Parameters:
theImport - The ontology to remove from the imports.

getImport

public OGOntology getImport(java.lang.Object theID)
Looks for an imported ontology in this ontology whose ID matches the provided ID. Differs from lookupimport in that the imports are not searched recursively.

Parameters:
theID - The ID of the sought ontology.
Returns:
The matching ontology if found, otherwise returns void.

getImports

public OGOntology[] getImports()
Accessor for the read only indexed bean property, "imports"

Returns:
The imported ontologies of this resources as an array.

containsImport

public boolean containsImport(java.lang.Object theID)
Looks for an imported ontology in this ontology whose ID matches the provided ID. The ontology must be in this ontologies imports. Imports are not searched recursively.

Parameters:
theID - The ID of the sought ontology.
Returns:
true if the ontology exists in the imports.

imports

public java.util.Iterator imports()
Provides a iterator for the all of the ontology's imports. Only this ontology's imports are included.

Returns:
An iterator over all the ontology's imports.

addResource

public void addResource(OGResource theResource)
Adds the provided resource to the ontology. The provided resource should be added so that it will be included in collections as appropriate.

Parameters:
theResource - The resource to add to the ontology.

removeResource

public void removeResource(OGResource theResource)
Removes the provided resource from the ontology.

Parameters:
theResource - The resource removed from the ontology.

lookupResource

public OGResource lookupResource(java.lang.Object theID)
Looks for a matching resource in this ontology. Searches this onlology and all imported ontologies for a resource whose ID matches the provided ID. Resources are added an removed only throught the specific class, property, liertal mehtods.

Parameters:
theID - The ID of the sought resource.
Returns:
The matching resource if found, otherwise returns void.

getResource

public OGResource getResource(java.lang.Object theID)
Looks for a resource in this ontology whose ID matches the provided ID. Resources are added an removed only throught the specific class, property, liertal mehtods.

Parameters:
theID - The ID of the sought resource.
Returns:
The matching class if found, otherwise returns void.

containsResource

public boolean containsResource(java.lang.Object theID)
Looks for a resource in this ontology whose ID matches the provided ID. The resource must be in this ontology, not in its imports.

Parameters:
theID - The ID of the sought resource.
Returns:
true if the resource exists in this ontology.

resources

public java.util.Iterator resources()
Provides a iterator for the all of the ontology's resources.

Returns:
An iterator over all the ontology's resources.

resources

public java.util.Iterator resources(OGResource aType)
Provides a iterator for only the ontology's resources of the provided type.

Parameters:
aType - The type of resources to include in the iterator.
Returns:
An iterator over some of the ontology's resources.

getResources

public java.util.Collection getResources(OGResource aType)
Provides a Collection of the ontology's resources of the provided type.

Parameters:
aType - The type of resources to include in the iterator.
Returns:
A collection of some of the ontology's resources.


CODIP AT&T Government Solutions, Inc.