Difference between revisions of "DOM resolver subsystem"

From COLLADA Public Wiki
Jump to navigation Jump to search
(→‎DOM URI class (daeURI): more editing of material copied in)
Line 24: Line 24:
  
 
===DOM URI class (daeURI)===
 
===DOM URI class (daeURI)===
The DOM URI class, <code>daeURI</code>, is part of the DOM resolver subsystem. It represents a [[URI]] data type in a [[COLLADA document]].
+
The DOM URI class, <code>daeURI</code>, is part of the DOM resolver subsystem. It represents a [[URI]] data type in a [[COLLADA document]]. Some internal notes about the class:
  
URI state – "empty" is a default constructed URI.
+
URI strings are parsed in <code>internalSetURI</code>.
 
 
URI state - "loaded" is when there is a URI string but it hasn’t been normalized.
 
 
 
URI strings are parsed in <code>internalSetURI</code>
 
 
 
<code>validate</code> is the function that normalizes a URI string.
 
  
 
The <code>baseURI</code> is constructed from the current working directory (cwd) (where available) when the <code>daeURI( int )</code> constructor is called.
 
The <code>baseURI</code> is constructed from the current working directory (cwd) (where available) when the <code>daeURI( int )</code> constructor is called.
Line 38: Line 32:
 
The <code>daeElement</code> container is the element that holds the <code>daeURI</code> as either an attribute or value.
 
The <code>daeElement</code> container is the element that holds the <code>daeURI</code> as either an attribute or value.
  
<code>validate</code> normalizes the URI string against one of (listed in priority):
+
The <code>validate</code> method normalizes a URI string. It is called when attempting to resolve the URI, in the copy constructor, when the <code>noFrag</code> flag is true in the constructor, when attempting to <code>makeRelativePath</code>, during <code>resolveURI</code>. {{editor|what= If this is a list of 5 different things, change to bulleted list. If fewer than 5, make into list with items combined appropriately. }} It normalizes the URI string against one of (listed in priority):
 
* The URI string passed in as an argument
 
* The URI string passed in as an argument
 
* The <code>documentURI</code> (taken from the container element if present)
 
* The <code>documentURI</code> (taken from the container element if present)
 
* The static baseURI (cwd)
 
* The static baseURI (cwd)
 
URI state – pending is after the URI is normalized but before it is resolved
 
 
<code>validate</code> is called when attempting to resolve the URI, in the copy constructor, when the <code>noFrag</code> flag is true in the constructor, when attempting to makeRelativePath, during resolveURI.
 
  
 
The DOM always operates on fully normalized absolute URIs.
 
The DOM always operates on fully normalized absolute URIs.
  
<code>resolveElement</code> calls <code>daeURIResolver attemptResolveElement</code> (see below)
+
<code>resolveElement</code> calls <code>daeURIResolver attemptResolveElement</code>.
  
URI state success, failed_unsupprted_protocol, failed_file_not_found, failed_id_not_found, failed_missing_containter, and failed_external_document are all valid states after <code>attemptResolve</code>.  
+
The URI state returns various URI status values, including:
 +
* "empty": A default constructed URI.
 +
* "loaded": A URI string exists but it hasn’t been normalized.
 +
* "pending": The URI is normalized but hasn't yet been resolved.
 +
* "success", "failed_unsupprted_protocol", "failed_file_not_found", "failed_id_not_found", "failed_missing_containter", and "failed_external_document":  Possible states after <code>attemptResolve</code>. {{editor|what=[[DOM guide: Resolving URIs]] mentions states like "uri_pending, uri_failed_*", and so on. Are these the same ones? If so, fix either these or those to correct values. Also, can we replace "the URI state returns" with "The <code>daeURI::getState</code> method returns"?}}
  
 
===DOM resolver class (daeURIResolver)===
 
===DOM resolver class (daeURIResolver)===

Revision as of 03:48, 25 May 2007

Summary: The resolver subsystem manages the resolution of URIs based on a URI's scheme and filename extensions.

Purpose

The resolver subsystem allows for custom URI resolvers to be written and added to the COLLADA DOM. These resolvers can be used to load various types of external references-- for example, binary representations of mesh data--or to provide access to different data systems--for example, using a database to access elements.

Default behavior

By default, the COLLADA DOM has only two resolvers:

  • The main resolver, daeLIBXMLResolver, resolves elements from COLLADA documents (.dae or .xml) with the file or http URI scheme. This can resolve elements from the same document or external document references.

Instantiating an object of a class that inherits from daeURIResolver adds a custom resolver to the COLLADA DOM.

How it works

The base class daeURIResolver contains a static array named _KnownResolvers that contains resolvers. The constuctor for daeURIResolver adds a reference to this to this list of resolvers. When a DOM URI class attempts to resolve itself, it searches through the _KnownResolvers list for a resolver that matches its URI scheme and file extension. When an appropriate resolver is found, the resolver is then asked to resolve the current URI.

Related classes and functions

  • DOM URI class: The class used to represent URIs in a COLLADA document.
  • DOM resolver class: An interface to inherit from for creating URI resolvers.

DOM URI class (daeURI)

The DOM URI class, daeURI, is part of the DOM resolver subsystem. It represents a URI data type in a COLLADA document. Some internal notes about the class:

URI strings are parsed in internalSetURI.

The baseURI is constructed from the current working directory (cwd) (where available) when the daeURI( int ) constructor is called.

The daeElement container is the element that holds the daeURI as either an attribute or value.

The validate method normalizes a URI string. It is called when attempting to resolve the URI, in the copy constructor, when the noFrag flag is true in the constructor, when attempting to makeRelativePath, during resolveURI. ((EDITOR: This page needs the following improvement: If this is a list of 5 different things, change to bulleted list. If fewer than 5, make into list with items combined appropriately. ))

It normalizes the URI string against one of (listed in priority):
  • The URI string passed in as an argument
  • The documentURI (taken from the container element if present)
  • The static baseURI (cwd)

The DOM always operates on fully normalized absolute URIs.

resolveElement calls daeURIResolver attemptResolveElement.

The URI state returns various URI status values, including:

  • "empty": A default constructed URI.
  • "loaded": A URI string exists but it hasn’t been normalized.
  • "pending": The URI is normalized but hasn't yet been resolved.
  • "success", "failed_unsupprted_protocol", "failed_file_not_found", "failed_id_not_found", "failed_missing_containter", and "failed_external_document": Possible states after attemptResolve.

((EDITOR: This page needs the following improvement: DOM guide: Resolving URIs mentions states like "uri_pending, uri_failed_*", and so on. Are these the same ones? If so, fix either these or those to correct values. Also, can we replace "the URI state returns" with "The daeURI::getState method returns"? ))


DOM resolver class (daeURIResolver)

Some internal notes about this class:

  • daeLibxmlResolver and daeRawResolver inherit from the DOM resolver base class, daeURIResolver.
  • _loadExternalDocuments is a flag that an application can control for whether URI resolution loads documents.
  • attemptResolveElement iterates over the list of _KnownResolvers and, if the protocol (URI scheme) and document extension are supported, it calls resolveElement on the resolver.

Note: attemptResolveURI is never called. It is dead.

Future: This is a good system but the program flow should be structured differently. See DOM future work.


COLLADA DOM - Version 2.4 Historical Reference
List of main articles under the DOM portal.
User Guide chapters:  • Intro  • Architecture  • Setting up  • Working with documents  • Creating docs  • Importing docs  • Representing elements  • Working with elements  • Resolving URIs  • Resolving SIDs  • Using custom COLLADA data  • Integration templates  • Error handling

Systems:  • URI resolver  • Meta  • Load/save flow  • Runtime database  • Memory • StringRef  • Code generator
Additional information:  • What's new  • Backward compatibility  • Future work
Terminology categories:  • COLLADA  • DOM  • XML