Public Types | |
| enum | CreateReasons { NoReason, Declared, AttList, InContentModel, AsRootElem, JustFaultIn } |
| enum | LookupOpts { AddIfNotFound, FailIfNotFound } |
| enum | CharDataOpts { NoCharData, SpacesOk, AllCharData } |
Public Methods | |
Destructor | |
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 |
| virtual XMLAttDefList & | getAttDefList () const=0 |
| virtual CharDataOpts | getCharDataOpts () const=0 |
| virtual bool | hasAttDefs () const=0 |
| virtual bool | resetDefs ()=0 |
| virtual const ContentSpecNode * | getContentSpec () const=0 |
| virtual ContentSpecNode * | getContentSpec ()=0 |
| virtual void | setContentSpec (ContentSpecNode *toAdopt)=0 |
| virtual XMLContentModel * | getContentModel ()=0 |
| virtual void | setContentModel (XMLContentModel *const newModelToAdopt)=0 |
| virtual const XMLCh * | getFormattedContentModel () const=0 |
Getter methods | |
| const XMLCh * | getBaseName () const |
| XMLCh * | getBaseName () |
| const unsigned int | getURI () const |
| const QName * | getElementName () const |
| QName * | getElementName () |
| const XMLCh * | getFullName () const |
| CreateReasons | getCreateReason () const |
| unsigned int | getId () const |
| bool | isDeclared () const |
| bool | isExternal () const |
Setter methods | |
| void | setElementName (const XMLCh *const prefix, const XMLCh *const localPart, const int uriId) |
| void | setElementName (const XMLCh *const rawName, const int uriId) |
| void | setElementName (const QName *const elementName) |
| void | setCreateReason (const CreateReasons newReason) |
| void | setId (const unsigned int newId) |
| void | setExternalElemDeclaration (const bool aValue) |
Static Public Attributes | |
| const unsigned int | fgInvalidElemId = 0xFFFFFFFE |
| const unsigned int | fgPCDataElemId = 0xFFFFFFFF |
| const XMLCh | fgPCDataElemName [] |
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.)
|
||||||||||||||||||||||||||||
|
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.
|
|
|
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. |
|
|
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.
|
|
|
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. |
|
|
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.
|
|
|
Get a pointer to the content spec node This method is identical to the previous one, except that it is non const. |
|
|
Get a pointer to the content spec node This method will return a const pointer to the content spec node object of this element.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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. |
|
|
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.
|
|
|
Get the URI id of this element type. Return the URI Id of this element.
|
|
|
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. |
|
|
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.
|
|
|
Indicate whether this element type has been declared externally This method returns a boolean that indicates whether this element has been declared externally.
|
|
|
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. |
|
|
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.
|
|
|
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.
|
|
|
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. |
|
|
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.
|
|
||||||||||||
|
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.
|
|
||||||||||||||||
|
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.
|
|
|
Set the element decl to indicate external declaration |
|
|
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. |
|
|
|
|
|
Initial value:
{
chPound, chLatin_P, chLatin_C, chLatin_D, chLatin_A
, chLatin_T, chLatin_A, chNull
}
|
1.3-rc1