COLLADA 1.4 DOM: daeURIResolver Class Reference

COLLADA

previous page next page
Main Page | Class Hierarchy | Class List | Directories | Class Members | Related Pages

daeURIResolver Class Reference

#include <daeURI.h>

Inheritance diagram for daeURIResolver:

Inheritance graph
[legend]
Collaboration diagram for daeURIResolver:

Collaboration graph
[legend]
List of all members.

Detailed Description

The daeURIResolver class is the plugin point for URI resolution.

This class is an abstract base class that defines an interface for resolving URIs. All instances of daeURIResolvers are tracked centrally. Every URI is passed through this list of daeURIResolvers for resolution. Before a daeURIResolver receives a URI, the API checks whether it supports the protocol. The list is ordered on a first come, first serve basis, and resolution terminates after any resolver instance resolves the URI.

Public Member Functions

 daeURIResolver ()
 This base constructor appends this to KnownResolvers list.
virtual ~daeURIResolver ()
 Destructor.
virtual daeBool resolveElement (daeURI &uri)=0
 Provides an abstract interface for converting a daeURI into a daeElement.
virtual daeBool resolveURI (daeURI &uri)=0
 Provides an abstract interface for converting a daeElement into a daeURI.
virtual daeString getName ()=0
 Gets the name of this resolver.
virtual daeBool isProtocolSupported (daeString protocol)=0
 Determines whether this resolver supports a particular protocol for resolution.
virtual daeBool isExtensionSupported (daeString extension)=0
 Determines whether this resolver supports the given extension.

Static Public Member Functions

static void attemptResolveElement (daeURI &uri)
 Iterates through known resolvers calling isProtocolSupported() and, if it is supported, calling resolveElement().
static void attemptResolveURI (daeURI &uri)
 Iterates through known resolvers calling isProtocolSupported() and, if it is supported, calling resolveURI().

Static Protected Attributes

static daeURIResolverPtrArray _KnownResolvers

Member Function Documentation

void daeURIResolver::attemptResolveElement (  daeURI &  uri  )  [static]
 

Iterates through known resolvers calling isProtocolSupported() and, if it is supported, calling resolveElement().

Parameters:
uri daeURI to resolve.

void daeURIResolver::attemptResolveURI (  daeURI &  uri  )  [static]
 

Iterates through known resolvers calling isProtocolSupported() and, if it is supported, calling resolveURI().

Parameters:
uri daeURI to resolve.

virtual daeString daeURIResolver::getName (   )  [pure virtual]
 

Gets the name of this resolver.

Returns:
Returns the resolver name as a string.

Implemented in daebXCeResolver, and daeLIBXMLResolver.

virtual daeBool daeURIResolver::isExtensionSupported (  daeString  extension  )  [pure virtual]
 

Determines whether this resolver supports the given extension.

This keeps parsers from trying to process incompatible file formats.

Parameters:
extension Extension string found after the '.' in the file name.
Returns:
Returns true if the given extension is supported, returns false otherwise.

Implemented in daebXCeResolver, and daeLIBXMLResolver.

virtual daeBool daeURIResolver::isProtocolSupported (  daeString  protocol  )  [pure virtual]
 

Determines whether this resolver supports a particular protocol for resolution.

Parameters:
protocol Determine whether the resolver supports this protocol.
Returns:
Returns true if this daeURIResolver understands how to resolve using this protocol, returns false otherwise

Implemented in daebXCeResolver, and daeLIBXMLResolver.

virtual daeBool daeURIResolver::resolveElement (  daeURI &  uri  )  [pure virtual]
 

Provides an abstract interface for converting a daeURI into a daeElement.

Parameters:
uri daeURI to resolve.
Returns:
Returns true if the daeURIResolver successfully resolved the URI, returns false otherwise.

Implemented in daebXCeResolver, and daeLIBXMLResolver.

virtual daeBool daeURIResolver::resolveURI (  daeURI &  uri  )  [pure virtual]
 

Provides an abstract interface for converting a daeElement into a daeURI.

Parameters:
uri daeURI to resolve.
Returns:
Returns true if the daeURIResolver successfully resolved the element into a URI, returns false otherwise.

Implemented in daebXCeResolver, and daeLIBXMLResolver.

The documentation for this class was generated from the following files:
  • C:/SVN_wf/COLLADA_DOM/include/dae/daeURI.h
  • C:/SVN_wf/COLLADA_DOM/src/dae/daeURI.cpp
©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:47:04 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page