XMLElementDecl class Reference

| API Docs for SAX and DOM |

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

# XMLElementDecl Class Reference

This class defines the core information of an element declaration. More...

Inheritance diagram for XMLElementDecl:

[legend]
Collaboration diagram for XMLElementDecl:

[legend]
List of all members.

## Public Types

enum | CreateReasons { NoReason, Declared, AttList, InContentModel, AsRootElem, JustFaultIn }
enum | LookupOpts { AddIfNotFound, FailIfNotFound }
enum | CharDataOpts { NoCharData, SpacesOk, AllCharData }

## Public Methods

Destructor
virtual | ~XMLElementDecl ()
Virual ElementDecl interface
virtual XMLAttDef * | findAttr (const XMLCh *const qName, const unsigned int uriId, const XMLCh *const baseName, const XMLCh *const prefix, const LookupOpts options, bool &wasAdded) const=0
| Find an attribute by name or optionally fault it in.
virtual XMLAttDefList & | getAttDefList () const=0
| Get a list of attributes defined for this element.
virtual CharDataOpts | getCharDataOpts () const=0
| The character data options for this element type.
virtual bool | hasAttDefs () const=0
| Indicate whether this element type defined any attributes.
virtual bool | resetDefs ()=0
| Reset the flags on the attribute definitions.
virtual const ContentSpecNode * | getContentSpec () const=0
| Get a pointer to the content spec node.
virtual ContentSpecNode * | getContentSpec ()=0
| Get a pointer to the content spec node.
virtual void | setContentSpec (ContentSpecNode *toAdopt)=0
| Set the content spec node object for this element type.
virtual XMLContentModel * | getContentModel ()=0
| Get a pointer to the abstract content model.
virtual void | setContentModel (XMLContentModel *const newModelToAdopt)=0
| Set the content model object for this element type.
virtual const XMLCh * | getFormattedContentModel () const=0
| Geta formatted string of the content model.
Getter methods
const XMLCh * | getBaseName () const
| Get the base name of this element type.
XMLCh * | getBaseName ()
unsigned int | getURI () const
| Get the URI id of this element type.
const QName * | getElementName () const
| Get the QName of this element type.
QName * | getElementName ()
const XMLCh * | getFullName () const
| Get the full name of this element type.
CreateReasons | getCreateReason () const
| Get the create reason for this element type.
unsigned int | getId () const
| Get the element decl pool id for this element type.
virtual const XMLCh * | getDOMTypeInfoUri () const=0
virtual const XMLCh * | getDOMTypeInfoName () const=0
bool | isDeclared () const
| Indicate whether this element type has been declared yet.
bool | isExternal () const
| Indicate whether this element type has been declared externally.
MemoryManager * | getMemoryManager () const
| Get the memory manager.
Setter methods
void | setElementName (const XMLCh *const prefix, const XMLCh *const localPart, const int uriId)
| Set the element name object for this element type.
void | setElementName (const XMLCh *const rawName, const int uriId)
| Set the element name object for this element type.
void | setElementName (const QName *const elementName)
| Set the element name object for this element type.
void | setCreateReason (const CreateReasons newReason)
| Update the create reason for this element type.
void | setId (const unsigned int newId)
| Set the element decl pool id for this element type.
void | setExternalElemDeclaration (const bool aValue)
| Set the element decl to indicate external declaration.

## Static Public Attributes

const unsigned int | fgInvalidElemId
const unsigned int | fgPCDataElemId
const XMLCh | fgPCDataElemName []

## Protected Methods

| XMLElementDecl (MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)

## Detailed Description

This class defines the core information of an element declaration.

Each validator (DTD, Schema, etc...) will have its own information that it associations with the declaration of an element, but they must all share at least this core information, i.e. they must all derive from this class. The set of info enforced at this level is driven by the needs of XML 1.0 spec validation and well formedness checks.

This class defines some special element id values for invalid elements and PCDATA elements, as well as a string for the special PCDATA element name. All validators must honor these special values in order to allow content models to work generically (i.e. to let code know when its dealing with invalid or PCDATA element ids without having to know what type of validator its messing with.)

## Member Enumeration Documentation

enum XMLElementDecl::CharDataOpts

Enumeration values:

  NoCharData |
  SpacesOk |
  AllCharData |

enum XMLElementDecl::CreateReasons

Enumeration values:

  NoReason |
  Declared |
  AttList |
  InContentModel |
  AsRootElem |
  JustFaultIn |

enum XMLElementDecl::LookupOpts

Enumeration values:

  AddIfNotFound |
  FailIfNotFound |

## Constructor & Destructor Documentation

virtual XMLElementDecl::~XMLElementDecl | ( |  | ) | `[virtual]`

XMLElementDecl::XMLElementDecl | ( | MemoryManager *const | manager = XMLPlatformUtils::fgMemoryManager | ) | `[protected]`

## Member Function Documentation

virtual XMLAttDef* XMLElementDecl::findAttr | ( | const XMLCh *const | qName,
|  | const unsigned int | uriId,
|  | const XMLCh *const | baseName,
|  | const XMLCh *const | prefix,
|  | const LookupOpts | options,
|  | bool & | wasAdded
| ) | const`[pure virtual]`

Find an attribute by name or optionally fault it in.

The derived class should look up the passed attribute in the list of of attributes for this element. If namespaces are enabled, then it should use the uriId/baseName pair, else it should use the qName. The options allow the caller to indicate whether the attribute should be defaulted in if not found. If it is defaulted in, then wasAdded should be set, else it should be cleared. If its not found and the caller does not want defaulting, then return a null pointer.

Parameters:

  qName | This is the qName of the attribute, i.e. the actual lexical name found.
  uriId | This is the id of the URI of the namespace to which this attribute mapped. Only valid if namespaces are enabled.
  baseName | This is the base part of the name, i.e. after any prefix.
  prefix | The prefix, if any, of this attribute's name. If this is empty, then uriID is meaningless as well.
  options | Indicates the lookup options.
  wasAdded | Should be set if the attribute is faulted in, else cleared.

virtual XMLAttDefList& XMLElementDecl::getAttDefList | ( |  | ) | `[pure virtual]`

Get a list of attributes defined for this element.

The derived class should return a reference to some member object which implements the XMLAttDefList interface. This object gives the scanner the ability to look through the attributes defined for this element.

It is done this way for efficiency, though of course this is not thread safe. The scanner guarantees that it won't ever call this method in any nested way, but the outside world must be careful about when it calls this method, and optimally never would.

XMLCh * XMLElementDecl::getBaseName | ( |  | ) |

const XMLCh * XMLElementDecl::getBaseName | ( |  | ) |

Get the base name of this element type.

Return the base name part of the element's name. This is the same regardless of whether namespaces are enabled or not.

Returns:
  A const pointer to the base name of the element decl.

virtual CharDataOpts XMLElementDecl::getCharDataOpts | ( |  | ) | `[pure virtual]`

| The character data options for this element type. The derived class should return an appropriate character data opts value which correctly represents its tolerance towards whitespace or character data inside of its instances. This allows the scanner to do all of the validation of character data.

virtual XMLContentModel* XMLElementDecl::getContentModel | ( |  | ) | `[pure virtual]`

Get a pointer to the abstract content model.

This method will return a const pointer to the content model object of this element. This class is a simple abstraction that allows an element to define and use multiple, specialized content model types internally but still allow the outside world to do simple stuff with them.

Returns:
  A pointer to the element's content model, via the basic abstract content model type.

virtual ContentSpecNode* XMLElementDecl::getContentSpec | ( |  | ) | `[pure virtual]`

| Get a pointer to the content spec node. This method is identical to the previous one, except that it is non const.

virtual const ContentSpecNode* XMLElementDecl::getContentSpec | ( |  | ) | `[pure virtual]`

Get a pointer to the content spec node.

This method will return a const pointer to the content spec node object of this element.

Returns:
  A const pointer to the element's content spec node

XMLElementDecl::CreateReasons XMLElementDecl::getCreateReason | ( |  | ) |

Get the create reason for this element type.

This method returns an enumeration which indicates why this element declaration exists. Elements can be used before they are actually declared, so they will often be faulted into the pool and marked as to why they are there.

Returns:
  An enumerated value that indicates the reason why this element was added to the element decl pool.

virtual const XMLCh* XMLElementDecl::getDOMTypeInfoName | ( |  | ) | `[pure virtual]`

Returns:
  the name part of DOM Level 3 TypeInfo

virtual const XMLCh* XMLElementDecl::getDOMTypeInfoUri | ( |  | ) | `[pure virtual]`

Returns:
  the uri part of DOM Level 3 TypeInfo

QName * XMLElementDecl::getElementName | ( |  | ) |

const QName * XMLElementDecl::getElementName | ( |  | ) |

Get the QName of this element type.

Return the QName part of the element's name. This is the same regardless of whether namespaces are enabled or not.

Returns:
  A const pointer to the QName of the element decl.

virtual const XMLCh* XMLElementDecl::getFormattedContentModel | ( |  | ) | `[pure virtual]`

Geta formatted string of the content model.

This method is a convenience method which will create a formatted representation of the content model of the element. It will not always exactly recreate the original model, since some normalization or or reformatting may occur. But, it will be a technically accurate representation of the original content model.

Returns:
  A pointer to an internal buffer which contains the formatted content model. The caller does not own this buffer and should copy it if it needs to be kept around.

const XMLCh * XMLElementDecl::getFullName | ( |  | ) |

| Get the full name of this element type. Return the full name of the element. If namespaces are not enabled, then this is the qName. Else it is the {uri}baseName form. For those validators that always require namespace processing, it will always be in the latter form because namespace processing will always be on.

unsigned int XMLElementDecl::getId | ( |  | ) |

Get the element decl pool id for this element type.

This method will return the element decl pool id of this element declaration. This uniquely identifies this element type within the parse event that it is declared within. This value is assigned by the grammar whose decl pool this object belongs to.

Returns:
  The element decl id of this element declaration.

MemoryManager * XMLElementDecl::getMemoryManager | ( |  | ) |

Get the memory manager.

This method returns the configurable memory manager used by the element declaration for dynamic allocation/deacllocation.

Returns:
  the memory manager

unsigned int XMLElementDecl::getURI | ( |  | ) |

Get the URI id of this element type.

Return the URI Id of this element.

Returns:
  The URI Id of the element decl, or the emptyNamespaceId if not applicable.

virtual bool XMLElementDecl::hasAttDefs | ( |  | ) | `[pure virtual]`

| Indicate whether this element type defined any attributes. The derived class should return a boolean that indicates whether this element has any attributes defined for it or not. This is an optimization that allows the scanner to skip some work if no attributes exist.

bool XMLElementDecl::isDeclared | ( |  | ) |

Indicate whether this element type has been declared yet.

This method returns a boolean that indicates whether this element has been declared yet. There are a number of reasons why an element declaration can be faulted in, but eventually it must be declared or its an error. See the CreateReasons enumeration.

Returns:
  true if this element has been declared, else false.

bool XMLElementDecl::isExternal | ( |  | ) |

Indicate whether this element type has been declared externally.

This method returns a boolean that indicates whether this element has been declared externally.

Returns:
  true if this element has been declared externally, else false.

virtual bool XMLElementDecl::resetDefs | ( |  | ) | `[pure virtual]`

| Reset the flags on the attribute definitions. This method is called by the scanner at the beginning of each scan of a start tag, asking this element decl to reset the 'declared' flag of each of its attribute defs. This allows the scanner to mark each one as declared yet or not.

virtual void XMLElementDecl::setContentModel | ( | XMLContentModel *const | newModelToAdopt | ) | `[pure virtual]`

Set the content model object for this element type.

This method will adopt the based content model object. This is called by the actual validator which is parsing its DTD or Schema or whatever a creating an element decl. It will build what it feels is the correct content model type object and store it on the element decl object via this method.

Parameters:

  newModelToAdopt | This method will adopt the passed content model object. Any previous object is destroyed.

virtual void XMLElementDecl::setContentSpec | ( | ContentSpecNode * | toAdopt | ) | `[pure virtual]`

Set the content spec node object for this element type.

This method will adopt the based content spec node object. This is called by the actual validator which is parsing its DTD or Schema or whatever and store it on the element decl object via this method.

Parameters:

  toAdopt | This method will adopt the passed content node spec object. Any previous object is destroyed.

void XMLElementDecl::setCreateReason | ( | const CreateReasons | newReason | ) |

| Update the create reason for this element type. This method will update the 'create reason' field for this element decl object. As the validator parses its DTD, Schema, etc... it will encounter various references to an element declaration, which will cause the element declaration to either be declared or to be faulted into the pool in preperation for some future declaration. As it does so,it will update this field to indicate the current satus of the decl object.

void XMLElementDecl::setElementName | ( | const QName *const | elementName | ) |

Set the element name object for this element type.

This method will adopt the based content spec node object. This is called by the actual validator which is parsing its DTD or Schema or whatever and store it on the element decl object via this method.

Parameters:

  elementName | QName of the element

void XMLElementDecl::setElementName | ( | const XMLCh *const | rawName,
|  | const int | uriId
| ) |

Set the element name object for this element type.

This method will adopt the based content spec node object. This is called by the actual validator which is parsing its DTD or Schema or whatever and store it on the element decl object via this method.

Parameters:

  rawName | Full Name of the element
  uriId | The uriId of the element

void XMLElementDecl::setElementName | ( | const XMLCh *const | prefix,
|  | const XMLCh *const | localPart,
|  | const int | uriId
| ) |

Set the element name object for this element type.

This method will adopt the based content spec node object. This is called by the actual validator which is parsing its DTD or Schema or whatever and store it on the element decl object via this method.

Parameters:

  prefix | Prefix of the element
  localPart | Base Name of the element
  uriId | The uriId of the element

void XMLElementDecl::setExternalElemDeclaration | ( | const bool | aValue | ) |

| Set the element decl to indicate external declaration.

void XMLElementDecl::setId | ( | const unsigned int | newId | ) |

| Set the element decl pool id for this element type. This method will set the pool id of this element decl. This is called by the grammar which created this object, and will provide this decl object with a unique id within the parse event that created it.

## Member Data Documentation

const unsigned int XMLElementDecl::fgInvalidElemId`[static]`

const unsigned int XMLElementDecl::fgPCDataElemId`[static]`

const XMLCh XMLElementDecl::fgPCDataElemName[]`[static]`

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

- XMLElementDecl.hpp

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