Browse Class Reference

Browse Web Service. It browses datasets by using three filtering properties: (1) datasets, (2) types and (3) attributes. More...

Inherits WebService.

Collaboration diagram for Browse:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($attributes, $types, $datasets, $items, $page, $inference, $include_aggregates, $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 ()
 Send the browse query to the system supporting this web service (usually Solr) and aggregate browsed information.
 xmlEncode ($string)
 Encode content to be included in XML files.
 jsonEncode ($string)
 Encode a string to put in a JSON value.

Public Attributes

 $subjectTriples = array()
 Array of triples where the current resource is a subject.
 $objectTriples = array()
 Array of triples where the current resource is an object.
 $resultset = array()
 Resultset returned by Solr.
 $resultsetObjectProperties = array()
 Resultset of object properties returned by Solr.
 $resultsetObjectPropertiesUris = array()
 Resultset of object properties URIs returned by Solr.
 $aggregates = array()
 Aggregates of the browse.
 $include_aggregates = array()
 Include aggregates to the resultset.

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

 getNamespace ($uri)
 Get the namespace of a URI.

Private Attributes

 $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.
 $attributes = ""
 List of attributes to filter.
 $types = ""
 List of types to filter.
 $datasets = ""
 List of datasets to browse.
 $items = ""
 Number of items to return per page.
 $page = ""
 Page number to return.
 $inference = ""
 Enabling the inference engine.
 $requester_ip = ""
 IP of the requester.
 $registered_ip = ""
 Requested IP.
 $namespaces
 Namespaces/Prefixes binding.
 $errorMessenger
 Error messages of this web service.

Detailed Description

Browse Web Service. It browses datasets by using three filtering properties: (1) datasets, (2) types and (3) attributes.


Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 27 of file Browse.php.

Constructor & Destructor Documentation

Browse::__construct ( $  attributes,
$  types,
$  datasets,
$  items,
$  page,
$  inference,
$  include_aggregates,
$  registered_ip,
$  requester_ip 
)

Constructor.

Initialize the Auth Web Service

Parameters:
[in] $attributes List of filtering attributes (property) URIs separated by ";"
[in] $types List of filtering types URIs separated by ";"
[in] $datasets List of filtering datasets URIs separated by ";"
[in] $items Number of items returned by resultset
[in] $page Starting item number of the returned resultset
[in] $inference Enabling inference on types
[in] $include_aggregates Including aggregates with returned resultsets
[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 131 of file Browse.php.

References $attributes, $datasets, $include_aggregates, $inference, $items, $page, $registered_ip, $requester_ip, $types, and WebService::__construct().

Here is the call graph for this function:

Browse::__destruct (  ) 

Reimplemented from WebService.

Definition at line 182 of file Browse.php.

Referenced by ws_respond().

Member Function Documentation

Browse::getNamespace ( $  uri  )  [private]

Get the namespace of a URI.

Parameters:
[in] $uri Uri of the resource from which we want the namespace

Returns:
returns the extracted namespace
Author:
Frederick Giasson, Structured Dynamics LLC.



Definition at line 930 of file Browse.php.

References WebService::$uri.

Referenced by pipeline_serialize().

Browse::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 493 of file Browse.php.

Referenced by pipeline_getResultset().

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(), pipeline_serialize(), and AuthLister::pipeline_serialize().

Browse::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 563 of file Browse.php.

References ws_conneg().

Here is the call graph for this function:

Browse::pipeline_getError (  ) 

Returns the error structure.


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



Reimplemented from WebService.

Definition at line 214 of file Browse.php.

Browse::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 576 of file Browse.php.

Browse::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 588 of file Browse.php.

Browse::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 602 of file Browse.php.

Browse::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 227 of file Browse.php.

References Namespaces::$iron, $resultset, $type, WebService::$uri, injectDoctype(), and WebService::xmlEncode().

Referenced by pipeline_serialize(), pipeline_serialize_reification(), and ws_serialize().

Here is the call graph for this function:

Browse::pipeline_serialize (  ) 

Serialize the web service answer.


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



Reimplemented from WebService.

Definition at line 614 of file Browse.php.

References getNamespace(), WebService::jsonEncode(), pipeline_getResultset(), and WebService::xmlEncode().

Referenced by ws_serialize().

Here is the call graph for this function:

Browse::pipeline_serialize_reification (  ) 

Non implemented method (only defined).


Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 980 of file Browse.php.

References pipeline_getResultset(), and WebService::xmlEncode().

Referenced by ws_serialize().

Here is the call graph for this function:

Browse::process (  ) 

Send the browse query to the system supporting this web service (usually Solr) and aggregate browsed information.


Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 1161 of file Browse.php.

References $attributes, $dataset, $datasets, $resultset, $type, $types, WebService::$uri, and $ws_al.

Browse::validateQuery (  )  [protected]

Validate a query to this web service.


Returns:
TRUE if valid; FALSE otherwise
Note:
This function is not used by the authentication validator web service
Author:
Frederick Giasson, Structured Dynamics LLC.



Reimplemented from WebService.

Definition at line 196 of file Browse.php.

Referenced by ws_conneg().

Browse::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 521 of file Browse.php.

References $supportedSerializations, and validateQuery().

Referenced by pipeline_conneg().

Here is the call graph for this function:

Browse::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 1135 of file Browse.php.

References __destruct().

Here is the call graph for this function:

Browse::ws_serialize (  ) 

Serialize the web service answer.


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



Reimplemented from WebService.

Definition at line 1079 of file Browse.php.

References pipeline_getResultset(), pipeline_serialize(), and pipeline_serialize_reification().

Here is the call graph for this function:

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(), pipeline_getResultset(), AuthLister::pipeline_getResultset(), Sparql::pipeline_serialize(), Search::pipeline_serialize(), CrudRead::pipeline_serialize(), ConverterTsv::pipeline_serialize(), ConverterIrJSON::pipeline_serialize(), ConverterBibtex::pipeline_serialize(), pipeline_serialize(), Search::pipeline_serialize_reification(), CrudRead::pipeline_serialize_reification(), pipeline_serialize_reification(), CrudUpdate::process(), and CrudCreate::process().

Member Data Documentation

Browse::$aggregates = array()

Aggregates of the browse.

Definition at line 81 of file Browse.php.

Browse::$attributes = "" [private]

List of attributes to filter.

Definition at line 36 of file Browse.php.

Referenced by __construct(), and process().

Browse::$conneg [private]

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

Definition at line 30 of file Browse.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().

Browse::$datasets = "" [private]

List of datasets to browse.

Definition at line 42 of file Browse.php.

Referenced by __construct(), and process().

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.

Browse::$dtdURL [private]

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

Definition at line 33 of file Browse.php.

WebService::$endpoint [protected, inherited]

The endpoint of the Authentication Registrar web service.

Definition at line 98 of file WebService.php.

Browse::$errorMessenger [private]

Initial value:

    '{
                        "ws": "/ws/browse/",
                        "_200": {
                          "id": "WS-BROWSE-200",
                          "level": "Warning",                          
                          "name": "Invalid number of items requested",
                          "description": "The number of items returned per request has to be greater than 0 and lesser than 128"
                        },
                        "_300": {
                          "id": "WS-BROWSE-300",
                          "level": "Warning",
                          "name": "No datasets accessible by that user",
                          "description": "No datasets are accessible to that user"
                        }  
                      }'
Error messages of this web service.

Definition at line 92 of file Browse.php.

Browse::$include_aggregates = array()

Include aggregates to the resultset.

Definition at line 84 of file Browse.php.

Referenced by __construct().

Browse::$inference = "" [private]

Enabling the inference engine.

Definition at line 51 of file Browse.php.

Referenced by __construct().

Browse::$items = "" [private]

Number of items to return per page.

Definition at line 45 of file Browse.php.

Referenced by __construct().

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.

Browse::$namespaces [private]

Initial value:

    array ("http://www.w3.org/2002/07/owl#" => "owl", "http://www.w3.org/1999/02/22-rdf-syntax-ns#" => "rdf",
      "http://www.w3.org/2000/01/rdf-schema#" => "rdfs", "http://purl.org/ontology/wsf#" => "wsf")
Namespaces/Prefixes binding.

Definition at line 60 of file Browse.php.

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

network.ini file folder

Definition at line 37 of file WebService.php.

Referenced by WebService::__construct().

Browse::$objectTriples = array()

Array of triples where the current resource is an object.

Definition at line 69 of file Browse.php.

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.

Browse::$page = "" [private]

Page number to return.

Definition at line 48 of file Browse.php.

Referenced by __construct().

Browse::$registered_ip = "" [private]

Requested IP.

Definition at line 57 of file Browse.php.

Referenced by __construct().

Browse::$requester_ip = "" [private]

IP of the requester.

Definition at line 54 of file Browse.php.

Referenced by __construct().

Browse::$resultset = array()

Resultset returned by Solr.

Definition at line 72 of file Browse.php.

Referenced by pipeline_getResultset(), and process().

Browse::$resultsetObjectProperties = array()

Resultset of object properties returned by Solr.

Definition at line 75 of file Browse.php.

Browse::$resultsetObjectPropertiesUris = array()

Resultset of object properties URIs returned by Solr.

Definition at line 78 of file Browse.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.

Browse::$subjectTriples = array()

Array of triples where the current resource is a subject.

Definition at line 66 of file Browse.php.

Browse::$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 87 of file Browse.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().

Browse::$types = "" [private]

List of types to filter.

Definition at line 39 of file Browse.php.

Referenced by __construct(), and 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(), getNamespace(), Sparql::pipeline_getResultset(), Search::pipeline_getResultset(), ConverterTsv::pipeline_getResultset(), ConverterIrJSON::pipeline_getResultset(), pipeline_getResultset(), ConverterIrJSON::pipeline_serialize(), Search::process(), CrudUpdate::process(), CrudCreate::process(), 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.