Open Semantic Framework PHP API  3.0
 All Data Structures Namespaces Files Functions Variables Pages
GetSubClassesFunction Class Reference

Class used to define the parameters to use send a "getSubClasses" call to the Ontology: Read web service endpoint. More...

Inheritance diagram for GetSubClassesFunction:

Public Member Functions

 __construct ()
 
 uri ($uri)
 URI of the class for which the requester want its sub-classes. More...
 
 getClassesUris ()
 Get a list of URIs that refers to the sub-classes described in this ontology. More...
 
 getClassesDescriptions ()
 Get the list of classes description for the sub-classes described in this ontology. More...
 
 getHierarchy ()
 Get the list of classes description for the sub-classes described in this ontology. More...
 
 directSubClasses ()
 Only get the direct sub-classes of the target class. More...
 
 allSubClasses ()
 Get all the sub-classes by inference (so, the sub-classes of the sub-classes recursively). More...
 

Detailed Description

Class used to define the parameters to use send a "getSubClasses" call to the Ontology: Read web service endpoint.

See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 20 of file GetSubClassesFunction.php.

Constructor & Destructor Documentation

__construct ( )

Definition at line 22 of file GetSubClassesFunction.php.

Member Function Documentation

allSubClasses ( )

Get all the sub-classes by inference (so, the sub-classes of the sub-classes recursively).

See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 120 of file GetSubClassesFunction.php.

directSubClasses ( )

Only get the direct sub-classes of the target class.

See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 105 of file GetSubClassesFunction.php.

getClassesDescriptions ( )

Get the list of classes description for the sub-classes described in this ontology.

See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 68 of file GetSubClassesFunction.php.

getClassesUris ( )

Get a list of URIs that refers to the sub-classes described in this ontology.

See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 54 of file GetSubClassesFunction.php.

getHierarchy ( )

Get the list of classes description for the sub-classes described in this ontology.

The class description being returned is a lightweight version of the full "descriptions" mode. The goal is to manipulate and transmit a simpler structure such as what might be used by a user interface to display some parts of the hierarchy of an ontology. What is returned is all the annotation properties (used to get some label to display for one of the sub-class) and a possible attribute: "sco:hasSubClass" which has "true" as value. If this triple exists, it means that the sub-class has itself other subclasses (this is mainly used to be able to display an "extend" button in a tree control).

See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 91 of file GetSubClassesFunction.php.

uri (   $uri)

URI of the class for which the requester want its sub-classes.

Required: This function must be called before sending the query

Parameters
mixed$uriURI of the class for which the requester want its sub-classes.
See also
http://wiki.opensemanticframework.org/index.php/Ontology_Read#getSubClasses
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 40 of file GetSubClassesFunction.php.