Internally Generated Schema

From OSF Wiki
Jump to: navigation, search

Generate All is one of the options when using structOntology; it (re)creates the serializations files used internally by the system and which are derived from the various ontologies used in an Open Semantic Framework (OSF) installation. These serialization files include the .SRZ files used by OSF Web Service and OSF-Drupal; the ironXML and ironJSON schema used by the OSF widgets, etc. A general overview of these various structures is provided by the OSF Web Service Internal Resultset Structure document.

This document describes the specific structures (or schema) produced when the structOntology Generate All option is invoked.

Classes/Properties Structure

  • Classes hierarchy
  • Properties hierarchy

ironXML Schema

structXML is a straightforward RDF serialization in XML format used for internal communications between OSF Web Service Web services, the Flex Semantic Components and OSF-Drupal. It is one of the core formats used to transmit information between Flex-based (OSF) components.

A structXMLfile is composed of a resultset object which aggregates a series of subjects (records) that are defined with properties and values. Values can be "data" values such as literals or "object" values that are reference to other subjects.

The Generate All produces the ironXML schema -- that is, the definitions of the structXML properties -- upon which these results sets get produced in structXML.

ironJSON Schema

structJSON is a straightforward RDF serialization in JSON format used for internal communications between OSF Web Service Web services, the JavaScript Semantic Components and OSF-Drupal. It is one of the core formats used to transmit information between JavaScript-based (OSF) components.

A structJSON file is composed of a resultset object which aggregates a series of subjects (records) that are defined with properties and values. Values can be "data" values such as literals or "object" values that are reference to other subjects.

The Generate All produces the ironJSON schema -- that is, the definitions of the structJSON properties -- upon which these results sets get produced in structJSON.

OSF Tagger (in progress)

An intermediate structure to "drive" the GATE text engine underneath the OSF Tagger (scones) is presently under development. When completed, this structure too will be generated via the Generate All option.

A Note Regarding Other Structures

Not all OSF widgets are driven strictly from these internal structures. The sRelationBrowser and the sWebMap may also be controlled as to what is displayed using various SCO Ontology predicates. ignoredBy is one prominent example of such a property. See further the SCO Ontology document.