com.ge.research.sadl.server

Interface ISadlServerPE

All Superinterfaces:

ISadlServer

All Known Subinterfaces:

ISadlServerMD

All Known Implementing Classes:

SadlServerMDImpl, SadlServerPEImpl

public interface ISadlServerPE
extends ISadlServer

This Interface class defines additional methods beyond those in the superclass SadlServer. These methods support editing of models and the persistence of changes/additions to models. P--persistence E--editing => SadlServerPE

Author:

Andy Crapo

Method Summary

Modifier and Type	Method and Description
boolean	addAllValuesFromRestriction(java.lang.String modelName, java.lang.String className, java.lang.String propertyName, java.lang.String restrictionName) Call this method to restrict the values of a object property on a class to instances from a particular class in the named model.
boolean	addCardinalityRestriction(java.lang.String modelName, java.lang.String className, java.lang.String propertyName, int cardValue) Call this method to add a cardinality restriction to a property on a class in the named model.
boolean	addClass(java.lang.String modelName, java.lang.String className, java.lang.String superClassName) Call this method to create a new class in the specified named model
boolean	addExistingModel(java.lang.String modelPublicUri, java.lang.String modelAltUrl, java.lang.String modelPrefix) Call this method to create a new mapping to the specified existing model.
boolean	addHasValueRestriction(java.lang.String modelName, java.lang.String className, java.lang.String propertyName, java.lang.String valueInstanceName) Call this method to add to restrict an object property on a class to a particular value in the named model.
boolean	addImport(java.lang.String modelName, java.lang.String importedModelUri) Call this model to add an import to the named model.
boolean	addInstance(java.lang.String modelName, java.lang.String instName, java.lang.String className) Call this method to create a new instance of the specified class in the named model.
boolean	addMaxCardinalityRestriction(java.lang.String modelName, java.lang.String className, java.lang.String propertyName, int cardValue) Call this method to add a max cardinality restriction to a property on a class in the named model.
boolean	addMinCardinalityRestriction(java.lang.String modelName, java.lang.String className, java.lang.String propertyName, int cardValue) Call this method to add a min cardinality restriction to a property on a class in the named model.
boolean	addObjectPropertyRangeClass(java.lang.String modelName, java.lang.String propertyName, java.lang.String rangeClassName) Call this method to add a class to the range of an object property in the named model.
boolean	addOntProperty(java.lang.String modelName, java.lang.String propertyName, java.lang.String superPropertyName) Call this method to create a new ontology property, either ObjectProperty or DatatypeProperty, in the named model.
boolean	addOntPropertyDomainClass(java.lang.String modelName, java.lang.String propertyName, java.lang.String domainClassName) Call this method to add a class to the domain of a property in the named model.
boolean	addRule(java.lang.String modelName, java.lang.String ruleAsString) Call this method to add a rule to the specified model
boolean	addSomeValuesFromRestriction(java.lang.String modelName, java.lang.String className, java.lang.String propertyName, java.lang.String restrictionName) Call this method to require that the values of a object property on a class include instances from a particular class in the named model.
boolean	addTriple(java.lang.String modelName, java.lang.String subject, java.lang.String predicate, java.lang.Object value) Call this method to add the specified triple to the specified existing model.
com.ge.research.sadl.reasoner.ResultSet	ask(java.lang.String modelName, java.lang.String subjName, java.lang.String propName, java.lang.Object objValue) This method retrieves the results of an RDF triple matching request as a list of matching statements.
java.lang.String	createInstance(java.lang.String modelName, java.lang.String name, java.lang.String className) This method creates a new Individual of the class identified in the specified named model.
boolean	createServiceModel(java.lang.String kbid, java.lang.String serviceName, java.lang.String modelName, java.lang.String owlFileName, java.lang.String prefix) Call this method to create a new named service with the specified new model name and global prefix to be saved to the specified OWL file in the specified kbase.
boolean	deleteModel(java.lang.String modelName) Call this method to delete a model from the knowledge base.
boolean	deleteTriple(java.lang.String modelName, java.lang.String subject, java.lang.String predicate, java.lang.Object value) Call this method to delete the specified triple from the specified existing model.
java.util.List<com.ge.research.sadl.reasoner.ModelError>	getErrors() Call this method to retrieve the errors that have been accumulated.
java.lang.String	getUniqueInstanceUri(java.lang.String namespace, java.lang.String baseLocalName) Call this method to obtain a unique unused URI based on the namespace and baseLocalName provided.
java.lang.String	getUniqueInstanceUri(java.lang.String modelName, java.lang.String namespace, java.lang.String baseLocalName) Call this method to obtain a unique unused URI based on the namespace and baseLocalName provided.
java.lang.String	getUniqueNamespaceUri(java.lang.String baseNamespace) Call this method to obtain a unique unused namespace URI based on the base namespace provided.
boolean	persistChangesToServiceModels() Call this method to persist any changes that have been made to the service model or to any of the models that it imports.
boolean	persistInstanceModel(java.lang.String owlInstanceFileName, java.lang.String globalPrefix) Call this method to persist the instance data which has been added during this session as model on the server.
boolean	persistInstanceModel(java.lang.String modelName, java.lang.String owlInstanceFileName, java.lang.String globalPrefix) Call this method to persist the instance data which has been added during this session as model on the server with the specified model URI.
com.ge.research.sadl.reasoner.ResultSet	query(java.lang.String modelName, java.lang.String query) This method retrieves the results of a kbase query as a List array, 1st element being a List of the column headings and second being a List of rows, each of which is a List of values.
boolean	setDatatypePropertyRange(java.lang.String modelName, java.lang.String propertyName, java.lang.String xsdRange) Call this method to set the range of a datatype property in the named model.
boolean	updateRdfsLabel(java.lang.String uri, java.lang.String label, java.lang.String language) Method to add or update the rdfs:label for the ontology Resource identified by uri and of the specified language
boolean	updateRdfsLabel(java.lang.String modelName, java.lang.String uri, java.lang.String label, java.lang.String language) Method to add or update the rdfs:label for the ontology Resource identified by uri and of the specified language

Methods inherited from interface com.ge.research.sadl.server.ISadlServer

addTriple, ask, atomicQuery, atomicQueryCsvData, clearCache, collectTimingInformation, construct, createInstance, deleteTriple, getClassName, getDerivations, getInstanceDataNamespace, getInstanceModelName, getKBaseIdentifier, getKbaseRoot, getModelName, getReasonerVersion, getServiceNameMap, getServiceVersion, getTimingInformation, loadCsvData, loadData, parameterizeQuery, prepareQuery, query, reset, selectServiceModel, selectServiceModel, selectServiceModel, selectServiceModel, sendCsvData, sendData, sendData, setInstanceDataNamespace, setKbaseRoot, setOwlFileOutputFormat, setQueryTimeout, setServiceNameMap

Method Detail

persistInstanceModel

boolean persistInstanceModel(java.lang.String owlInstanceFileName,
                             java.lang.String globalPrefix)
                      throws com.ge.research.sadl.reasoner.ConfigurationException,
                             SessionNotFoundException,
                             java.io.IOException

Call this method to persist the instance data which has been added during this session as model on the server.

Parameters:

owlInstanceFileName - File name containing instance in OWL format. For absolute paths use "file:///"

globalPrefix - Global prefix (must be unique in the knowledge base)

Returns:

True if successful else false

Throws:

com.ge.research.sadl.server.ConfigurationException

SessionNotFoundException

java.io.IOException

com.ge.research.sadl.reasoner.ConfigurationException

persistInstanceModel

boolean persistInstanceModel(java.lang.String modelName,
                             java.lang.String owlInstanceFileName,
                             java.lang.String globalPrefix)
                      throws com.ge.research.sadl.reasoner.ConfigurationException,
                             SessionNotFoundException,
                             java.io.IOException

Call this method to persist the instance data which has been added during this session as model on the server with the specified model URI. (This is like a "save as".) Issue: are the URI's of all instances in the default instance namespace changed to this namespace??

Parameters:

modelName - Model name

owlInstanceFileName - File name containing instance in OWL format

globalPrefix - Global prefix

Returns:

True if successful else false

Throws:

com.ge.research.sadl.server.ConfigurationException

SessionNotFoundException

java.io.IOException

com.ge.research.sadl.reasoner.ConfigurationException

persistChangesToServiceModels

boolean persistChangesToServiceModels()
                               throws SessionNotFoundException

Call this method to persist any changes that have been made to the service model or to any of the models that it imports.

Returns:

True if successful else false

Throws:

SessionNotFoundException

getErrors

java.util.List<com.ge.research.sadl.reasoner.ModelError> getErrors()
                                                            throws SessionNotFoundException

Call this method to retrieve the errors that have been accumulated. Note that calling this method clears the errors--a second immediate call will return no errors.

Returns:

List of errors since last call or null if none

Throws:

SessionNotFoundException

addTriple

boolean addTriple(java.lang.String modelName,
                  java.lang.String subject,
                  java.lang.String predicate,
                  java.lang.Object value)
           throws com.ge.research.sadl.reasoner.ConfigurationException,
                  com.ge.research.sadl.reasoner.TripleNotFoundException,
                  com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                  SessionNotFoundException

Call this method to add the specified triple to the specified existing model.

Parameters:

modelName - Model name

subject - Subject

predicate - Predicate

value - Object value

Returns:

True if operation was successful, false otherwise

Throws:

com.ge.research.sadl.server.ConfigurationException

com.ge.research.sadl.server.ReasonerNotFoundException

com.ge.research.sadl.server.TripleNotFoundException

SessionNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.TripleNotFoundException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

createInstance

java.lang.String createInstance(java.lang.String modelName,
                                java.lang.String name,
                                java.lang.String className)
                         throws com.ge.research.sadl.reasoner.ConfigurationException,
                                com.ge.research.sadl.reasoner.InvalidNameException,
                                SessionNotFoundException,
                                java.io.IOException

This method creates a new Individual of the class identified in the specified named model.

Parameters:

modelName - Model name

name - -- the name of the new instance to be created or null to create a blank node

className - -- the name of the OntClass to which the new Individual will belong

Returns:

-- the identity of the new Individual; the fully qualified name for a named resource, the AnodeId as a string for a blank node

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.InvalidNameException

SessionNotFoundException

java.io.IOException

deleteTriple

boolean deleteTriple(java.lang.String modelName,
                     java.lang.String subject,
                     java.lang.String predicate,
                     java.lang.Object value)
              throws com.ge.research.sadl.reasoner.ConfigurationException,
                     com.ge.research.sadl.reasoner.TripleNotFoundException,
                     com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                     SessionNotFoundException

Call this method to delete the specified triple from the specified existing model.

Parameters:

modelName - Model name

subject - Subject

predicate - Predicate

value - Object value

Returns:

True if operation was successful, false otherwise

Throws:

com.ge.research.sadl.server.ConfigurationException

com.ge.research.sadl.server.ReasonerNotFoundException

com.ge.research.sadl.server.TripleNotFoundException

SessionNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.TripleNotFoundException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

addClass

boolean addClass(java.lang.String modelName,
                 java.lang.String className,
                 java.lang.String superClassName)
          throws SessionNotFoundException,
                 com.ge.research.sadl.reasoner.InvalidNameException

Call this method to create a new class in the specified named model

Parameters:

modelName - Model name

className - Class name or null if none

superClassName - Super class name or null if none

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

getUniqueInstanceUri

java.lang.String getUniqueInstanceUri(java.lang.String namespace,
                                      java.lang.String baseLocalName)
                               throws com.ge.research.sadl.reasoner.InvalidNameException,
                                      SessionNotFoundException

Call this method to obtain a unique unused URI based on the namespace and baseLocalName provided. If the baseLocalName ends in a series of digits (a number), then this number becomes the starting counter value. If not, the counter starts at 1 and is appended to the name provided. The counter is incremented by 1 until a URI is generated that is not used for a ontology resource in the named model. This URI is then returned as a string.

Parameters:

namespace - -- namespace of the new URI

baseLocalName - -- local fragment base of the URI

Returns:

-- a unique URI with the namespace and base fragment augmented to make it unique

Throws:

SessionNotFoundException

com.ge.research.sadl.server.InvalidNameException

com.ge.research.sadl.reasoner.InvalidNameException

getUniqueInstanceUri

java.lang.String getUniqueInstanceUri(java.lang.String modelName,
                                      java.lang.String namespace,
                                      java.lang.String baseLocalName)
                               throws com.ge.research.sadl.reasoner.InvalidNameException,
                                      SessionNotFoundException

Call this method to obtain a unique unused URI based on the namespace and baseLocalName provided. If the baseLocalName ends in a series of digits (a number), then this number becomes the starting counter value. If not, the counter starts at 1 and is appended to the name provided. The counter is incremented by 1 until a URI is generated that is not used for a ontology resource in the named model. This URI is then returned as a string.

Parameters:

modelName - Model name

namespace - -- namespace of the new URI

baseLocalName - -- local fragment base of the URI

Returns:

-- a unique URI with the namespace and base fragment augmented to make it unique

Throws:

SessionNotFoundException

com.ge.research.sadl.server.InvalidNameException

com.ge.research.sadl.reasoner.InvalidNameException

getUniqueNamespaceUri

java.lang.String getUniqueNamespaceUri(java.lang.String baseNamespace)
                                throws com.ge.research.sadl.reasoner.InvalidNameException,
                                       SessionNotFoundException,
                                       java.net.MalformedURLException,
                                       com.ge.research.sadl.reasoner.ConfigurationException

Call this method to obtain a unique unused namespace URI based on the base namespace provided. If the base namespace ends in a series of digits (a number), then this number becomes the starting counter value. If not, the counter starts at 1 and is appended to the name provided. The counter is incremented by 1 until a URI is generated that is not used for an ontology in the knowledge base. This URI is then returned as a string.

Parameters:

baseNamespace - -- base namespace of the new URI

Returns:

-- a unique namespace URI with base namespace augmented to make it unique

Throws:

SessionNotFoundException

com.ge.research.sadl.server.InvalidNameException

com.ge.research.sadl.reasoner.ConfigurationException

java.net.MalformedURLException

com.ge.research.sadl.reasoner.InvalidNameException

addInstance

boolean addInstance(java.lang.String modelName,
                    java.lang.String instName,
                    java.lang.String className)
             throws com.ge.research.sadl.reasoner.ConfigurationException,
                    com.ge.research.sadl.reasoner.InvalidNameException,
                    SessionNotFoundException

Call this method to create a new instance of the specified class in the named model.

Parameters:

modelName - Model name

instName - Instance name

className - Class name or null if none

Returns:

True if successful else false

Throws:

com.ge.research.sadl.server.ConfigurationException

SessionNotFoundException

com.ge.research.sadl.server.InvalidNameException

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.InvalidNameException

addOntProperty

boolean addOntProperty(java.lang.String modelName,
                       java.lang.String propertyName,
                       java.lang.String superPropertyName)
                throws SessionNotFoundException,
                       com.ge.research.sadl.reasoner.InvalidNameException

Call this method to create a new ontology property, either ObjectProperty or DatatypeProperty, in the named model.

Parameters:

modelName - Model name

propertyName - Property name

superPropertyName - Super property name

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addMaxCardinalityRestriction

boolean addMaxCardinalityRestriction(java.lang.String modelName,
                                     java.lang.String className,
                                     java.lang.String propertyName,
                                     int cardValue)
                              throws SessionNotFoundException,
                                     com.ge.research.sadl.reasoner.InvalidNameException

Call this method to add a max cardinality restriction to a property on a class in the named model.

Parameters:

modelName - Model name

className - Class name

propertyName - Property name

cardValue - Cardinality value

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addMinCardinalityRestriction

boolean addMinCardinalityRestriction(java.lang.String modelName,
                                     java.lang.String className,
                                     java.lang.String propertyName,
                                     int cardValue)
                              throws SessionNotFoundException,
                                     com.ge.research.sadl.reasoner.InvalidNameException

Call this method to add a min cardinality restriction to a property on a class in the named model.

Parameters:

modelName - Model name

className - Class name

propertyName - Property name

cardValue - Cardinality value

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addCardinalityRestriction

boolean addCardinalityRestriction(java.lang.String modelName,
                                  java.lang.String className,
                                  java.lang.String propertyName,
                                  int cardValue)
                           throws SessionNotFoundException,
                                  com.ge.research.sadl.reasoner.InvalidNameException

Call this method to add a cardinality restriction to a property on a class in the named model.

Parameters:

modelName - Model name

className - Class name

propertyName - Property name

cardValue - Cardinality value

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addHasValueRestriction

boolean addHasValueRestriction(java.lang.String modelName,
                               java.lang.String className,
                               java.lang.String propertyName,
                               java.lang.String valueInstanceName)
                        throws SessionNotFoundException,
                               com.ge.research.sadl.reasoner.InvalidNameException

Call this method to add to restrict an object property on a class to a particular value in the named model.

Parameters:

modelName - Model name

className - Class name

propertyName - Property name

valueInstanceName - Value instance name

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addSomeValuesFromRestriction

boolean addSomeValuesFromRestriction(java.lang.String modelName,
                                     java.lang.String className,
                                     java.lang.String propertyName,
                                     java.lang.String restrictionName)
                              throws SessionNotFoundException,
                                     com.ge.research.sadl.reasoner.InvalidNameException

Call this method to require that the values of a object property on a class include instances from a particular class in the named model.

Parameters:

modelName - Model name

className - Class name

propertyName - Property name

restrictionName - Restriction name

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addAllValuesFromRestriction

boolean addAllValuesFromRestriction(java.lang.String modelName,
                                    java.lang.String className,
                                    java.lang.String propertyName,
                                    java.lang.String restrictionName)
                             throws SessionNotFoundException,
                                    com.ge.research.sadl.reasoner.InvalidNameException

Call this method to restrict the values of a object property on a class to instances from a particular class in the named model.

Parameters:

modelName - Model name

className - Class name

propertyName - Property name

restrictionName - Restriction name

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

createServiceModel

boolean createServiceModel(java.lang.String kbid,
                           java.lang.String serviceName,
                           java.lang.String modelName,
                           java.lang.String owlFileName,
                           java.lang.String prefix)
                    throws SessionNotFoundException

Call this method to create a new named service with the specified new model name and global prefix to be saved to the specified OWL file in the specified kbase.

Parameters:

kbid - Knowledge base identifier

serviceName - Service name

modelName - Model name

owlFileName - OWL file name

prefix - global prefix name

Returns:

True if successful else false

Throws:

SessionNotFoundException

addExistingModel

boolean addExistingModel(java.lang.String modelPublicUri,
                         java.lang.String modelAltUrl,
                         java.lang.String modelPrefix)
                  throws com.ge.research.sadl.reasoner.InvalidNameException,
                         com.ge.research.sadl.reasoner.ConfigurationException,
                         java.io.IOException,
                         java.net.URISyntaxException

Call this method to create a new mapping to the specified existing model. This will allow the model to be queried, imported, and used in the kbase but will not copy the model from its given location. Note that all imported models not in the kbase must also be explicitly added or they cannot be found.

Parameters:

modelPublicUri -

modelAltUrl -

modelPrefix -

Returns:

-- true if successful else false

Throws:

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.reasoner.ConfigurationException

java.net.URISyntaxException

java.io.IOException

addImport

boolean addImport(java.lang.String modelName,
                  java.lang.String importedModelUri)
           throws com.ge.research.sadl.reasoner.ConfigurationException,
                  java.io.IOException,
                  com.ge.research.sadl.reasoner.InvalidNameException,
                  java.net.URISyntaxException

Call this model to add an import to the named model.

Parameters:

modelName -

importedModelUri -

Returns:

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

java.net.URISyntaxException

com.ge.research.sadl.reasoner.InvalidNameException

java.io.IOException

addOntPropertyDomainClass

boolean addOntPropertyDomainClass(java.lang.String modelName,
                                  java.lang.String propertyName,
                                  java.lang.String domainClassName)
                           throws SessionNotFoundException,
                                  com.ge.research.sadl.reasoner.InvalidNameException

Call this method to add a class to the domain of a property in the named model.

Parameters:

modelName - Model name

propertyName - Property name

domainClassName - Domain class name

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addObjectPropertyRangeClass

boolean addObjectPropertyRangeClass(java.lang.String modelName,
                                    java.lang.String propertyName,
                                    java.lang.String rangeClassName)
                             throws SessionNotFoundException,
                                    com.ge.research.sadl.reasoner.InvalidNameException

Call this method to add a class to the range of an object property in the named model.

Parameters:

modelName - Model name

propertyName - Property name

rangeClassName - Range class name

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

setDatatypePropertyRange

boolean setDatatypePropertyRange(java.lang.String modelName,
                                 java.lang.String propertyName,
                                 java.lang.String xsdRange)
                          throws SessionNotFoundException,
                                 com.ge.research.sadl.reasoner.InvalidNameException

Call this method to set the range of a datatype property in the named model.

Parameters:

modelName - Model name

propertyName - Property name

xsdRange - XSD range fragment: string | boolean | decimal | int | long | float | double | duration | dateTime | time | date | gYearMonth | gYear | gMonthDay | gDay | gMonth | hexBinary | base64Binary | anyURI | data

Returns:

True if successful else false

Throws:

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

addRule

boolean addRule(java.lang.String modelName,
                java.lang.String ruleAsString)
         throws com.ge.research.sadl.reasoner.ConfigurationException,
                java.io.IOException,
                SessionNotFoundException

Call this method to add a rule to the specified model

Parameters:

modelName - Model name

ruleAsString - Rule

Returns:

True if successful else false

Throws:

com.ge.research.sadl.server.ConfigurationException

java.io.IOException

SessionNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

deleteModel

boolean deleteModel(java.lang.String modelName)
             throws com.ge.research.sadl.reasoner.ConfigurationException,
                    java.io.IOException,
                    SessionNotFoundException

Call this method to delete a model from the knowledge base. This will clean up mappings and repository to completely and permanently remove the model from the server.

Parameters:

modelName - -- the public URI identifying the model to be deleted

Returns:

Throws:

java.io.IOException

com.ge.research.sadl.reasoner.ConfigurationException

SessionNotFoundException

updateRdfsLabel

boolean updateRdfsLabel(java.lang.String uri,
                        java.lang.String label,
                        java.lang.String language)
                 throws com.ge.research.sadl.reasoner.ConfigurationException,
                        java.io.IOException,
                        com.ge.research.sadl.reasoner.InvalidNameException,
                        java.net.URISyntaxException

Method to add or update the rdfs:label for the ontology Resource identified by uri and of the specified language

Parameters:

uri - -- uri identifying Resource for which the label is to be added or updated

label - -- the new label

language - -- the language to be updated; if null update any label

Returns:

-- return true if a label is updated else false if there was no prior matching label

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

java.net.URISyntaxException

com.ge.research.sadl.reasoner.InvalidNameException

java.io.IOException

updateRdfsLabel

boolean updateRdfsLabel(java.lang.String modelName,
                        java.lang.String uri,
                        java.lang.String label,
                        java.lang.String language)
                 throws com.ge.research.sadl.reasoner.ConfigurationException,
                        java.io.IOException,
                        com.ge.research.sadl.reasoner.InvalidNameException,
                        java.net.URISyntaxException

Method to add or update the rdfs:label for the ontology Resource identified by uri and of the specified language

Parameters:

modelName - -- the public URI identifying the model to be edited

uri - -- uri identifying Resource for which the label is to be added or updated

label - -- the new label

language - -- the language to be updated; if null update any label

Returns:

-- return true if a label is updated else false if there was no prior matching label

Throws:

java.net.URISyntaxException

com.ge.research.sadl.reasoner.InvalidNameException

java.io.IOException

com.ge.research.sadl.reasoner.ConfigurationException

ask

com.ge.research.sadl.reasoner.ResultSet ask(java.lang.String modelName,
                                            java.lang.String subjName,
                                            java.lang.String propName,
                                            java.lang.Object objValue)
                                     throws com.ge.research.sadl.reasoner.TripleNotFoundException,
                                            com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                            com.ge.research.sadl.reasoner.QueryCancelledException,
                                            SessionNotFoundException,
                                            java.io.IOException,
                                            com.ge.research.sadl.reasoner.ConfigurationException,
                                            com.ge.research.sadl.reasoner.InvalidNameException,
                                            java.net.URISyntaxException

This method retrieves the results of an RDF triple matching request as a list of matching statements. Zero or more of the subjName, propName, and objValue may be null.

Parameters:

modelName - -- the public URI identifying the model to be edited

subjName -

propName -

objValue -

Returns:

List of matching statements, each element is Object[3]: subject, predicate, object

Throws:

com.ge.research.sadl.reasoner.QueryCancelledException

com.ge.research.sadl.reasoner.TripleNotFoundException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

SessionNotFoundException

java.net.URISyntaxException

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.reasoner.ConfigurationException

java.io.IOException

query

com.ge.research.sadl.reasoner.ResultSet query(java.lang.String modelName,
                                              java.lang.String query)
                                       throws com.ge.research.sadl.reasoner.QueryCancelledException,
                                              com.ge.research.sadl.reasoner.QueryParseException,
                                              com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                              SessionNotFoundException,
                                              java.io.IOException,
                                              com.ge.research.sadl.reasoner.ConfigurationException,
                                              com.ge.research.sadl.reasoner.InvalidNameException,
                                              java.net.URISyntaxException

This method retrieves the results of a kbase query as a List array, 1st element being a List of the column headings and second being a List of rows, each of which is a List of values. The query string will depend upon the knowledge representation and reasoner; it might be SPARQL, Prolog, etc.

Parameters:

modelName - -- the public URI identifying the model to be edited

query - a query string

Returns:

List[] with first element being the column titles (names of query variables) and second element a list of lists of values

Throws:

com.ge.research.sadl.reasoner.QueryCancelledException

com.ge.research.sadl.reasoner.QueryParseException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

SessionNotFoundException

java.net.URISyntaxException

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.reasoner.ConfigurationException

java.io.IOException