SadlServerMain

java.lang.Object
- com.ge.research.sadl.server.client.SadlServerMain

```
public class SadlServerMain
extends java.lang.Object
```
This class provides a command line interface to the SadlSever (Version 2).

Author:

crapo

Constructor Summary

Constructors
Constructor and Description

SadlServerMain()

Constructors
Constructor and Description
`SadlServerMain()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getAllowedRangeClassesOfPropertyOfClass(java.lang.String cls, java.lang.String property)` This method returns all the names of classes that are allowed in the range of the given property on the given class
`java.lang.Object[]`	`getAllowedValuesOfDataPropertyOfClass(java.lang.String cls, java.lang.String property)` This method returns all the allowed values of the given property on the given class.
`java.lang.String[]`	`getAllowedValuesOfObjectPropertyOfClass(java.lang.String cls, java.lang.String property)` This method returns all the names of instances that are allowed values of the given property on the given class
`java.lang.String[][]`	`getDataAsStringArray(java.lang.String query)`
`java.lang.String[]`	`getInstancesOfClass(java.lang.String cls)` This method returns all the instances of the given class
`java.lang.String[]`	`getLeafClassesOfTaxonomy(java.lang.String root)` This method returns all the leaf classes of the classification hierarchy starting at root
`static java.lang.String`	`getModelQuery(java.lang.String modelName)` This method returns the query associated with this service model name
`java.lang.String`	`getOutputFormat()`
`java.lang.String[]`	`getPropertyDomain(java.lang.String property)` This method returns the class(es) which are the domain of the property, if any.
`java.lang.String[]`	`getPropertyRange(java.lang.String property)` This method returns the class(es) or XSD types which are the range of the property, if any.
`java.lang.String[]`	`getRequiredRangeClassesOfPropertyOfClass(java.lang.String cls, java.lang.String property)` This method returns all the classes that must be represented in the range of the given property on the given class
`java.lang.String`	`getSessionKey()`
`boolean`	`isDatatypeProperty(java.lang.String property)` This method returns true if and only if the property is an DatatypeProperty
`boolean`	`isObjectProperty(java.lang.String property)` This method returns true if and only if the property is an ObjectProperty
`static boolean`	`isOwlFormatValid(java.lang.String format)` Method to test an OWL output format to see if it is supported
`static void`	`main(java.lang.String[] args)` This is the main method, inputs are command-line arguments.
`java.lang.String`	`process(java.lang.String[] args)` This method has the same meaning of args as for the main method but is not a static invocation and returns the session key.
`void`	`setOutputFormat(java.lang.String outputFormat)`
`static void`	`writeDataSource(javax.activation.DataSource out, java.io.OutputStream os)`
`static void`	`writeDataSource(javax.activation.DataSource out, java.lang.String fileOut)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SadlServerMain
```
public SadlServerMain()
```

Method Detail

main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        javax.naming.NameNotFoundException
```
This is the main method, inputs are command-line arguments. Note that the method "process" duplicates this for ease in calling from Java code. Main arguments needed for SadlServer V2; first 2 and 4th are required, rest are optional but an earlier argument must be present (could be empty) for a later to be included. arg0. service class name -- the fully qualified name of the class implementing the service defined in com.ge.research.sadl.server.ISadlServer e.g, com.ge.research.sadl.sadlserver.SadlServerImpl arg1. service identifier -- either 1) kbase root--the path to the directory on the local file system in or under under which model folders and/or service definition files are located or 2) the URL of the Web service to invoke arg2. service name -- either 1) the name of the named service to be invoked. This maps to a kbase and an entry point model. or 2) the URI of the model to be loaded (only valid for local service) arg3. input data (n-triple) file name--fully qualified path and name of data input file on local file system (optional) arg4. either the SPARQL query to be used to retrieve results OR the keyword for meta-data retrieval followed by one or two names as required (see method). The keyword must be one of the following: InstancesOfClass, LeafClasses, PropertyDomain, PropertyRange, RequiredRangeOfClass, AllowedRangeOfClass, AllowedDataValuesOfClass, AllowedObjectValuesOfClass, IsDatatypeProperty, IsObjectProperty arg5. output data file name -- the fully qualified path and name of the file in which output data is to be placed (optional) arg6. output format -- OWL results file output format, SPARQL CONSTRUCT query only (optional, only used for "construct" queries) Possible values are "N-TRIPLE", "TURTLE", "N3", "RDF/XML", or "RDF/XML-ABBREV" arg7. debug output level -- "NONE", "TRACE", or "DEBUG" (optional) arg8. derivation level -- (optional, 0, 1, or 2) arg9. derivation output file name -- (optional)

Parameters:

args - -- an array of values as described below

Throws:

javax.naming.NameNotFoundException

InvalidDerivation

java.io.IOException

process

public java.lang.String process(java.lang.String[] args)
                         throws java.io.IOException,
                                javax.naming.NameNotFoundException,
                                com.ge.research.sadl.reasoner.QueryParseException,
                                com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                com.ge.research.sadl.reasoner.InvalidNameException,
                                com.ge.research.sadl.reasoner.ConfigurationException,
                                SessionNotFoundException,
                                NamedServiceNotFoundException

This method has the same meaning of args as for the main method but is not a static invocation and returns the session key.

Parameters:: args - -- see main method documentation
Returns:: the session key of the session established by this processing call
Throws:: ApplicationLaunchException; java.io.IOException; javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; NamedServiceNotFoundException; InvalidDerivation

writeDataSource

public static void writeDataSource(javax.activation.DataSource out,
                                   java.lang.String fileOut)

writeDataSource

public static void writeDataSource(javax.activation.DataSource out,
                                   java.io.OutputStream os)
                            throws java.io.IOException

Throws:: java.io.IOException

getDataAsStringArray

public java.lang.String[][] getDataAsStringArray(java.lang.String query)
                                          throws javax.naming.NameNotFoundException,
                                                 com.ge.research.sadl.reasoner.QueryParseException,
                                                 com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                 SessionNotFoundException,
                                                 com.ge.research.sadl.reasoner.QueryCancelledException

Throws:: javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getModelQuery
```
public static java.lang.String getModelQuery(java.lang.String modelName)
```
This method returns the query associated with this service model name

Returns:

-- query associated with the given modelName

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)

getOutputFormat

public java.lang.String getOutputFormat()

getSessionKey

public java.lang.String getSessionKey()

getLeafClassesOfTaxonomy

public java.lang.String[] getLeafClassesOfTaxonomy(java.lang.String root)
                                            throws java.io.IOException,
                                                   javax.naming.NameNotFoundException,
                                                   com.ge.research.sadl.reasoner.QueryParseException,
                                                   com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                   com.ge.research.sadl.reasoner.InvalidNameException,
                                                   com.ge.research.sadl.reasoner.ConfigurationException,
                                                   SessionNotFoundException,
                                                   com.ge.research.sadl.reasoner.QueryCancelledException

This method returns all the leaf classes of the classification hierarchy starting at root

Parameters:: root - -- the localname, prefix:localname, or complete URI of the root class
Returns:: - a String array containing the local names of the leaf classes
Throws:: java.io.IOException; javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getInstancesOfClass

public java.lang.String[] getInstancesOfClass(java.lang.String cls)
                                       throws java.io.IOException,
                                              javax.naming.NameNotFoundException,
                                              com.ge.research.sadl.reasoner.QueryParseException,
                                              com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                              com.ge.research.sadl.reasoner.InvalidNameException,
                                              com.ge.research.sadl.reasoner.ConfigurationException,
                                              SessionNotFoundException,
                                              com.ge.research.sadl.reasoner.QueryCancelledException

This method returns all the instances of the given class

Parameters:: cls - -- the localname, prefix:localname, or complete URI of the class
Returns:: - a String array containing the localnames of the instances of the class
Throws:: java.io.IOException; javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

isObjectProperty

public boolean isObjectProperty(java.lang.String property)
                         throws javax.naming.NameNotFoundException,
                                com.ge.research.sadl.reasoner.QueryParseException,
                                com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                com.ge.research.sadl.reasoner.InvalidNameException,
                                com.ge.research.sadl.reasoner.ConfigurationException,
                                SessionNotFoundException,
                                com.ge.research.sadl.reasoner.QueryCancelledException

This method returns true if and only if the property is an ObjectProperty

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property
Returns:: - true if an ObjectProperty else false
Throws:: javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

isDatatypeProperty

public boolean isDatatypeProperty(java.lang.String property)
                           throws javax.naming.NameNotFoundException,
                                  com.ge.research.sadl.reasoner.QueryParseException,
                                  com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                  com.ge.research.sadl.reasoner.InvalidNameException,
                                  com.ge.research.sadl.reasoner.ConfigurationException,
                                  SessionNotFoundException,
                                  com.ge.research.sadl.reasoner.QueryCancelledException

This method returns true if and only if the property is an DatatypeProperty

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property
Returns:: - true if an DatatypeProperty else false
Throws:: javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getPropertyDomain

public java.lang.String[] getPropertyDomain(java.lang.String property)
                                     throws javax.naming.NameNotFoundException,
                                            com.ge.research.sadl.reasoner.QueryParseException,
                                            com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                            com.ge.research.sadl.reasoner.InvalidNameException,
                                            com.ge.research.sadl.reasoner.ConfigurationException,
                                            SessionNotFoundException,
                                            com.ge.research.sadl.reasoner.QueryCancelledException

This method returns the class(es) which are the domain of the property, if any.

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property
Returns:: - a String array containing the domain classes
Throws:: javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getPropertyRange

public java.lang.String[] getPropertyRange(java.lang.String property)
                                    throws javax.naming.NameNotFoundException,
                                           com.ge.research.sadl.reasoner.QueryParseException,
                                           com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                           com.ge.research.sadl.reasoner.InvalidNameException,
                                           com.ge.research.sadl.reasoner.ConfigurationException,
                                           SessionNotFoundException,
                                           com.ge.research.sadl.reasoner.QueryCancelledException

This method returns the class(es) or XSD types which are the range of the property, if any.

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property
Returns:: - a String array containing the range classes or XSD types
Throws:: javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getRequiredRangeClassesOfPropertyOfClass

public java.lang.String[] getRequiredRangeClassesOfPropertyOfClass(java.lang.String cls,
                                                                   java.lang.String property)
                                                            throws java.io.IOException,
                                                                   javax.naming.NameNotFoundException,
                                                                   com.ge.research.sadl.reasoner.QueryParseException,
                                                                   com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                                   com.ge.research.sadl.reasoner.InvalidNameException,
                                                                   com.ge.research.sadl.reasoner.ConfigurationException,
                                                                   SessionNotFoundException,
                                                                   com.ge.research.sadl.reasoner.QueryCancelledException

This method returns all the classes that must be represented in the range of the given property on the given class

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property; cls - -- the localname, prefix:localname, or complete URI of the class
Returns:: - a String array containing the range classes that are required to be represented in the values of the property
Throws:: java.io.IOException; javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getAllowedRangeClassesOfPropertyOfClass

public java.lang.String[] getAllowedRangeClassesOfPropertyOfClass(java.lang.String cls,
                                                                  java.lang.String property)
                                                           throws javax.naming.NameNotFoundException,
                                                                  com.ge.research.sadl.reasoner.InvalidNameException,
                                                                  com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                                  com.ge.research.sadl.reasoner.ConfigurationException,
                                                                  com.ge.research.sadl.reasoner.QueryParseException,
                                                                  SessionNotFoundException,
                                                                  com.ge.research.sadl.reasoner.QueryCancelledException

This method returns all the names of classes that are allowed in the range of the given property on the given class

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property; cls - -- the localname, prefix:localname, or complete URI of the class
Returns:: - a String array containing the range classes that are allowed to be represented in the values of the property
Throws:: javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.InvalidNameException; com.ge.research.sadl.reasoner.QueryParseException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getAllowedValuesOfObjectPropertyOfClass

public java.lang.String[] getAllowedValuesOfObjectPropertyOfClass(java.lang.String cls,
                                                                  java.lang.String property)
                                                           throws java.io.IOException,
                                                                  javax.naming.NameNotFoundException,
                                                                  com.ge.research.sadl.reasoner.QueryParseException,
                                                                  com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                                  com.ge.research.sadl.reasoner.InvalidNameException,
                                                                  com.ge.research.sadl.reasoner.ConfigurationException,
                                                                  SessionNotFoundException,
                                                                  com.ge.research.sadl.reasoner.QueryCancelledException

This method returns all the names of instances that are allowed values of the given property on the given class

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property; cls - -- the localname, prefix:localname, or complete URI of the class
Returns:: - a String array of the allowed value instances
Throws:: java.io.IOException; javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

getAllowedValuesOfDataPropertyOfClass

public java.lang.Object[] getAllowedValuesOfDataPropertyOfClass(java.lang.String cls,
                                                                java.lang.String property)
                                                         throws com.ge.research.sadl.reasoner.QueryParseException,
                                                                com.ge.research.sadl.reasoner.ReasonerNotFoundException,
                                                                com.ge.research.sadl.reasoner.InvalidNameException,
                                                                com.ge.research.sadl.reasoner.ConfigurationException,
                                                                SessionNotFoundException,
                                                                com.ge.research.sadl.reasoner.QueryCancelledException

This method returns all the allowed values of the given property on the given class. Note that in the case of xsd:string values, the values will be wrapped in double quotes.

Parameters:: property - -- the localname, prefix:localname, or complete URI of the property; cls - -- the localname, prefix:localname, or complete URI of the class
Returns:: - an Object array of the allowed values, which will be of type Integer, String, Float, etc.
Throws:: java.io.IOException; javax.naming.NameNotFoundException; com.ge.research.sadl.reasoner.ReasonerNotFoundException; com.ge.research.sadl.reasoner.QueryParseException; com.ge.research.sadl.reasoner.ConfigurationException; com.ge.research.sadl.reasoner.InvalidNameException; SessionNotFoundException; com.ge.research.sadl.reasoner.QueryCancelledException

isOwlFormatValid
```
public static boolean isOwlFormatValid(java.lang.String format)
```
Method to test an OWL output format to see if it is supported

Class SadlServerMain

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SadlServerMain

Method Detail

main

process

writeDataSource

writeDataSource

getDataAsStringArray

getModelQuery

setOutputFormat

getOutputFormat

getSessionKey

getLeafClassesOfTaxonomy

getInstancesOfClass

isObjectProperty

isDatatypeProperty

getPropertyDomain

getPropertyRange

getRequiredRangeClassesOfPropertyOfClass

getAllowedRangeClassesOfPropertyOfClass

getAllowedValuesOfObjectPropertyOfClass

getAllowedValuesOfDataPropertyOfClass

isOwlFormatValid