com.ge.research.sadl.server.server

Class SadlServerImpl

java.lang.Object

com.ge.research.sadl.server.server.SadlServerImpl

All Implemented Interfaces:

ISadlServer

Direct Known Subclasses:

SadlServerPEImpl

public class SadlServerImpl
extends java.lang.Object
implements ISadlServer

This class provides the implementation of the ISadlService interface contract. $Author: crapo $ $Revision: 1.16 $ Last modified on $Date: 2014/11/03 20:09:59 $

Constructor Summary

Constructors

Constructor and Description
SadlServerImpl()
SadlServerImpl(java.lang.String _kbaseRoot)

Method Summary

Modifier and Type	Method and Description
boolean	addTriple(java.lang.String subjName, java.lang.String predName, java.lang.Object objValue) This method is called to add a triple to the instance data.
com.ge.research.sadl.reasoner.ResultSet	ask(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.
com.ge.research.sadl.reasoner.ResultSet[]	atomicQuery(java.lang.String serviceName, javax.activation.DataSource dataSrc, java.lang.String inputFormat, java.lang.String[] sparql) Method to provide instance data and then execute a set of queries in an atomic (stateless) manner, returning a ResultSet for each query.
com.ge.research.sadl.reasoner.ResultSet[]	atomicQueryCsvData(java.lang.String serviceName, javax.activation.DataSource csvDataSrc, boolean includesHeader, java.lang.String csvTemplate, java.lang.String[] sparql) Method to provide CSV instance data and then execute a set of queries in an atomic (stateless) manner, returning a ResultSet for each query.
boolean	clearCache() Method to clear the cache for the current kbase model.
void	collectTimingInformation(boolean bCollect) Turn on/off collection of timing information
javax.activation.DataSource	construct(java.lang.String sparql) Executes a construct query, which will return a subgraph of the knowledge base and instance data.
java.lang.String	createInstance(java.lang.String name, java.lang.String className) This method creates a new Individual of the class identified.
boolean	deleteTriple(java.lang.String subjName, java.lang.String predName, java.lang.Object objValue) This method is called to delete a triple from the instance data.
java.lang.String	getClassName() This method returns the name of the class implementing the ISadlService interface.
javax.activation.DataSource	getDerivations() Gets derivations of all inferred statements (if the reasoner supports derivations)
java.lang.String	getInstanceDataNamespace() This method retrieves the default instance data namespace.
java.lang.String	getInstanceModelName() This method retrieves the instance model associated with the default instance data namespace.
java.lang.String	getKBaseIdentifier() Gets the knowledge base identifier for the current session.
java.lang.String	getKbaseRoot() Method to get the kbase root folder path.
java.lang.String	getModelName() Gets the model name for the current session.
java.lang.String	getReasonerVersion() Gets the version of the reasoner.
java.util.Map<java.lang.String,java.lang.String[]>	getServiceNameMap() This method returns the service name map whose keys are the names of the services and whose values are String arrays of size 2 with the 1st element being the actual URL of the knowledge base folder (the folder containing the OWL models, rule files, etc.; the knowledgeBaseIdentifier) and the 2nd element being the public URI of the model which is the entry point into the kbase for the named service.
java.lang.String	getServiceVersion() This method returns the Source Code Control System (SCC) Version of the class implementing the ISadlService interface
com.ge.research.sadl.reasoner.ReasonerTiming[]	getTimingInformation() Gets timing information for a given session, if the reasoner supports this capability.
boolean	loadCsvData(java.lang.String serverCsvDataLocator, boolean includesHeader, java.lang.String csvTemplate) This method is called to cause abox data to be loaded by mapping from a CSV data file to semantic data using the mapping template specified
boolean	loadData(java.lang.String serverDataLocator) This method is called to cause abox data to be loaded from the server environment.
java.lang.String	parameterizeQuery(java.lang.String query, java.util.List<java.lang.Object> values) Method to substitute parameter values for "?" terms in a query string.
java.lang.String	prepareQuery(java.lang.String query) Method to expand prefixes, find namespaces, and do whatever other processing may be necessary to prepare a query string for execution by the target query engine.
com.ge.research.sadl.reasoner.ResultSet	query(java.lang.String sparql) 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	reset() This method is called to delete all instance data added by calls to addTriple or forms of loadInstanceData.
java.lang.String	selectServiceModel(java.lang.String serviceName) This method is called to identify the model (tbox) to use by service name.
java.lang.String	selectServiceModel(java.lang.String serviceName, java.util.List<com.ge.research.sadl.reasoner.ConfigurationItem> preferences) This method is called to identify the model (tbox) to use in this knowledge service session and to simultaneously override certain default configuration settings.
java.lang.String	selectServiceModel(java.lang.String knowledgeBaseIdentifier, java.lang.String modelName) This method is called to identify the knowledgeBaseIdentifier and model (tbox) to use in this knowledge service session.
java.lang.String	selectServiceModel(java.lang.String knowledgeBaseIdentifier, java.lang.String modelName, java.util.List<com.ge.research.sadl.reasoner.ConfigurationItem> preferences) This method is called to identify the knowledgeBaseIdentifier and model (tbox) to use in this knowledge service session.
boolean	sendCsvData(javax.activation.DataSource csvDataSrc, boolean includesHeader, java.lang.String csvTemplate) This method is called to send abox data in CSV format to be converted to semantic data using the identified mapping template.
boolean	sendData(javax.activation.DataSource dataSrc) This method passes input data as a semantic model as a DataSource
boolean	sendData(javax.activation.DataSource dataSrc, java.lang.String inputFormat) This method passes input data as a semantic model as a DataSource with a specified format
java.lang.String	setInstanceDataNamespace(java.lang.String namespace) This method sets the default instance data namespace.
void	setKbaseRoot(java.lang.String _kbaseRoot) Method to set the kbase root folder--a folder on the server file system in which and under which server configuration files and folders of model files will be found.
void	setOwlFileOutputFormat(java.lang.String outputFormat) Sets the Owl file output format to be used for output, e.g., when responding to a SPARQL construct query.
void	setQueryTimeout(long timeout) Method to set the timeout for queries.
void	setServiceNameMap(java.util.Map<java.lang.String,java.lang.String[]> serviceNameMap) This method sets the service name map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SadlServerImpl

public SadlServerImpl()

SadlServerImpl

public SadlServerImpl(java.lang.String _kbaseRoot)
               throws com.ge.research.sadl.reasoner.ConfigurationException

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

Method Detail

getClassName

public java.lang.String getClassName()
                              throws SessionNotFoundException

Description copied from interface: ISadlServer

This method returns the name of the class implementing the ISadlService interface.

Specified by:

getClassName in interface ISadlServer

Returns:

-- class name

Throws:

SessionNotFoundException

getServiceVersion

public java.lang.String getServiceVersion()
                                   throws SessionNotFoundException

Description copied from interface: ISadlServer

This method returns the Source Code Control System (SCC) Version of the class implementing the ISadlService interface

Specified by:

getServiceVersion in interface ISadlServer

Returns:

the CVS version number of the ISadlServer implementation

Throws:

SessionNotFoundException

query

public com.ge.research.sadl.reasoner.ResultSet query(java.lang.String sparql)
                                              throws com.ge.research.sadl.reasoner.QueryParseException,
                                                     com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                     com.ge.research.sadl.reasoner.QueryCancelledException

Description copied from interface: ISadlServer

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.

Specified by:

query in interface ISadlServer

Parameters:

sparql - 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.QueryParseException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

com.ge.research.sadl.reasoner.QueryCancelledException

getTimingInformation

public com.ge.research.sadl.reasoner.ReasonerTiming[] getTimingInformation()

Description copied from interface: ISadlServer

Gets timing information for a given session, if the reasoner supports this capability. Normally a call to collectTimingInformation(true) must be made before the inference session begins for timing to be collected.

Specified by:

getTimingInformation in interface ISadlServer

Returns:

timing information

construct

public javax.activation.DataSource construct(java.lang.String sparql)
                                      throws com.ge.research.sadl.reasoner.QueryParseException,
                                             com.ge.research.sadl.reasoner.QueryCancelledException

Description copied from interface: ISadlServer

Executes a construct query, which will return a subgraph of the knowledge base and instance data.

Specified by:

construct in interface ISadlServer

Returns:

Construct datasource

Throws:

com.ge.research.sadl.reasoner.QueryParseException

com.ge.research.sadl.reasoner.QueryCancelledException

ask

public com.ge.research.sadl.reasoner.ResultSet ask(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

Description copied from interface: ISadlServer

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.

Specified by:

ask in interface ISadlServer

Returns:

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

Throws:

com.ge.research.sadl.reasoner.TripleNotFoundException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

loadData

public boolean loadData(java.lang.String serverDataLocator)
                 throws java.io.IOException,
                        com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                        com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

This method is called to cause abox data to be loaded from the server environment.

Specified by:

loadData in interface ISadlServer

Parameters:

serverDataLocator - -- the location of the data to be loaded in the server environment. This will be reasoner-specifc. For some reasoners it may be a relative file path.

Returns:

true if successful else false

Throws:

java.io.IOException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

loadCsvData

public boolean loadCsvData(java.lang.String serverCsvDataLocator,
                           boolean includesHeader,
                           java.lang.String csvTemplate)
                    throws com.ge.research.sadl.reasoner.ConfigurationException,
                           java.io.IOException,
                           com.ge.research.sadl.reasoner.InvalidNameException,
                           com.ge.research.sadl.importer.TemplateException

Description copied from interface: ISadlServer

This method is called to cause abox data to be loaded by mapping from a CSV data file to semantic data using the mapping template specified

Specified by:

loadCsvData in interface ISadlServer

Parameters:

serverCsvDataLocator - -- server-side location of CSV data

includesHeader - -- true if the CSV file contains header information in the first row

csvTemplate - -- server-side location of template mapping file

Returns:

-- true if successful else false

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

java.io.IOException

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.importer.TemplateException

selectServiceModel

public java.lang.String selectServiceModel(java.lang.String serviceName)
                                    throws com.ge.research.sadl.reasoner.ConfigurationException,
                                           com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

This method is called to identify the model (tbox) to use by service name.

Specified by:

selectServiceModel in interface ISadlServer

Parameters:

serviceName - -- the name of the service, which is used to lookup the knowledgeBaseIdentifier and modelName

Returns:

-- the unique session key for this knowledge service session

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

selectServiceModel

public java.lang.String selectServiceModel(java.lang.String serviceName,
                                           java.util.List<com.ge.research.sadl.reasoner.ConfigurationItem> preferences)
                                    throws com.ge.research.sadl.reasoner.ConfigurationException,
                                           com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                           NamedServiceNotFoundException

Description copied from interface: ISadlServer

This method is called to identify the model (tbox) to use in this knowledge service session and to simultaneously override certain default configuration settings.

Specified by:

selectServiceModel in interface ISadlServer

Parameters:

serviceName - -- the name of the service, which is used to lookup the knowledgeBaseIdentifier and modelName

preferences - -- preferences override the configuration from the development environment (configuration.rdf)

Returns:

-- the unique session key for this knowledge service session

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

NamedServiceNotFoundException

selectServiceModel

public java.lang.String selectServiceModel(java.lang.String knowledgeBaseIdentifier,
                                           java.lang.String modelName)
                                    throws com.ge.research.sadl.reasoner.ConfigurationException,
                                           com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

This method is called to identify the knowledgeBaseIdentifier and model (tbox) to use in this knowledge service session.

Specified by:

selectServiceModel in interface ISadlServer

Parameters:

knowledgeBaseIdentifier - -- the identity of the knowledge base, e.g., the folder containing the OWL/Rule files OR the name of the service of a service that does not have a model name specified, in which case the model name is specified by the next parameter

modelName - -- the entry point (specific model) within the knowledge base, e.g., the URI corresponding with the base namespace of the OWL model

Returns:

-- the unique session key for this knowledge service session

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

selectServiceModel

public java.lang.String selectServiceModel(java.lang.String knowledgeBaseIdentifier,
                                           java.lang.String modelName,
                                           java.util.List<com.ge.research.sadl.reasoner.ConfigurationItem> preferences)
                                    throws com.ge.research.sadl.reasoner.ConfigurationException,
                                           com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

This method is called to identify the knowledgeBaseIdentifier and model (tbox) to use in this knowledge service session.

Specified by:

selectServiceModel in interface ISadlServer

Parameters:

knowledgeBaseIdentifier - -- the identity of the knowledge base, e.g., the folder containing the OWL/Rule files OR the name of the service of a service that does not have a model name specified, in which case the model name is specified by the next parameter

modelName - -- the entry point (specific model) within the knowledge base, e.g., the URI corresponding with the base namespace of the OWL model

preferences - -- preferences override the configuration from the development environment (configuration.rdf)

Returns:

-- the unique session key for this knowledge service session

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

sendData

public boolean sendData(javax.activation.DataSource dataSrc)
                 throws java.io.IOException,
                        com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                        com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

This method passes input data as a semantic model as a DataSource

Specified by:

sendData in interface ISadlServer

Returns:

true if successful else false

Throws:

java.io.IOException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

sendData

public boolean sendData(javax.activation.DataSource dataSrc,
                        java.lang.String inputFormat)
                 throws java.io.IOException,
                        com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                        com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

This method passes input data as a semantic model as a DataSource with a specified format

Specified by:

sendData in interface ISadlServer

inputFormat - -- "N-TRIPLE", "N3", or "RDF/XML"

Returns:

true if successful else false

Throws:

java.io.IOException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

sendCsvData

public boolean sendCsvData(javax.activation.DataSource csvDataSrc,
                           boolean includesHeader,
                           java.lang.String csvTemplate)
                    throws com.ge.research.sadl.reasoner.ConfigurationException,
                           java.io.IOException,
                           com.ge.research.sadl.reasoner.InvalidNameException,
                           com.ge.research.sadl.importer.TemplateException

Description copied from interface: ISadlServer

This method is called to send abox data in CSV format to be converted to semantic data using the identified mapping template. The template identifier can be a serialized string or it can be a URL to a template.

Specified by:

sendCsvData in interface ISadlServer

Parameters:

csvDataSrc - -- CSV data stream

includesHeader - -- true if the CSV file contains header information in the first row

csvTemplate - -- template mapping identifier

Returns:

-- true if successful else false

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

java.io.IOException

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.importer.TemplateException

addTriple

public boolean addTriple(java.lang.String subjName,
                         java.lang.String predName,
                         java.lang.Object objValue)
                  throws com.ge.research.sadl.reasoner.ConfigurationException,
                         com.ge.research.sadl.reasoner.TripleNotFoundException,
                         com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

This method is called to add a triple to the instance data. The object value will be interpreted based on type of the Object and on the range of the property if it is an OntProperty.

Specified by:

addTriple in interface ISadlServer

Parameters:

subjName - the URI of the subject

predName - the URI of the property

objValue - the URI of the object value for an ObjectProperty or a value that will be interpreted for a DatatypeProperty

Returns:

true if successful

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.TripleNotFoundException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

deleteTriple

public boolean deleteTriple(java.lang.String subjName,
                            java.lang.String predName,
                            java.lang.Object objValue)
                     throws com.ge.research.sadl.reasoner.ConfigurationException,
                            com.ge.research.sadl.reasoner.TripleNotFoundException,
                            com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

This method is called to delete a triple from the instance data. The subject, predicate, and/or object can be null to delete everything matching the pattern.

Specified by:

deleteTriple in interface ISadlServer

Returns:

true if successful else false

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.TripleNotFoundException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

reset

public boolean reset()
              throws com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

This method is called to delete all instance data added by calls to addTriple or forms of loadInstanceData. The infModel is reset to reflect those removals.

Specified by:

reset in interface ISadlServer

Returns:

true if successful else false

Throws:

com.ge.research.sadl.reasoner.ReasonerNotFoundException

prepareQuery

public java.lang.String prepareQuery(java.lang.String query)
                              throws com.ge.research.sadl.reasoner.InvalidNameException,
                                     com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                     com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

Method to expand prefixes, find namespaces, and do whatever other processing may be necessary to prepare a query string for execution by the target query engine. Note: this is provided as a callable functionality so that queries which are known to be completely expanded need not have the overhead of checking.

Specified by:

prepareQuery in interface ISadlServer

Returns:

the expanded query prepared for execution

Throws:

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

com.ge.research.sadl.reasoner.ConfigurationException

parameterizeQuery

public java.lang.String parameterizeQuery(java.lang.String query,
                                          java.util.List<java.lang.Object> values)
                                   throws com.ge.research.sadl.reasoner.InvalidNameException,
                                          com.ge.research.sadl.reasoner.ConfigurationException,
                                          com.ge.research.sadl.reasoner.ReasonerNotFoundException

Description copied from interface: ISadlServer

Method to substitute parameter values for "?" terms in a query string.

Specified by:

parameterizeQuery in interface ISadlServer

Parameters:

query - -- SPARQL query or update string

values - -- parameter values to be substituted

Returns:

parameterized query

Throws:

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

setOwlFileOutputFormat

public void setOwlFileOutputFormat(java.lang.String outputFormat)

Description copied from interface: ISadlServer

Sets the Owl file output format to be used for output, e.g., when responding to a SPARQL construct query.

Specified by:

setOwlFileOutputFormat in interface ISadlServer

Parameters:

outputFormat - -- "N-TRIPLE", "N3", or "RDF/XML"

getKBaseIdentifier

public java.lang.String getKBaseIdentifier()
                                    throws com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

Gets the knowledge base identifier for the current session.

Specified by:

getKBaseIdentifier in interface ISadlServer

Returns:

knowledge base identifier

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

getModelName

public java.lang.String getModelName()
                              throws java.io.IOException

Description copied from interface: ISadlServer

Gets the model name for the current session.

Specified by:

getModelName in interface ISadlServer

Returns:

model name

Throws:

java.io.IOException

getReasonerVersion

public java.lang.String getReasonerVersion()
                                    throws com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

Gets the version of the reasoner.

Specified by:

getReasonerVersion in interface ISadlServer

Returns:

reasoner version

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

getDerivations

public javax.activation.DataSource getDerivations()
                                           throws com.ge.research.sadl.reasoner.ConfigurationException,
                                                  com.ge.research.sadl.reasoner.InvalidDerivationException

Description copied from interface: ISadlServer

Gets derivations of all inferred statements (if the reasoner supports derivations)

Specified by:

getDerivations in interface ISadlServer

Returns:

Derivations datasource

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.InvalidDerivationException

setServiceNameMap

public void setServiceNameMap(java.util.Map<java.lang.String,java.lang.String[]> serviceNameMap)

Description copied from interface: ISadlServer

This method sets the service name map. It is not normally necessary to call this from the client as the service name map is normally set by scanning the kbaseroot and its subfolders when the call is made to setKbaseRoot. However, in theory this could be set from the client without setting a kbaseroot.

Specified by:

setServiceNameMap in interface ISadlServer

Parameters:

serviceNameMap - -- service name map

getServiceNameMap

public java.util.Map<java.lang.String,java.lang.String[]> getServiceNameMap()

Description copied from interface: ISadlServer

This method returns the service name map whose keys are the names of the services and whose values are String arrays of size 2 with the 1st element being the actual URL of the knowledge base folder (the folder containing the OWL models, rule files, etc.; the knowledgeBaseIdentifier) and the 2nd element being the public URI of the model which is the entry point into the kbase for the named service.

Specified by:

getServiceNameMap in interface ISadlServer

Returns:

-- service name map

collectTimingInformation

public void collectTimingInformation(boolean bCollect)

Description copied from interface: ISadlServer

Turn on/off collection of timing information

Specified by:

collectTimingInformation in interface ISadlServer

Parameters:

bCollect - -- true to collect timing information; false otherwise

setKbaseRoot

public void setKbaseRoot(java.lang.String _kbaseRoot)
                  throws com.ge.research.sadl.reasoner.ConfigurationException

Description copied from interface: ISadlServer

Method to set the kbase root folder--a folder on the server file system in which and under which server configuration files and folders of model files will be found.

Specified by:

setKbaseRoot in interface ISadlServer

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

getKbaseRoot

public java.lang.String getKbaseRoot()

Description copied from interface: ISadlServer

Method to get the kbase root folder path.

Specified by:

getKbaseRoot in interface ISadlServer

Returns:

-- the kbase root else null if not set or request not supported (Web service)

atomicQuery

public com.ge.research.sadl.reasoner.ResultSet[] atomicQuery(java.lang.String serviceName,
                                                             javax.activation.DataSource dataSrc,
                                                             java.lang.String inputFormat,
                                                             java.lang.String[] sparql)
                                                      throws java.io.IOException,
                                                             com.ge.research.sadl.reasoner.ConfigurationException,
                                                             NamedServiceNotFoundException,
                                                             com.ge.research.sadl.reasoner.QueryParseException,
                                                             com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                             SessionNotFoundException,
                                                             com.ge.research.sadl.reasoner.InvalidNameException,
                                                             com.ge.research.sadl.reasoner.QueryCancelledException

Description copied from interface: ISadlServer

Method to provide instance data and then execute a set of queries in an atomic (stateless) manner, returning a ResultSet for each query. The query strings will depend upon the knowledge representation and reasoner; it might be SPARQL, Prolog, etc.

Specified by:

atomicQuery in interface ISadlServer

Parameters:

serviceName - -- the name of the service, which is used to lookup the knowledgeBaseIdentifier and modelName

dataSrc - -- the DataSource to supply instance data to the model

inputFormat - -- "N-TRIPLE", "N3", or "RDF/XML"

sparql - -- a array of queries to be executed

Returns:

-- an array of ResultSet instances containing the results of each query

Throws:

java.io.IOException

com.ge.research.sadl.reasoner.ConfigurationException

NamedServiceNotFoundException

com.ge.research.sadl.reasoner.QueryParseException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.reasoner.QueryCancelledException

atomicQueryCsvData

public com.ge.research.sadl.reasoner.ResultSet[] atomicQueryCsvData(java.lang.String serviceName,
                                                                    javax.activation.DataSource csvDataSrc,
                                                                    boolean includesHeader,
                                                                    java.lang.String csvTemplate,
                                                                    java.lang.String[] sparql)
                                                             throws java.io.IOException,
                                                                    com.ge.research.sadl.reasoner.ConfigurationException,
                                                                    NamedServiceNotFoundException,
                                                                    com.ge.research.sadl.reasoner.QueryParseException,
                                                                    com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                                    SessionNotFoundException,
                                                                    com.ge.research.sadl.reasoner.InvalidNameException,
                                                                    com.ge.research.sadl.importer.TemplateException,
                                                                    com.ge.research.sadl.reasoner.QueryCancelledException

Description copied from interface: ISadlServer

Method to provide CSV instance data and then execute a set of queries in an atomic (stateless) manner, returning a ResultSet for each query. The query strings will depend upon the knowledge representation and reasoner; it might be SPARQL, Prolog, etc.

Specified by:

atomicQueryCsvData in interface ISadlServer

Parameters:

serviceName - -- the name of the service, which is used to lookup the knowledgeBaseIdentifier and modelName

csvDataSrc - -- the CSV DataSource to supply instance data to the model

includesHeader - -- true if the CSV file contains header information in the first row

csvTemplate - -- template mapping data stream

sparql - -- a array of queries to be executed

Returns:

-- an array of ResultSet instances containing the results of each query

Throws:

java.io.IOException

com.ge.research.sadl.reasoner.ConfigurationException

NamedServiceNotFoundException

com.ge.research.sadl.reasoner.QueryParseException

com.ge.research.sadl.reasoner.ReasonerNotFoundException

SessionNotFoundException

com.ge.research.sadl.reasoner.InvalidNameException

com.ge.research.sadl.importer.TemplateException

com.ge.research.sadl.reasoner.QueryCancelledException

setInstanceDataNamespace

public java.lang.String setInstanceDataNamespace(java.lang.String namespace)
                                          throws com.ge.research.sadl.reasoner.InvalidNameException

Description copied from interface: ISadlServer

This method sets the default instance data namespace. Instance data nodes without a specified namespace will use this namespace.

Specified by:

setInstanceDataNamespace in interface ISadlServer

Parameters:

namespace - -- the default instance data namespace

Returns:

-- the old instance data namespace or null if there was none

Throws:

com.ge.research.sadl.reasoner.InvalidNameException

getInstanceDataNamespace

public java.lang.String getInstanceDataNamespace()

Description copied from interface: ISadlServer

This method retrieves the default instance data namespace.

Specified by:

getInstanceDataNamespace in interface ISadlServer

Returns:

getInstanceModelName

public java.lang.String getInstanceModelName()

Description copied from interface: ISadlServer

This method retrieves the instance model associated with the default instance data namespace. (The model namespace is the model name with a "#" added at the end.)

Specified by:

getInstanceModelName in interface ISadlServer

Returns:

createInstance

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

Description copied from interface: ISadlServer

This method creates a new Individual of the class identified.

Specified by:

createInstance in interface ISadlServer

Parameters:

name - -- the name of the new instance to be created. If only a local fragment is given (no namespace), the instance will be created in the default namespace.

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

Returns:

-- the identity of the new Individual; the fully qualified name (URI) for a named resource

Throws:

com.ge.research.sadl.reasoner.ConfigurationException

com.ge.research.sadl.reasoner.InvalidNameException

java.io.IOException

setQueryTimeout

public void setQueryTimeout(long timeout)
                     throws com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                            SessionNotFoundException

Description copied from interface: ISadlServer

Method to set the timeout for queries. Default is no timeout, which is equivalent to calling this method with a value of -1.

Specified by:

setQueryTimeout in interface ISadlServer

Parameters:

timeout - (in milliseconds)

Throws:

com.ge.research.sadl.reasoner.ReasonerNotFoundException

SessionNotFoundException

clearCache

public boolean clearCache()
                   throws com.ge.research.sadl.reasoner.InvalidNameException,
                          SessionNotFoundException

Description copied from interface: ISadlServer

Method to clear the cache for the current kbase model. Inferred models can be cached, depending on the configuration settings, to provide faster performance when the inputs have not changed.

Specified by:

clearCache in interface ISadlServer

Returns:

true if successful else false

Throws:

com.ge.research.sadl.reasoner.InvalidNameException

SessionNotFoundException