com.att.gs.codip.ograph.imp
Class OGOntologyImp

java.lang.Object
  |
  +--com.att.gs.codip.resource.AbstractResource
        |
        +--com.att.gs.codip.ograph.imp.OGResourceImp
              |
              +--com.att.gs.codip.ograph.imp.OGOntologyImp
All Implemented Interfaces:
LogicalResource, OGOntology, OGResource
Direct Known Subclasses:
OGVirtualOntologyImp

public class OGOntologyImp
extends OGResourceImp
implements OGOntology

Ontology Graph


Field Summary
protected  java.lang.String applyToImports_XSLTURI
           
protected  java.util.Map classes
           
protected  java.util.Map datatypes
           
protected  java.util.Map imports
           
protected  java.util.Map literals
           
protected  java.util.Map properties
           
protected  java.util.Map resources
           
 
Fields inherited from class com.att.gs.codip.ograph.imp.OGResourceImp
EMPTY_MAP
 
Fields inherited from class com.att.gs.codip.resource.AbstractResource
delineatedType, isSingleTyped
 
Constructor Summary
protected OGOntologyImp()
          Creators and Initializers
  OGOntologyImp(java.lang.String theURI)
           
  OGOntologyImp(java.lang.String theURI, java.util.Comparator theComptor)
           
  OGOntologyImp(java.lang.String theURI, int classSize, int propertySize, int literalSize)
           
 
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.
 void copySubOntology(OGResource subject, OGOntologyImp subOnto)
          Utility/Display/Debug Methods.
 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 theValue)
          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)
          Collection Access Methods.
 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 theURI)
          Use this method to convert an Ontology to a new URI
protected  void morphID(java.lang.String theURI)
           
 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)
          Simple Access Methods.
 void setVersionInfo(java.lang.String theVersionInfo)
          Setter method for the version information of this ontology.
 
Methods inherited from class com.att.gs.codip.ograph.imp.OGResourceImp
addNewPropInstance, addPropInstance, addType, containsPropInstance, containsType, copyRDF, getComment, getLabel, getOntology, getPropInstance, getPropInstances, getPropInstances, isType, lookupPropInstance, propInstances, propInstances, removePropInstance, removeType, resourceInitialization, setComment, setLabel, setType, toString, types
 
Methods inherited from class com.att.gs.codip.resource.AbstractResource
equals, getID, getLocalName, getNamespace, getType, getURI, isLiteralType, isType, resourceInitialization, setID, setLocalName, setNamespace, setType, setURI
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
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
 

Field Detail

classes

protected java.util.Map classes

properties

protected java.util.Map properties

literals

protected java.util.Map literals

datatypes

protected java.util.Map datatypes

imports

protected java.util.Map imports

resources

protected java.util.Map resources

applyToImports_XSLTURI

protected java.lang.String applyToImports_XSLTURI
Constructor Detail

OGOntologyImp

protected OGOntologyImp()
Creators and Initializers


OGOntologyImp

public OGOntologyImp(java.lang.String theURI)

OGOntologyImp

public OGOntologyImp(java.lang.String theURI,
                     int classSize,
                     int propertySize,
                     int literalSize)

OGOntologyImp

public OGOntologyImp(java.lang.String theURI,
                     java.util.Comparator theComptor)
Method Detail

morphID

protected void morphID(java.lang.String theURI)
Overrides:
morphID in class OGResourceImp

morph

public void morph(java.lang.String theURI)
Description copied from interface: OGOntology
Use this method to convert an Ontology to a new URI

Specified by:
morph in interface OGOntology

setSourceURI

public void setSourceURI(java.lang.String theSourceURI)
Simple Access Methods.

Specified by:
setSourceURI in interface OGOntology
Parameters:
theSourceURI - The source URI String.

getSourceURI

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

Specified by:
getSourceURI in interface OGOntology
Returns:
The source URI String.

setVersionInfo

public void setVersionInfo(java.lang.String theVersionInfo)
Description copied from interface: OGOntology
Setter method for the version information of this ontology.

Specified by:
setVersionInfo in interface OGOntology
Parameters:
theVersionInfo - The version information String.

getVersionInfo

public java.lang.String getVersionInfo()
Description copied from interface: OGOntology
Getter method for the version information of this ontology.

Specified by:
getVersionInfo in interface OGOntology
Returns:
The version information String.

lookupClass

public OGClass lookupClass(java.lang.Object theID)
Collection Access Methods.

Specified by:
lookupClass in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
lookupClass in interface OGOntology
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()
Description copied from interface: OGOntology
Creates a Class in this ontology with a generated unique ID and adds the Class to the ontology.

Specified by:
createClass in interface OGOntology
Returns:
The matching class created, otherwise returns void.

createClass

public OGClass createClass(java.lang.String theID)
Description copied from interface: OGOntology
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.

Specified by:
createClass in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createClass in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createClass in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
addClass in interface OGOntology
Parameters:
theClass - The class to add to the ontology.

removeClass

public void removeClass(OGClass theClass)
Description copied from interface: OGOntology
Removes the provided class from the ontology.

Specified by:
removeClass in interface OGOntology
Parameters:
theClass - The class to remove to the ontology.

getClass

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

Specified by:
getClass in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
containsClass in interface OGOntology
Parameters:
theID - The ID of the sought class.
Returns:
true if the class exists in this ontology.

classes

public java.util.Iterator classes()
Description copied from interface: OGOntology
Provides a iterator for the all of the ontology's classes.

Specified by:
classes in interface OGOntology
Returns:
An iterator over all the ontology's classes.

classes

public java.util.Iterator classes(OGResource aType)
Description copied from interface: OGOntology
Provides a iterator for only the ontology's classes of the provided type.

Specified by:
classes in interface OGOntology
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)
Description copied from interface: OGOntology
Provides a Collection of the ontology's classes of the provided type.

Specified by:
getClasses in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
lookupDatatype in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
lookupDatatype in interface OGOntology
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()
Description copied from interface: OGOntology
Creates a Datatype in this ontology with a generated unique ID and adds the Datatype to the ontology.

Specified by:
createDatatype in interface OGOntology
Returns:
The matching Datatype created, otherwise returns void.

createDatatype

public OGDatatype createDatatype(java.lang.String theID)
Description copied from interface: OGOntology
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.

Specified by:
createDatatype in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createDatatype in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createDatatype in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
addDatatype in interface OGOntology
Parameters:
theDatatype - The data type to add to the ontology.

removeDatatype

public void removeDatatype(OGDatatype theDatatype)
Description copied from interface: OGOntology
Removes the provided data type from the ontology.

Specified by:
removeDatatype in interface OGOntology
Parameters:
theDatatype - The data type to remove to the ontology.

getDatatype

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

Specified by:
getDatatype in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
containsDatatype in interface OGOntology
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()
Description copied from interface: OGOntology
Provides a iterator for the all of the ontology's data types.

Specified by:
datatypes in interface OGOntology
Returns:
An iterator over all the ontology's data types.

datatypes

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

Specified by:
datatypes in interface OGOntology
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)
Description copied from interface: OGOntology
Provides a Collection of the ontology's data types of the provided type.

Specified by:
getDatatypes in interface OGOntology
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)
Description copied from interface: OGOntology
Looks for a matching property in this ontology. Searches this onlology and all imported ontologies for a property whose ID matches the provided ID.

Specified by:
lookupProperty in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
lookupProperty in interface OGOntology
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()
Description copied from interface: OGOntology
Creates a Property in this ontology with a generated unique ID and adds the Property to the ontology.

Specified by:
createProperty in interface OGOntology
Returns:
The matching Property created, otherwise returns void.

createProperty

public OGProperty createProperty(java.lang.String theID)
Description copied from interface: OGOntology
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.

Specified by:
createProperty in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createProperty in interface OGOntology
Parameters:
aType - The type of the new Property.
Returns:
The matching Property created, otherwise returns void.

createPropInstance

public OGPropInstance createPropInstance(OGResource aType)
Description copied from interface: OGOntology
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.

Specified by:
createPropInstance in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createPropInstance in interface OGOntology
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.

createProperty

public OGProperty createProperty(OGResource aType,
                                 java.lang.String theID)
Description copied from interface: OGOntology
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.

Specified by:
createProperty in interface OGOntology
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.

addProperty

public void addProperty(OGProperty theProperty)
Description copied from interface: OGOntology
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.

Specified by:
addProperty in interface OGOntology
Parameters:
theProperty - The property to add to the ontology.

removeProperty

public void removeProperty(OGProperty theProperty)
Description copied from interface: OGOntology
Removes the provided property from the ontology.

Specified by:
removeProperty in interface OGOntology
Parameters:
theProperty - The property from remove to the ontology.

getProperty

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

Specified by:
getProperty in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
containsProperty in interface OGOntology
Parameters:
theID - The ID of the sought property.
Returns:
true if the property exists in this ontology.

properties

public java.util.Iterator properties()
Description copied from interface: OGOntology
Provides a iterator for the all of the ontology's properties.

Specified by:
properties in interface OGOntology
Returns:
An iterator over all the ontology's properties

properties

public java.util.Iterator properties(OGResource aType)
Description copied from interface: OGOntology
Provides a iterator for only the ontology's properties of the provided type.

Specified by:
properties in interface OGOntology
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)
Description copied from interface: OGOntology
Provides a Collection of the ontology's properties of the provided type.

Specified by:
getProperties in interface OGOntology
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)
Description copied from interface: OGOntology
Looks for a matching literal in this ontology. Searches this onlology and all imported ontologies for a literal whose ID matches the provided ID.

Specified by:
lookupLiteral in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
lookupLiteral in interface OGOntology
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()
Description copied from interface: OGOntology
Creates a Literal in this ontology with a generated unique ID and adds the Literal to the ontology.

Specified by:
createLiteral in interface OGOntology
Returns:
The matching Literal created, otherwise returns void.

createLiteralByValue

public OGLiteral createLiteralByValue(java.lang.String theValue)
Description copied from interface: OGOntology
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.

Specified by:
createLiteralByValue in interface OGOntology
Parameters:
theValue - The value of the new Literal.
Returns:
The matching Literal if found or created, otherwise returns void.

createLiteral

public OGLiteral createLiteral(java.lang.String theID)
Description copied from interface: OGOntology
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.

Specified by:
createLiteral in interface OGOntology
Parameters:
theID - The ID of the new Literal.
Returns:
The matching Literal if found or created, otherwise returns void.

createLiteral

public OGLiteral createLiteral(OGResource aType)
Description copied from interface: OGOntology
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.

Specified by:
createLiteral in interface OGOntology
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 theValue)
Description copied from interface: OGOntology
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.

Specified by:
createLiteralByValue in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
createLiteral in interface OGOntology
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)
Description copied from interface: OGOntology
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.

Specified by:
addLiteral in interface OGOntology
Parameters:
theLiteral - The literal to add to the ontology.

removeLiteral

public void removeLiteral(OGLiteral theLiteral)
Description copied from interface: OGOntology
Removes the provided literal from the ontology.

Specified by:
removeLiteral in interface OGOntology
Parameters:
theLiteral - The literal to remove to the ontology.

getLiteral

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

Specified by:
getLiteral in interface OGOntology
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)
Description copied from interface: OGOntology
Looks for a literal in this ontology whose ID matches the provided ID. The literal must be in this ontology, not in its imports.

Specified by:
containsLiteral in interface OGOntology
Parameters:
theID - The ID of the sought literal.
Returns:
true if the literal exists in this ontology.

literals

public java.util.Iterator literals()
Description copied from interface: OGOntology
Provides a iterator for the all of the ontology's literals.

Specified by:
literals in interface OGOntology
Returns:
An iterator over all the ontology's literals.

literals

public java.util.Iterator literals(OGResource aType)
Description copied from interface: OGOntology
Provides a iterator for only the ontology's literals of the provided type.

Specified by:
literals in interface OGOntology
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)
Description copied from interface: OGOntology
Provides a Collection of the ontology's literals of the provided type.

Specified by:
getLiterals in interface OGOntology
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)
Description copied from interface: OGOntology
Looks for an imported ontology by ID. Searches this onlology's imports recursively for an imported ontology whose ID matches the provided ID.

Specified by:
lookupImport in interface OGOntology
Parameters:
theID - The ID of the sought ontology.
Returns:
The matching ontology if found, otherwise returns void.

addImport

public void addImport(OGOntology theImport)
Description copied from interface: OGOntology
Adds the provided ontology to the ontology's imports. *

Specified by:
addImport in interface OGOntology
Parameters:
theImport - The ontology to add to the imports.

removeImport

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

Specified by:
removeImport in interface OGOntology
Parameters:
theImport - The ontology to remove from the imports.

getImport

public OGOntology getImport(java.lang.Object theID)
Description copied from interface: OGOntology
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.

Specified by:
getImport in interface OGOntology
Parameters:
theID - The ID of the sought ontology.
Returns:
The matching ontology if found, otherwise returns void.

getImports

public OGOntology[] getImports()
Description copied from interface: OGOntology
Accessor for the read only indexed bean property, "imports"

Specified by:
getImports in interface OGOntology
Returns:
The imported ontologies of this resources as an array.

containsImport

public boolean containsImport(java.lang.Object theID)
Description copied from interface: OGOntology
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.

Specified by:
containsImport in interface OGOntology
Parameters:
theID - The ID of the sought ontology.
Returns:
true if the ontology exists in the imports.

imports

public java.util.Iterator imports()
Description copied from interface: OGOntology
Provides a iterator for the all of the ontology's imports. Only this ontology's imports are included.

Specified by:
imports in interface OGOntology
Returns:
An iterator over all the ontology's imports.

lookupResource

public OGResource lookupResource(java.lang.Object theID)
Description copied from interface: OGOntology
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.

Specified by:
lookupResource in interface OGOntology
Parameters:
theID - The ID of the sought resource.
Returns:
The matching resource if found, otherwise returns void.

addResource

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

Specified by:
addResource in interface OGOntology
Parameters:
theResource - The resource to add to the ontology.

removeResource

public void removeResource(OGResource theResource)
Description copied from interface: OGOntology
Removes the provided resource from the ontology.

Specified by:
removeResource in interface OGOntology
Parameters:
theResource - The resource removed from the ontology.

getResource

public OGResource getResource(java.lang.Object theID)
Description copied from interface: OGOntology
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.

Specified by:
getResource in interface OGOntology
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)
Description copied from interface: OGOntology
Looks for a resource in this ontology whose ID matches the provided ID. The resource must be in this ontology, not in its imports.

Specified by:
containsResource in interface OGOntology
Parameters:
theID - The ID of the sought resource.
Returns:
true if the resource exists in this ontology.

resources

public java.util.Iterator resources()
Description copied from interface: OGOntology
Provides a iterator for the all of the ontology's resources.

Specified by:
resources in interface OGOntology
Returns:
An iterator over all the ontology's resources.

resources

public java.util.Iterator resources(OGResource aType)
Description copied from interface: OGOntology
Provides a iterator for only the ontology's resources of the provided type.

Specified by:
resources in interface OGOntology
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)
Description copied from interface: OGOntology
Provides a Collection of the ontology's resources of the provided type.

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

copySubOntology

public void copySubOntology(OGResource subject,
                            OGOntologyImp subOnto)
Utility/Display/Debug Methods. /************************* Graph related Utility Methods.



CODIP AT&T Government Solutions, Inc.