class XMLValidator

This abstract class provides the interface for all validators

Inheritance:


Public Methods

virtual int addOrFindNSId ( const XMLCh* const uriText )
The derived class should look for the passed URI (case sensitive) in its URI pool
virtual int checkContent ( const unsigned int elemId, const unsigned int* childIds, const unsigned int childCount )
The derived class should look up its declaration of the passed element from its element pool
virtual bool checkRootElement ( const unsigned int elemId )
For those validators that contrain the possible root elements of a document to only particular elements, they should use this call to validate that the passed root element id is a legal root element
void emitError (const XML4CValid::Codes toEmit)
This call is a convenience by which validators can emit errors
virtual void faultInAttr ( XMLAttr& toFill, const XMLAttDef& attDef ) const
The derived class should fault in the passed XMLAttr value
virtual const XMLElementDecl* findElemDecl ( const unsigned int uriId, const XMLCh* const baseName, const XMLCh* const qName, const LookupOpts options, bool& wasAdded ) const
The derived class should look up an element in its element declaration pool and return a pointer to it
virtual unsigned int findElemId ( const unsigned int uriId, const XMLCh* const baseName, const XMLCh* const qName ) const
The derived class should find the indicate element in its element declaration pool
virtual XMLEntityDecl* findEntityDecl ( const XMLCh* const entName, const bool isPE )
This method is identical to the previous one, except that it is non- const
virtual const XMLEntityDecl* findEntityDecl ( const XMLCh* const entName, const bool isPE ) const
The derived class should look the passed entity declaration name in its entity pool and return a pointer to the declaration object
virtual const XMLNotationDecl* findNotationDecl ( const XMLCh* const notName ) const
The derived class should look up the passed notation name in its notation decl pool
virtual XMLNotationDecl* findNotationDecl ( const XMLCh* const notName )
This method is identical to the previous method except that it is non- const
virtual unsigned int findNSId ( const XMLCh* const nsName ) const
The derived class should look up the passed namespace name (prefix) in its namespace name pool and return the id
virtual XMLElementDecl* getElemDecl ( const unsigned int elemId )
This method is identical to the previous method, except that it is a non-const version
virtual const XMLElementDecl* getElemDecl ( const unsigned int elemId ) const
The derived class should return the element from its element decl pool which has the indicated element id
unsigned int getEmptyNamespaceId () const
When an attribute name has no prefix, unlike elements, it is not mapped to the global namespace
unsigned int getGlobalNamespaceId () const
When namespaces are enabled, any elements whose names have no prefix are mapped to a global namespace
unsigned int getUnknownNamespaceId () const
When a prefix is found that has not been mapped, an error is issued
virtual bool getURIText ( const unsigned int uriId, XMLBuffer& uriBufToFill ) const
The derived class should find the passed URI id in its URI pool and copy the text of that URI into the passed buffer
unsigned int getXMLNamespaceId () const
The prefix 'xml' is a magic prefix, defined by the XML spec and requiring no prior definition
unsigned int getXMLNSNamespaceId () const
The prefix 'xmlns' is a magic prefix, defined by the namespace spec and requiring no prior definition
virtual bool handlesDTD () const
This method allows the scanner to ask the validator if it handles DTDs or not
virtual void postParseValidation ()
This method is called by the scanner after the parse has completed
virtual bool requiresNamespaces () const
The derived class should return a boolean that indicates whether it requires namespace processing or not
virtual void reset ()
This method is called by the scanner before a new document is about to start
virtual void scanDTD (const bool reuseValidator)
This method is called by the scanner when it is time for the validator to parse the DTD
void setErrorReporter ( XMLErrorReporter* const errorReporter )
This method is called to set an error reporter on the validator via which it will report any errors it sees during parsing or validation
void setScannerInfo ( XMLScanner* const owningScanner, ReaderMgr* const readerMgr, XMLBufferMgr* const bufMgr )
virtual void validateAttrValue ( const XMLAttDef& attDef, const XMLCh* const attrValue )
The derived class should apply any rules to the passed attribute value that are above and beyond those defined by XML 1

Public

Destructor
FailIfNotFound virtual ~XMLValidator ()
The derived class should clean up its allocated data, then this class will do the same for data allocated at this level
Error emittor methods
Getter Methods
Setter methods
Virtual DTD handler interface
Virtual validator interface

Documentation

This abstract class provides the interface for all validators. This is the simple amount of API that all validators must honor, in order for the scanner to use them to do validation. All validators will actually contain much more functionality than is accessible via this common API, but that functionality requires that you know what type of validator you are dealing with. Basically, at this level, the primary concern is to be able to query core information about elements and attributes. Adding decls to the validator requires that you go through the derived interface because they all have their own decl types. At this level, we can return information via the base decl classes, from which each validator derives its own decl classes.
Destructor

FailIfNotFound virtual ~XMLValidator()
The derived class should clean up its allocated data, then this class will do the same for data allocated at this level

Getter Methods

unsigned int getEmptyNamespaceId() const
When an attribute name has no prefix, unlike elements, it is not mapped to the global namespace. So, in order to have something to map it to for practical purposes, a id for an empty URL is created and used for such names.
Returns:
The URL pool id of the URL for an empty URL "".

unsigned int getGlobalNamespaceId() const
When namespaces are enabled, any elements whose names have no prefix are mapped to a global namespace. This is the URL id for the URL to which those names are mapped. It has no official standard text, but the parser must use some id here.
Returns:
The URL pool id of the URL for the global namespace.

unsigned int getUnknownNamespaceId() const
When a prefix is found that has not been mapped, an error is issued. However, if the parser has been instructed not to stop on the first fatal error, it needs to be able to continue. To do so, it will map that prefix tot his magic unknown namespace id.
Returns:
The URL pool id of the URL for the unknown prefix namespace.

unsigned int getXMLNamespaceId() const
The prefix 'xml' is a magic prefix, defined by the XML spec and requiring no prior definition. This method returns the id for the intrinsically defined URL for this prefix.
Returns:
The URL pool id of the URL for the 'xml' prefix.

unsigned int getXMLNSNamespaceId() const
The prefix 'xmlns' is a magic prefix, defined by the namespace spec and requiring no prior definition. This method returns the id for the intrinsically defined URL for this prefix.
Returns:
The URL pool id of the URL for the 'xmlns' prefix.

Setter methods

void setScannerInfo( XMLScanner* const owningScanner, ReaderMgr* const readerMgr, XMLBufferMgr* const bufMgr )
Parameters:
owningScanner - This is a pointer to the scanner to which the validator belongs. The validator will often need to query state data from the scanner.
readerMgr - This is a pointer to the reader manager that is being used by the scanner.
bufMgr - This is the buffer manager of the scanner. This is provided as a convenience so that the validator doesn't have to create its own buffer manager during the parse process.

void setErrorReporter( XMLErrorReporter* const errorReporter )
This method is called to set an error reporter on the validator via which it will report any errors it sees during parsing or validation. This is generally called by the owning scanner.
Parameters:
errorReporter - A pointer to the error reporter to use. This is not adopted, just referenced so the caller remains responsible for its cleanup, if any.

Virtual validator interface

virtual int addOrFindNSId( const XMLCh* const uriText )
The derived class should look for the passed URI (case sensitive) in its URI pool. If the URI does not exist, then it should be added to the pool. The new or existing pool id should be returned.

virtual int checkContent( const unsigned int elemId, const unsigned int* childIds, const unsigned int childCount )
The derived class should look up its declaration of the passed element from its element pool. It should then use the content model description contained in that element declaration to validate that the passed list of child elements are valid for that content model. The count can be zero, indicating no child elements. Note that whitespace and text content are not validated here. Those are handled by the scanner. So only element ids are provided here.
Parameters:
elemId - The pool id of the element whose content is to be checked.
childIds - An array of element ids which represent the elements found within the parent element, i.e. the content to be validated.
childCount - The number of elements in the childIds array. It can be zero if the element had none.

virtual bool checkRootElement( const unsigned int elemId )
For those validators that contrain the possible root elements of a document to only particular elements, they should use this call to validate that the passed root element id is a legal root element

virtual void faultInAttr( XMLAttr& toFill, const XMLAttDef& attDef ) const
The derived class should fault in the passed XMLAttr value. It should use the passeed attribute definition (which is passed via the base type so it must often be downcast to the appropriate type for the derived validator class), to fill in the passed attribute. This is done as a performance enhancement since the derived class has more direct access to the information.

virtual const XMLElementDecl* findElemDecl( const unsigned int uriId, const XMLCh* const baseName, const XMLCh* const qName, const LookupOpts options, bool& wasAdded ) const
The derived class should look up an element in its element declaration pool and return a pointer to it. The name should be looked up either via the qName field (if namespaces are off) or via the uriID/baseName combo (if namespaces are on.) The options allow the caller to indicate how the validator should react if the element exists or not. If the element does not exist, the option can indicate that it should be faulted it. If it does not exist and faulting in is not requested, a null pointer should be returned. The wasAdded flag should be set if the declaration was faulted in, else it should be cleared.

virtual const XMLEntityDecl* findEntityDecl( const XMLCh* const entName, const bool isPE ) const
The derived class should look the passed entity declaration name in its entity pool and return a pointer to the declaration object. If the entity is not in the pool, it should return a null pointer.
Parameters:
entName - The name of the entity to look up. Entity names can not be namespace based, so its always just a single unqualified name.
isPE - Indicates whether the name represents a parameter entity or a general entity. The validator should look at the correct pool for the entity type.

virtual XMLEntityDecl* findEntityDecl( const XMLCh* const entName, const bool isPE )
This method is identical to the previous one, except that it is non- const.
Parameters:
entName - The name of the entity to look up. Entity names can not be namespace based, so its always just a single unqualified name.
isPE - Indicates whether the name represents a parameter entity or a general entity. The validator should look at the correct pool for the entity type.

virtual unsigned int findElemId( const unsigned int uriId, const XMLCh* const baseName, const XMLCh* const qName ) const
The derived class should find the indicate element in its element declaration pool. If namespaces are on, then it should use the uriId and base name. Otherwise, it should use the qName. It should return the element decl pool id for the decl found. If the element is not not found, it should return the value XMLElementDecl::fgInvalidElemId;

virtual const XMLNotationDecl* findNotationDecl( const XMLCh* const notName ) const
The derived class should look up the passed notation name in its notation decl pool. If the name is not found, it should return a null pointer. If it is found, it should return a pointer to the declaration object.

virtual XMLNotationDecl* findNotationDecl( const XMLCh* const notName )
This method is identical to the previous method except that it is non- const

virtual unsigned int findNSId( const XMLCh* const nsName ) const
The derived class should look up the passed namespace name (prefix) in its namespace name pool and return the id. If not found, it should return zero, which is never a valid pool id.

virtual const XMLElementDecl* getElemDecl( const unsigned int elemId ) const
The derived class should return the element from its element decl pool which has the indicated element id. Given that these ids are gotten from the validator itself, it should always be valid. If not, then a major internal error has occured.

virtual XMLElementDecl* getElemDecl( const unsigned int elemId )
This method is identical to the previous method, except that it is a non-const version

virtual bool getURIText( const unsigned int uriId, XMLBuffer& uriBufToFill ) const
The derived class should find the passed URI id in its URI pool and copy the text of that URI into the passed buffer. Since these ids are obtained from the validator itself, they should always be valid. If not, then a major internal error has occured.

virtual void postParseValidation()
This method is called by the scanner after the parse has completed. It gives the validator a chance to check certain things that can only be checked after the whole document has been parsed, such as referential integrity of ID/IDREF pairs and so forth. The validator should just issue errors for any problems it finds.

virtual void reset()
This method is called by the scanner before a new document is about to start. It gives the validator a change to reset itself in preperation for another validation pass.

virtual bool requiresNamespaces() const
The derived class should return a boolean that indicates whether it requires namespace processing or not. Some do and some allow it to be optional. This flag is used to control whether the client code's requests to disable namespace processing can be honored or not.

virtual void validateAttrValue( const XMLAttDef& attDef, const XMLCh* const attrValue )
The derived class should apply any rules to the passed attribute value that are above and beyond those defined by XML 1.0. The scanner itself will impose XML 1.0 rules, based on the type of the attribute. This will generally be used to check things such as range checks and other datatype related validation. If the value breaks any rules as defined by the derived class, it should just issue errors as usual.

Virtual DTD handler interface

virtual bool handlesDTD() const
This method allows the scanner to ask the validator if it handles DTDs or not

virtual void scanDTD(const bool reuseValidator)
This method is called by the scanner when it is time for the validator to parse the DTD. At the time of this call, the parser has parsed up to the [ of the DOCTYPE line. This call should parse to the ]> that ends the DOCTYPE line, and any external subset referenced.
Parameters:
reuseValidator - Indicates whether the current state of the validator should be kept. If the DTD validator sees any internal subset, it should consider it an error for this to be true. Otherwise, it just ignores any external subset and returns with the state unchanged.

Error emittor methods

void emitError(const XML4CValid::Codes toEmit)
This call is a convenience by which validators can emit errors. Most of the grunt work of loading the text, getting the current source location, ect... is handled here. If the loaded text has replacement parameters, then text strings can be passed. These will be used to replace the tokens {0}, {1}, {2}, and {3} in the order passed. So text1 will replace {0}, text2 will replace {1}, and so forth.
Parameters:
toEmit - The error code to emit. it must be one of the defined validator error codes.
textX - Up to four replacement parameters. They can be provided as either XMLCh strings, or local code page strings which will be transcoded internally.


This class has no child classes.

alphabetic index hierarchy of classes


Xerces-C XML Parser for C++ Version 1.1
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.

generated by doc++