1. Load an owl file with jOWL.load
2. Upon completion of load, visualize content by querying on the document with jOWL(), and using either custom made representations or any of the jOWL.UI (user Interface) components.

Queries an OWL document loaded with jOWL.load for an OntologyObject with reference equal to 'resource'. Returns a kind of jOWL Ontology Object. Example:

jOWL("wine");

Additional Options

Initializes/resets jOWL with an OWL-RDFS document.

Optional Parameters

• path: relative path to the owl document, example: "data/jOWL.owl"
• callback: function that is triggered when documents is loaded.
• options: JSON object with options.
  • onParseError: function(msg){}; function to be called when parsing fails
  • reason : true/false, default true
  • locale: set preferrence language, examples en, fr. Is only useful if rdfs:labels are associated with different xml:lang attributes.

jOWL.load("path", function(){
declare all your logic inside this function
}, options);

initialize jOWL with an existing OWL DOM document. Most users will have no need for this function. See jOWL.load instead.

Optional Parameters

Returns a String representation of the OWL-RDFS document.

Optional Parameters

• xmlNode: if specified, only serializes that part of the DOM to String

Without arguments this function will parse the current url and see if any parameters are defined, returns a JOWL object. With argument it will return a string that identifies the potential permalink fr the given entry.

Ontology Elements

Common Functions and Objects

• description(options):
  Returns the content of all specified rdfs:comments that apply to this object.
  options: {split: true} : will wrap each individual comment in 'div' tags

  jOWL('someclass').description({split: true});

• label():
  Returns a good representation name for this object. If jOWL.options.locale is specified then it will try to match the label against that preference.

  jOWL('someclass').label();

• bind(jqelem):
  jqelem is a jQuery html element. This function updates the html element with the name of the jOWL object and more. For visualisation purposes.

  jOWL('someclass').bind($('.someClass'));

• jnode:
  jQuery element that contains the OWL syntax.
• type
  Type of Ontology element, owl:Class, owl:Thing, ...
• baseURI
  The namespace of the ontology element.
• name
  The identifier of the ontology element.

jOWL javascript equivalent to an owl:Class

Functions and Objects

• parents():
  Returns a jOWL.Ontology.Array containing this class' direct parents.
• children():
  Returns a jOWL.Ontology.Array containing this class' direct children.
• descendants(level):
  Returns a jOWL.Ontology.Array containing this class' descendants, level is a number that specifies how deep to search (1 equals direct children only). The argument level is optional, default 5.
• hierarchy(options):
  Constructs the entire hierarchy (parents and ancestors) for this owl:Class (see jOWL.UI.Tree as an example). Returns a jOWL.Ontology.Array containing top nodes (classes directly subsumed by 'owl:Thing'). Each node with exception of the leaves (original concept) has a variable invParents (jOWL.Ontology.Array) with child references.
  If options.prune (default true): Performs some additional reasoning to cut down redundant nodes.
• sourceof(restriction):
  TBW.
  .
• valueRestrictions(includeAll):
  TBW.
  .
• individuals():
  TBW.
  .

Documentation in progress.

Documentation in progress.

Documentation in progress.

Documentation in progress.

Documentation in progress.

• reason: default true, enable advanced reasoning (on parents, children, etc...).
• locale: default false, specify a locale to give preference on visualising rdfs:label's belonging to a certain language. Example: locale: 'fr' set's preference to french terms (if available).
• defaultlocale: default 'en', e.g. English.
• onParseError(msg): customizable function, get's called when something is wrong with the syntax of the OWL file.
• cacheProperties: default true, enables faster access to properties.
• niceClassLabels: default true, if no rdfs:labels are found for a given owl:Class, uses some regexp functions to format a more elegant label out of the identifier.
• dictionary: do not overwrite this object, but alter the two settings below instead:
  • dictionary.create: default true, creates a dictionary, used for the autcomplete functionality.
  • dictionary.addID: default true, add identifiers of the ontology objects to the dictionary as well, under the language specified by 'defaultlocale'. If the identifiers are of the form XX45458 (e.g. numeric code), then it might be more efficient to disable their inclusion.

All user interface components can be re-styled, but for some basic css see the jOWL_xx.css file. All user interface components share 3 important functions:

• addListener(component): Where component is either another UI component, or an array of UI components. The specified components will respond to selection events in the current components.
• broadcast(jOWLObject): Will update all listening (see above) components with the specified jOWLObject.
• propertyChange: Will update this component with the specified jOWLObject. Each component has it's own implementation. Only override if you know what you are doing.

      var navbar = $('someelement').owl_navbar();
      var tree = $('someelement').owl_treeview();
      tree.addListener(navbar);
      

Uses jQuery syntax. Only accepts owl:Class entries. Example:

$('someelement').owl_navbar();

options

Uses jQuery syntax. Only accepts owl:Class entries. Example:

$('someelement').owl_treeview();

options

• rootThing: true/false - default false; if true then topnode is (owl) 'Thing'
• isStatic: true/false - default false; if static then selections will refresh the entire tree
• addChildren: true/false - default false; add a given objects children to the treeview as well
• onSelect: function that can be overwritten to specfy specific behavior when something is selected

Uses jQuery syntax. Should be bound to an 'input' html element of the type 'text'. Example:

$('someinputelement').owl_autocomplete();

options

• time: responsetime to check for new keystrokes, default 500
• chars: number of characters needed before autocomplete starts searching, default 3
• focus: put cursor on the input field when loading, default false
• limit: limit size of result list to given amount, default 10

Uses jQuery syntax. Only responds to owl:Class entries, shows matching owl:Thing's. Example:

$('someinputelement').owl_individuals();

options

• title: display the owl:Class name on top, default true
• tooltip: default false, display additional info in a tooltip, requires the tooltip script.
• html: if tooltip is enabled, the function that renders the html of the tooltip.

Uses jQuery syntax. Example:

$('someinputelement').owl_custom(function(jOWLObject, element){
      //define logic here
      });

custom function: Argument 'jOWLObject' corresponds to the jOWLObject that fired up this component as a consequence of a selection event. Argument 'element' correspond to the jQuery element that wraps this component. For a better example of usage, see source of this page.