OntologyCreate Class Reference
[Ontology Management Web Service]

Ontology Create Web Service. It indexes new ontologies description in the structWSF instance. Re-generate the internal ontological structure of the system. More...

Inherits WebService.

Collaboration diagram for OntologyCreate:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($ontology, $mime, $action, $registered_ip, $requester_ip)
 Constructor.
 __destruct ()
 pipeline_getError ()
 Returns the error structure.
 pipeline_getResultset ()
 Create a resultset in a pipelined mode based on the processed information by the Web service.
 injectDoctype ($xmlDoc)
 Inject the DOCType in a XML document.
 ws_conneg ($accept, $accept_charset, $accept_encoding, $accept_language)
 Do content negotiation as an external Web Service.
 pipeline_conneg ($accept, $accept_charset, $accept_encoding, $accept_language)
 Do content negotiation as an internal, pipelined, Web Service that is part of a Compound Web Service.
 pipeline_getResponseHeaderStatus ()
 Returns the response HTTP header status.
 pipeline_getResponseHeaderStatusMsg ()
 Returns the response HTTP header status message.
 pipeline_getResponseHeaderStatusMsgExt ()
 Returns the response HTTP header status message extension.
 pipeline_serialize ()
 Serialize the web service answer.
 pipeline_serialize_reification ()
 Non implemented method (only defined).
 ws_serialize ()
 Serialize the web service answer.
 ws_respond ($content)
 Sends the HTTP response to the requester.
 process ()
 Update all ontological structures used by the WSF.
 xmlEncode ($string)
 Encode content to be included in XML files.
 jsonEncode ($string)
 Encode a string to put in a JSON value.

Static Public Attributes

static $supportedSerializations
 Supported serialization mime types by this Web service.
static $data_ini = "/data/"
 data.ini file folder
static $network_ini = "/usr/share/structwsf/"
 network.ini file folder

Protected Member Functions

 validateQuery ()
 Validate a query to this web service.

Protected Attributes

 $db_username = ""
 Database user name.
 $db_password = ""
 Database password.
 $db_dsn = ""
 Database DSN connection.
 $db_host = "localhost"
 Database host.
 $dtdBaseURL = ""
 DTD URL of the web service.
 $wsf_graph = ""
 The graph where the Web Services Framework description has been indexed.
 $wsf_base_url = ""
 Base URL of the WSF.
 $wsf_base_path = ""
 Local server path of the WSF files.
 $wsf_local_ip = ""
 Local server path of the WSF files.
 $wsf_solr_core = ""
 The core to use for Solr; "" for no core.
 $ontologies_files_folder = ""
 Path to the ontologies description files (in RDFS and OWL).
 $solr_host = "localhost"
 Hostname where to send queries to the Solr instance.
 $ontological_structure_folder = ""
 Path to the structWSF ontological structure.
 $log_table = "SD.WSF.ws_queries_log"
 Name of the logging table on the Virtuoso instance.
 $solr_auto_commit = FALSE
 Auto commit handled by the Solr data management systems. If this parameter is true, then this means Solr will handle the commit operation by itself. If it is false, then the web services will trigger the commit operations. Usually, Auto-commit should be handled by Solr when the size of the dataset is too big, otherwise operation such as delete could take much time.
 $uri
 The URI of the Authentication Registrar web service.
 $title
 The Title of the Authentication Registrar web service.
 $crud_usage
 The CRUD usage of the Authentication Registrar web service.
 $endpoint
 The endpoint of the Authentication Registrar web service.

Private Member Functions

 addEquivalentClass ($graph, $subject, $property, $target)
 getUnionOf ($unionURI, &$unionClasses)

Private Attributes

 $db
 Database connection.
 $conneg
 Conneg object that manage the content negotiation capabilities of the web service.
 $dtdURL
 URL where the DTD of the XML document can be located on the Web.
 $registered_ip = ""
 IP being registered.
 $ontology = array()
 Ontology RDF document. Maximum size (by default) is 8M (default php.ini setting).
 $mime = ""
 Mime of the Ontology RDF document serialization.
 $action = ""
 Additional action that can be performed when adding a new ontology: (1) recreate_inference.
 $requester_ip = ""
 Requester's IP used for request validation.
 $rulesSetURI = ""
 URI of the inference rules set to use to create the ontological structure.
 $errorMessenger
 Error messages of this web service.

Detailed Description

Ontology Create Web Service. It indexes new ontologies description in the structWSF instance. Re-generate the internal ontological structure of the system.


Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 27 of file OntologyCreate.php.

Constructor & Destructor Documentation

OntologyCreate::__construct ( $  ontology,
$  mime,
$  action,
$  registered_ip,
$  requester_ip 
)

Constructor.

Initialize the Ontology Create

Parameters:
[in] $ontology RDF document describing the ontology. The size of this document is limited to 8MB
[in] $mime One of: (1) application/rdf+xml? RDF document serialized in XML (2) application/rdf+n3? RDF document serialized in N3
[in] $action (optional).If action = "recreate_inference" then the inference table will be re-created as well
[in] $registered_ip Target IP address registered in the WSF
[in] $requester_ip IP address of the requester

Returns:
returns NULL
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 207 of file OntologyCreate.php.

References $action, $mime, $ontology, $registered_ip, $requester_ip, and WebService::__construct().

Here is the call graph for this function:

OntologyCreate::__destruct (  ) 

Reimplemented from WebService.

Definition at line 252 of file OntologyCreate.php.

Referenced by ws_respond().

Member Function Documentation

OntologyCreate::addEquivalentClass ( $  graph,
$  subject,
$  property,
$  target 
) [private]

Definition at line 1427 of file OntologyCreate.php.

References $query.

Referenced by process().

OntologyCreate::getUnionOf ( $  unionURI,
&$  unionClasses 
) [private]

Definition at line 1442 of file OntologyCreate.php.

References $query.

Referenced by process().

OntologyCreate::injectDoctype ( $  xmlDoc  ) 

Inject the DOCType in a XML document.


Parameters:
[in] $xmlDoc The XML document where to inject the doctype
Returns:
a XML document with a doctype
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 332 of file OntologyCreate.php.

WebService::jsonEncode ( $  string  )  [inherited]

Encode a string to put in a JSON value.

Parameters:
[in] $string The string to escape

Returns:
returns the escaped string
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 398 of file WebService.php.

Referenced by Sparql::pipeline_serialize(), Search::pipeline_serialize(), DatasetRead::pipeline_serialize(), CrudRead::pipeline_serialize(), Browse::pipeline_serialize(), and AuthLister::pipeline_serialize().

OntologyCreate::pipeline_conneg ( $  accept,
$  accept_charset,
$  accept_encoding,
$  accept_language 
)

Do content negotiation as an internal, pipelined, Web Service that is part of a Compound Web Service.


Parameters:
[in] $accept Accepted mime types (HTTP header)
[in] $accept_charset Accepted charsets (HTTP header)
[in] $accept_encoding Accepted encodings (HTTP header)
[in] $accept_language Accepted languages (HTTP header)
Returns:
returns NULL
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 409 of file OntologyCreate.php.

References ws_conneg().

Here is the call graph for this function:

OntologyCreate::pipeline_getError (  ) 

Returns the error structure.


Returns:
returns the error structure
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 305 of file OntologyCreate.php.

OntologyCreate::pipeline_getResponseHeaderStatus (  ) 

Returns the response HTTP header status.


Returns:
returns the response HTTP header status
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 422 of file OntologyCreate.php.

OntologyCreate::pipeline_getResponseHeaderStatusMsg (  ) 

Returns the response HTTP header status message.


Returns:
returns the response HTTP header status message
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 434 of file OntologyCreate.php.

OntologyCreate::pipeline_getResponseHeaderStatusMsgExt (  ) 

Returns the response HTTP header status message extension.


Returns:
returns the response HTTP header status message extension
Note:
The extension of a HTTP status message is
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 448 of file OntologyCreate.php.

OntologyCreate::pipeline_getResultset (  ) 

Create a resultset in a pipelined mode based on the processed information by the Web service.


Returns:
a resultset XML document
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 318 of file OntologyCreate.php.

OntologyCreate::pipeline_serialize (  ) 

Serialize the web service answer.


Returns:
returns the serialized content
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 460 of file OntologyCreate.php.

OntologyCreate::pipeline_serialize_reification (  ) 

Non implemented method (only defined).


Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 470 of file OntologyCreate.php.

OntologyCreate::process (  ) 

Update all ontological structures used by the WSF.


Author:
Frederick Giasson, Structured Dynamics LLC.



Todo:
Fixing this to use the DB.
This method is currently not working. The problem is that we ahve an issue in CrudCreate and Virtuoso's LONG VARCHAR column. It appears that there is a bug somewhere in the "php -> odbc -> virtuoso" path. If we are not requesting to return the LONG VARCHAR column, everything works fine.

Reimplemented from WebService.

Definition at line 521 of file OntologyCreate.php.

References $query, addEquivalentClass(), getUnionOf(), and validateQuery().

Here is the call graph for this function:

OntologyCreate::validateQuery (  )  [protected]

Validate a query to this web service.


Returns:
TRUE if valid; FALSE otherwise
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 272 of file OntologyCreate.php.

References $ws_av.

Referenced by process().

OntologyCreate::ws_conneg ( $  accept,
$  accept_charset,
$  accept_encoding,
$  accept_language 
)

Do content negotiation as an external Web Service.


Parameters:
[in] $accept Accepted mime types (HTTP header)
[in] $accept_charset Accepted charsets (HTTP header)
[in] $accept_encoding Accepted encodings (HTTP header)
[in] $accept_language Accepted languages (HTTP header)
Returns:
returns NULL
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 360 of file OntologyCreate.php.

References $supportedSerializations.

Referenced by pipeline_conneg().

OntologyCreate::ws_respond ( $  content  ) 

Sends the HTTP response to the requester.


Parameters:
[in] $content The content (body) of the response.
Returns:
NULL
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 496 of file OntologyCreate.php.

References __destruct().

Here is the call graph for this function:

OntologyCreate::ws_serialize (  ) 

Serialize the web service answer.


Returns:
returns the serialized content
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 482 of file OntologyCreate.php.

WebService::xmlEncode ( $  string  )  [inherited]

Encode content to be included in XML files.


Parameters:
[in] $string The content string to be encoded
Returns:
returns the encoded string
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 383 of file WebService.php.

Referenced by Sparql::pipeline_getResultset(), Search::pipeline_getResultset(), DatasetRead::pipeline_getResultset(), CrudRead::pipeline_getResultset(), ConverterTsv::pipeline_getResultset(), ConverterIrJSON::pipeline_getResultset(), Browse::pipeline_getResultset(), AuthLister::pipeline_getResultset(), Sparql::pipeline_serialize(), Search::pipeline_serialize(), CrudRead::pipeline_serialize(), ConverterTsv::pipeline_serialize(), ConverterIrJSON::pipeline_serialize(), ConverterBibtex::pipeline_serialize(), Browse::pipeline_serialize(), Search::pipeline_serialize_reification(), CrudRead::pipeline_serialize_reification(), Browse::pipeline_serialize_reification(), CrudUpdate::process(), and CrudCreate::process().

Member Data Documentation

OntologyCreate::$action = "" [private]

Additional action that can be performed when adding a new ontology: (1) recreate_inference.

Definition at line 53 of file OntologyCreate.php.

Referenced by __construct().

OntologyCreate::$conneg [private]

Conneg object that manage the content negotiation capabilities of the web service.

Definition at line 33 of file OntologyCreate.php.

WebService::$crud_usage [protected, inherited]

The CRUD usage of the Authentication Registrar web service.

Definition at line 95 of file WebService.php.

Referenced by AuthRegistrarWs::ws_conneg().

WebService::$data_ini = "/data/" [static, inherited]

data.ini file folder

Definition at line 34 of file WebService.php.

Referenced by WebService::__construct(), and Logger::__construct().

OntologyCreate::$db [private]

Database connection.

Definition at line 30 of file OntologyCreate.php.

WebService::$db_dsn = "" [protected, inherited]

Database DSN connection.

Definition at line 46 of file WebService.php.

WebService::$db_host = "localhost" [protected, inherited]

Database host.

Definition at line 49 of file WebService.php.

WebService::$db_password = "" [protected, inherited]

Database password.

Definition at line 43 of file WebService.php.

WebService::$db_username = "" [protected, inherited]

Database user name.

Definition at line 40 of file WebService.php.

WebService::$dtdBaseURL = "" [protected, inherited]

DTD URL of the web service.

Definition at line 52 of file WebService.php.

OntologyCreate::$dtdURL [private]

URL where the DTD of the XML document can be located on the Web.

Definition at line 36 of file OntologyCreate.php.

WebService::$endpoint [protected, inherited]

The endpoint of the Authentication Registrar web service.

Definition at line 98 of file WebService.php.

OntologyCreate::$errorMessenger [private]

Error messages of this web service.

Definition at line 62 of file OntologyCreate.php.

WebService::$log_table = "SD.WSF.ws_queries_log" [protected, inherited]

Name of the logging table on the Virtuoso instance.

Definition at line 79 of file WebService.php.

OntologyCreate::$mime = "" [private]

Mime of the Ontology RDF document serialization.

Definition at line 50 of file OntologyCreate.php.

Referenced by __construct().

WebService::$network_ini = "/usr/share/structwsf/" [static, inherited]

network.ini file folder

Definition at line 37 of file WebService.php.

Referenced by WebService::__construct().

WebService::$ontological_structure_folder = "" [protected, inherited]

Path to the structWSF ontological structure.

Definition at line 76 of file WebService.php.

WebService::$ontologies_files_folder = "" [protected, inherited]

Path to the ontologies description files (in RDFS and OWL).

Definition at line 70 of file WebService.php.

OntologyCreate::$ontology = array() [private]

Ontology RDF document. Maximum size (by default) is 8M (default php.ini setting).

Definition at line 47 of file OntologyCreate.php.

Referenced by __construct().

OntologyCreate::$registered_ip = "" [private]

IP being registered.

Definition at line 44 of file OntologyCreate.php.

Referenced by __construct().

OntologyCreate::$requester_ip = "" [private]

Requester's IP used for request validation.

Definition at line 56 of file OntologyCreate.php.

Referenced by __construct().

OntologyCreate::$rulesSetURI = "" [private]

URI of the inference rules set to use to create the ontological structure.

Definition at line 59 of file OntologyCreate.php.

WebService::$solr_auto_commit = FALSE [protected, inherited]

Auto commit handled by the Solr data management systems. If this parameter is true, then this means Solr will handle the commit operation by itself. If it is false, then the web services will trigger the commit operations. Usually, Auto-commit should be handled by Solr when the size of the dataset is too big, otherwise operation such as delete could take much time.

Definition at line 86 of file WebService.php.

WebService::$solr_host = "localhost" [protected, inherited]

Hostname where to send queries to the Solr instance.

Definition at line 73 of file WebService.php.

OntologyCreate::$supportedSerializations [static]

Initial value:

    array ("application/json", "application/rdf+xml", "application/rdf+n3", "application/*", "text/xml", "text/*",
      "*/*")
Supported serialization mime types by this Web service.

Definition at line 39 of file OntologyCreate.php.

Referenced by ws_conneg().

WebService::$title [protected, inherited]

The Title of the Authentication Registrar web service.

Definition at line 92 of file WebService.php.

Referenced by DatasetUpdate::__construct(), and DatasetRead::process().

WebService::$uri [protected, inherited]

The URI of the Authentication Registrar web service.

Definition at line 89 of file WebService.php.

Referenced by DatasetUpdate::__construct(), DatasetRead::__construct(), DatasetDelete::__construct(), DatasetCreate::__construct(), CrudRead::__construct(), CrudDelete::__construct(), ConverterBibtex::get_uri_label(), Sparql::getNamespace(), Search::getNamespace(), DatasetRead::getNamespace(), CrudRead::getNamespace(), ConverterTsv::getNamespace(), ConverterIrJSON::getNamespace(), Browse::getNamespace(), Sparql::pipeline_getResultset(), Search::pipeline_getResultset(), ConverterTsv::pipeline_getResultset(), ConverterIrJSON::pipeline_getResultset(), Browse::pipeline_getResultset(), ConverterIrJSON::pipeline_serialize(), Search::process(), CrudUpdate::process(), CrudCreate::process(), Browse::process(), AuthRegistrarAccess::process(), DatasetRead::uriEncode(), ConverterTsv::uriEncode(), ConverterIrJSON::uriEncode(), ConverterBibtex::uriEncode(), and AuthRegistrarAccess::uriEncode().

WebService::$wsf_base_path = "" [protected, inherited]

Local server path of the WSF files.

Definition at line 61 of file WebService.php.

WebService::$wsf_base_url = "" [protected, inherited]

Base URL of the WSF.

Definition at line 58 of file WebService.php.

WebService::$wsf_graph = "" [protected, inherited]

The graph where the Web Services Framework description has been indexed.

Definition at line 55 of file WebService.php.

WebService::$wsf_local_ip = "" [protected, inherited]

Local server path of the WSF files.

Definition at line 64 of file WebService.php.

WebService::$wsf_solr_core = "" [protected, inherited]

The core to use for Solr; "" for no core.

Definition at line 67 of file WebService.php.

The documentation for this class was generated from the following file:
Copyright © 2009. Structured Dynamics LLC Structured Dynamics LLC. All rights reserved.