http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XMLRefInfo Class Reference

This class provides a simple means to track ID Ref usage. More...

#include <XMLRefInfo.hpp>

List of all members.

Public Methods

bool getDeclared () const
const XMLCh* getRefName () const
bool getUsed () const
void setDeclared (const bool newValue)
void setUsed (const bool newValue)
XMLCh* getKey () const
Constructor
 XMLRefInfo ( const XMLCh* const refName , const bool fDeclared = false , const bool fUsed = false )
Destructor
 ~XMLRefInfo ()


Detailed Description

This class provides a simple means to track ID Ref usage.

Since id/idref semamatics are part of XML 1.0, any validator will likely to be able to track them. Instances of this class represent a reference and two markers, one for its being declared and another for its being used. When the document is done, one can look at each instance and, if used but not declared, its an error.

The getKey() method allows it to support keyed collection semantics. It returns the referenced name, so these objects will be stored via the hash of the name. This name will either be a standard QName if namespaces are not enabled/supported by the validator, or it will be in the form {url}name if namespace processing is enabled.


Constructor & Destructor Documentation

XMLRefInfo::XMLRefInfo ( const XMLCh * const refName,
bool declared = false,
bool used = false ) []

XMLRefInfo::~XMLRefInfo ( ) []


Member Function Documentation

bool XMLRefInfo::getDeclared ( ) const []

XMLCh * XMLRefInfo::getKey ( ) const []

const XMLCh * XMLRefInfo::getRefName ( ) const []

bool XMLRefInfo::getUsed ( ) const []

void XMLRefInfo::setDeclared ( bool newValue ) []

void XMLRefInfo::setUsed ( bool newValue ) []


The documentation for this class was generated from the following file:


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.