AbstractDOMParser class Reference

| API Docs for SAX and DOM |

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

# AbstractDOMParser Class Reference

This class implements the Document Object Model (DOM) interface. More...

Inheritance diagram for AbstractDOMParser:

[legend]
Collaboration diagram for AbstractDOMParser:

[legend]
List of all members.

## Public Types

Public constants
enum | ValSchemes { Val_Never, Val_Always, Val_Auto }
| ValScheme enum used in setValidationScheme Val_Never: Do not report validation errors. More...

## Public Methods

Destructor
virtual | ~AbstractDOMParser ()
| Destructor.
Utility methods
void | reset ()
| Reset the parser.
DOMDocument * | adoptDocument ()
| Adopt the DOM document.
Getter methods
DOMDocument * | getDocument ()
| Get the DOM document.
const XMLValidator & | getValidator () const
| Get a const reference to the validator.
ValSchemes | getValidationScheme () const
| This method returns an enumerated value that indicates the current validation scheme set on this parser.
bool | getDoSchema () const
| Get the 'do schema' flag.
bool | getValidationSchemaFullChecking () const
| Get the 'full schema constraint checking' flag.
int | getErrorCount () const
| Get error count from the last parse operation.
bool | getDoNamespaces () const
| Get the 'do namespaces' flag.
bool | getExitOnFirstFatalError () const
| Get the 'exit on first error' flag.
bool | getValidationConstraintFatal () const
| This method returns the state of the parser's validation-constraint-fatal flag.
bool | getCreateEntityReferenceNodes () const
| Get the 'include entity references' flag.
bool | getIncludeIgnorableWhitespace () const
| Get the 'include ignorable whitespace' flag.
XMLCh * | getExternalSchemaLocation () const
| Get the set of Namespace/SchemaLocation that is specified externaly.
XMLCh * | getExternalNoNamespaceSchemaLocation () const
| Get the noNamespace SchemaLocation that is specified externaly.
SecurityManager * | getSecurityManager () const
| Get the SecurityManager instance attached to this parser.
bool | getLoadExternalDTD () const
| Get the 'Loading External DTD' flag.
bool | getCreateCommentNodes () const
| Get the 'create comment node' flag.
bool | getCalculateSrcOfs () const
| Get the 'calculate src offset flag'.
bool | getStandardUriConformant () const
| Get the 'force standard uri flag'.
Setter methods
void | setDoNamespaces (const bool newState)
| Set the 'do namespaces' flag.
void | setExitOnFirstFatalError (const bool newState)
| Set the 'exit on first error' flag.
void | setValidationConstraintFatal (const bool newState)
| This method allows users to set the parser's behaviour when it encounters a validtion constraint error.
void | setCreateEntityReferenceNodes (const bool create)
| Set the 'include entity references' flag.
void | setIncludeIgnorableWhitespace (const bool include)
| Set the 'include ignorable whitespace' flag.
void | setValidationScheme (const ValSchemes newScheme)
| This method allows users to set the validation scheme to be used by this parser.
void | setDoSchema (const bool newState)
| Set the 'do schema' flag.
void | setValidationSchemaFullChecking (const bool schemaFullChecking)
| This method allows the user to turn full Schema constraint checking on/off.
void | setExternalSchemaLocation (const XMLCh *const schemaLocation)
| This method allows the user to specify a list of schemas to use.
void | setExternalSchemaLocation (const char *const schemaLocation)
| This method is same as setExternalSchemaLocation(const XMLCh* const).
void | setExternalNoNamespaceSchemaLocation (const XMLCh *const noNamespaceSchemaLocation)
| This method allows the user to specify the no target namespace XML Schema Location externally.
void | setExternalNoNamespaceSchemaLocation (const char *const noNamespaceSchemaLocation)
| This method is same as setExternalNoNamespaceSchemaLocation(const XMLCh* const).
void | setSecurityManager (SecurityManager *const securityManager)
| This allows an application to set a SecurityManager on the parser; this object stores information that various components use to limit their consumption of system resources while processing documents.
void | setLoadExternalDTD (const bool newState)
| Set the 'Loading External DTD' flag.
void | setCreateCommentNodes (const bool create)
| Set the 'create comment nodes' flag.
void | setCalculateSrcOfs (const bool newState)
| Enable/disable src offset calculation.
void | setStandardUriConformant (const bool newState)
| Force standard uri.
void | useScanner (const XMLCh *const scannerName)
| Set the scanner to use when scanning the XML document.
Parsing methods
void | parse (const InputSource &source)
| Parse via an input source object.
void | parse (const XMLCh *const systemId)
| Parse via a file path or URL.
void | parse (const char *const systemId)
| Parse via a file path or URL (in the local code page).
bool | parseFirst (const XMLCh *const systemId, XMLPScanToken &toFill)
| Begin a progressive parse operation.
bool | parseFirst (const char *const systemId, XMLPScanToken &toFill)
| Begin a progressive parse operation.
bool | parseFirst (const InputSource &source, XMLPScanToken &toFill)
| Begin a progressive parse operation.
bool | parseNext (XMLPScanToken &token)
| Continue a progressive parse operation.
void | parseReset (XMLPScanToken &token)
| Reset the parser after a progressive parse.
Implementation of the XMLDocumentHandler interface.
virtual void | docCharacters (const XMLCh *const chars, const unsigned int length, const bool cdataSection)
| Handle document character events.
virtual void | docComment (const XMLCh *const comment)
| Handle a document comment event.
virtual void | docPI (const XMLCh *const target, const XMLCh *const data)
| Handle a document PI event.
virtual void | endDocument ()
| Handle the end of document event.
virtual void | endElement (const XMLElementDecl &elemDecl, const unsigned int urlId, const bool isRoot, const XMLCh *const elemPrefix)
| Handle and end of element event.
virtual void | endEntityReference (const XMLEntityDecl &entDecl)
| Handle and end of entity reference event.
virtual void | ignorableWhitespace (const XMLCh *const chars, const unsigned int length, const bool cdataSection)
| Handle an ignorable whitespace vent.
virtual void | resetDocument ()
| Handle a document reset event.
virtual void | startDocument ()
| Handle a start document event.
virtual void | startElement (const XMLElementDecl &elemDecl, const unsigned int urlId, const XMLCh *const elemPrefix, const RefVectorOf< XMLAttr > &attrList, const unsigned int attrCount, const bool isEmpty, const bool isRoot)
| Handle a start element event.
virtual void | startEntityReference (const XMLEntityDecl &entDecl)
| Handle a start entity reference event.
virtual void | XMLDecl (const XMLCh *const versionStr, const XMLCh *const encodingStr, const XMLCh *const standaloneStr, const XMLCh *const actualEncStr)
| Handle an XMLDecl event.
Deprecated DocTypeHandler Interfaces
virtual void | attDef (const DTDElementDecl &elemDecl, const DTDAttDef &attDef, const bool ignoring)
virtual void | doctypeComment (const XMLCh *const comment)
virtual void | doctypeDecl (const DTDElementDecl &elemDecl, const XMLCh *const publicId, const XMLCh *const systemId, const bool hasIntSubset, const bool hasExtSubset=false)
virtual void | doctypePI (const XMLCh *const target, const XMLCh *const data)
virtual void | doctypeWhitespace (const XMLCh *const chars, const unsigned int length)
virtual void | elementDecl (const DTDElementDecl &decl, const bool isIgnored)
virtual void | endAttList (const DTDElementDecl &elemDecl)
virtual void | endIntSubset ()
virtual void | endExtSubset ()
virtual void | entityDecl (const DTDEntityDecl &entityDecl, const bool isPEDecl, const bool isIgnored)
virtual void | resetDocType ()
virtual void | notationDecl (const XMLNotationDecl &notDecl, const bool isIgnored)
virtual void | startAttList (const DTDElementDecl &elemDecl)
virtual void | startIntSubset ()
virtual void | startExtSubset ()
virtual void | TextDecl (const XMLCh *const versionStr, const XMLCh *const encodingStr)
Deprecated Methods
bool | getDoValidation () const
| This method returns the state of the parser's validation handling flag which controls whether validation checks are enforced or not.
void | setDoValidation (const bool newState)
| This method allows users to enable or disable the parser's validation checks.
bool | getExpandEntityReferences () const
| Get the 'expand entity references' flag.
void | setExpandEntityReferences (const bool expand)
| Set the 'expand entity references' flag.

## Protected Methods

Constructors
| AbstractDOMParser (XMLValidator *const valToAdopt=0, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
| Construct a AbstractDOMParser, with an optional validator.
Protected getter methods
DOMNode * | getCurrentNode ()
| Get the current DOM node.
XMLScanner * | getScanner () const
| Get the XML scanner.
GrammarResolver * | getGrammarResolver () const
| Get the Grammar resolver.
bool | getParseInProgress () const
| Get the parse in progress flag.
MemoryManager * | getMemoryManager () const
Protected setter methods
void | setCurrentNode (DOMNode *toSet)
| Set the current DOM node.
void | setDocument (DOMDocument *toSet)
| Set the document node.
void | setParseInProgress (const bool toSet)
| Set the parse in progress flag.
Protected helper methods
virtual DOMElement * | createElementNSNode (const XMLCh *fNamespaceURI, const XMLCh *qualifiedName)
void | resetPool ()
bool | isDocumentAdopted () const
| Returns true if the user has adopted the document.

## Detailed Description

This class implements the Document Object Model (DOM) interface.

It is used as a base for DOM parsers (i.e. XercesDOMParser, DOMBuilder).

## Member Enumeration Documentation

enum AbstractDOMParser::ValSchemes

ValScheme enum used in setValidationScheme Val_Never: Do not report validation errors.

Val_Always: The parser will always report validation errors. Val_Auto: The parser will report validation errors only if a grammar is specified.

See also:
  setValidationScheme

Enumeration values:

  Val_Never |
  Val_Always |
  Val_Auto |

## Constructor & Destructor Documentation

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

| Destructor.

AbstractDOMParser::AbstractDOMParser | ( | XMLValidator *const | valToAdopt = 0,
|  | MemoryManager *const | manager = XMLPlatformUtils::fgMemoryManager
| ) | `[protected]`

Construct a AbstractDOMParser, with an optional validator.

Constructor with an instance of validator class to use for validation. If you don't provide a validator, a default one will be created for you in the scanner.

Parameters:

  valToAdopt | Pointer to the validator instance to use. The parser is responsible for freeing the memory.

## Member Function Documentation

DOMDocument* AbstractDOMParser::adoptDocument | ( |  | ) |

Adopt the DOM document.

This method returns the DOMDocument object representing the root of the document tree.

The caller will adopt the DOMDocument and thus is responsible to call DOMDocument::release() to release the associated memory. The parser will not delete it. The ownership is transferred from the parser to the caller.

Returns:
  The adopted DOMDocument object which represents the entire XML document.

virtual void AbstractDOMParser::attDef | ( | const DTDElementDecl & | elemDecl,
|  | const DTDAttDef & | attDef,
|  | const bool | ignoring
| ) | `[virtual]`

virtual DOMElement* AbstractDOMParser::createElementNSNode | ( | const XMLCh * | fNamespaceURI,
|  | const XMLCh * | qualifiedName
| ) | `[protected, virtual]`

virtual void AbstractDOMParser::docCharacters | ( | const XMLCh *const | chars,
|  | const unsigned int | length,
|  | const bool | cdataSection
| ) | `[virtual]`

Handle document character events.

This method is used to report all the characters scanned by the parser. This DOM implementation stores this data in the appropriate DOM node, creating one if necessary.

Parameters:

  chars | A const pointer to a Unicode string representing the character data.
  length | The length of the Unicode string returned in 'chars'.
  cdataSection | A flag indicating if the characters represent content from the CDATA section.

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::docComment | ( | const XMLCh *const | comment | ) | `[virtual]`

Handle a document comment event.

This method is used to report any comments scanned by the parser. A new comment node is created which stores this data.

Parameters:

  comment | A const pointer to a null terminated Unicode string representing the comment text.

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::docPI | ( | const XMLCh *const | target,
|  | const XMLCh *const | data
| ) | `[virtual]`

Handle a document PI event.

This method is used to report any PI scanned by the parser. A new PI node is created and appended as a child of the current node in the tree.

Parameters:

  target | A const pointer to a Unicode string representing the target of the PI declaration.
  data | A const pointer to a Unicode string representing the data of the PI declaration. See the PI production rule in the XML specification for details.

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::doctypeComment | ( | const XMLCh *const | comment | ) | `[virtual]`

virtual void AbstractDOMParser::doctypeDecl | ( | const DTDElementDecl & | elemDecl,
|  | const XMLCh *const | publicId,
|  | const XMLCh *const | systemId,
|  | const bool | hasIntSubset,
|  | const bool | hasExtSubset = false
| ) | `[virtual]`

virtual void AbstractDOMParser::doctypePI | ( | const XMLCh *const | target,
|  | const XMLCh *const | data
| ) | `[virtual]`

virtual void AbstractDOMParser::doctypeWhitespace | ( | const XMLCh *const | chars,
|  | const unsigned int | length
| ) | `[virtual]`

virtual void AbstractDOMParser::elementDecl | ( | const DTDElementDecl & | decl,
|  | const bool | isIgnored
| ) | `[virtual]`

virtual void AbstractDOMParser::endAttList | ( | const DTDElementDecl & | elemDecl | ) | `[virtual]`

virtual void AbstractDOMParser::endDocument | ( |  | ) | `[virtual]`

| Handle the end of document event. This method is used to indicate the end of the current document. Implements XMLDocumentHandler.

virtual void AbstractDOMParser::endElement | ( | const XMLElementDecl & | elemDecl,
|  | const unsigned int | urlId,
|  | const bool | isRoot,
|  | const XMLCh *const | elemPrefix
| ) | `[virtual]`

Handle and end of element event.

This method is used to indicate the end tag of an element. The DOM parser pops the current element off the top of the element stack, and make it the new current element.

Parameters:

  elemDecl | A const reference to the object containing element declaration information.
  urlId | An id referring to the namespace prefix, if namespaces setting is switched on.
  isRoot | A flag indicating whether this element was the root element.
  elemPrefix | A const pointer to a Unicode string containing the namespace prefix for this element. Applicable only when namespace processing is enabled.

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::endEntityReference | ( | const XMLEntityDecl & | entDecl | ) | `[virtual]`

Handle and end of entity reference event.

This method is used to indicate that an end of an entity reference was just scanned.

Parameters:

  entDecl | A const reference to the object containing the entity declaration information.

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::endExtSubset | ( |  | ) | `[virtual]`

virtual void AbstractDOMParser::endIntSubset | ( |  | ) | `[virtual]`

virtual void AbstractDOMParser::entityDecl | ( | const DTDEntityDecl & | entityDecl,
|  | const bool | isPEDecl,
|  | const bool | isIgnored
| ) | `[virtual]`

bool AbstractDOMParser::getCalculateSrcOfs | ( |  | ) |

Get the 'calculate src offset flag'.

This method returns the state of the parser's src offset calculation when parsing an XML document.

Returns:
  true, if the parser is currently configured to calculate src offsets, false otherwise.

See also:
  setCalculateSrcOfs

bool AbstractDOMParser::getCreateCommentNodes | ( |  | ) |

Get the 'create comment node' flag.

This method returns the flag that specifies whether the parser is creating comment nodes in the DOM tree being produced.

Returns:
  The state of the create comment node flag.

See also:
  setCreateCommentNodes

bool AbstractDOMParser::getCreateEntityReferenceNodes | ( |  | ) |

Get the 'include entity references' flag.

This method returns the flag that specifies whether the parser is creating entity reference nodes in the DOM tree being produced.

Returns:
  The state of the create entity reference node flag.

See also:
  setCreateEntityReferenceNodes

DOMNode * AbstractDOMParser::getCurrentNode | ( |  | ) | `[protected]`

| Get the current DOM node. This provides derived classes with access to the current node, i.e. the node to which new nodes are being added.

DOMDocument* AbstractDOMParser::getDocument | ( |  | ) |

Get the DOM document.

This method returns the DOMDocument object representing the root of the document tree. This object provides the primary access to the document's data.

The returned DOMDocument object is owned by the parser.

Returns:
  The DOMDocument object which represents the entire XML document.

bool AbstractDOMParser::getDoNamespaces | ( |  | ) |

Get the 'do namespaces' flag.

This method returns the state of the parser's namespace processing flag.

Returns:
  true, if the parser is currently configured to understand namespaces, false otherwise.

See also:
  setDoNamespaces

bool AbstractDOMParser::getDoSchema | ( |  | ) |

Get the 'do schema' flag.

This method returns the state of the parser's schema processing flag.

Returns:
  true, if the parser is currently configured to understand schema, false otherwise.

See also:
  setDoSchema

bool AbstractDOMParser::getDoValidation | ( |  | ) |

This method returns the state of the parser's validation handling flag which controls whether validation checks are enforced or not.

Returns:
  true, if the parser is currently configured to do validation, false otherwise.

See also:
  setDoValidation

int AbstractDOMParser::getErrorCount | ( |  | ) |

Get error count from the last parse operation.

This method returns the error count from the last parse operation. Note that this count is actually stored in the scanner, so this method simply returns what the scanner reports.

Returns:
  number of errors encountered during the latest parse operation.

bool AbstractDOMParser::getExitOnFirstFatalError | ( |  | ) |

Get the 'exit on first error' flag.

This method returns the state of the parser's exit-on-First-Fatal-Error flag. If this flag is true, then the parse will exit the first time it sees any non-wellformed XML or any validity error. The default state is true.

Returns:
  true, if the parser is currently configured to exit on the first fatal error, false otherwise.

See also:
  setExitOnFirstFatalError

bool AbstractDOMParser::getExpandEntityReferences | ( |  | ) |

Get the 'expand entity references' flag.

DEPRECATED Use getCreateEntityReferenceNodes() instead.

This method returns the state of the parser's expand entity references flag.

Returns:
  'true' if the expand entity reference flag is set on the parser, 'false' otherwise.

See also:
  setExpandEntityReferences , setCreateEntityReferenceNodes , getCreateEntityReferenceNodes

XMLCh* AbstractDOMParser::getExternalNoNamespaceSchemaLocation | ( |  | ) |

Get the noNamespace SchemaLocation that is specified externaly.

This method returns the no target namespace XML Schema Location that was specified using setExternalNoNamespaceSchemaLocation.

The parser owns the returned string, and the memory allocated for the returned string will be destroyed when the parser is deleted.

To ensure assessiblity of the returned information after the parser is deleted, callers need to copy and store the returned information somewhere else.

Returns:
  a pointer to the no target namespace Schema Location that was specified externally. The pointer spans the same life-time as the parser. A null pointer is returned if nothing was specified externally.

See also:
  setExternalNoNamespaceSchemaLocation(const XMLCh* const)

XMLCh* AbstractDOMParser::getExternalSchemaLocation | ( |  | ) |

Get the set of Namespace/SchemaLocation that is specified externaly.

This method returns the list of Namespace/SchemaLocation that was specified using setExternalSchemaLocation.

The parser owns the returned string, and the memory allocated for the returned string will be destroyed when the parser is deleted.

To ensure assessiblity of the returned information after the parser is deleted, callers need to copy and store the returned information somewhere else.

Returns:
  a pointer to the list of Namespace/SchemaLocation that was specified externally. The pointer spans the same life-time as the parser. A null pointer is returned if nothing was specified externally.

See also:
  setExternalSchemaLocation(const XMLCh* const)

GrammarResolver * AbstractDOMParser::getGrammarResolver | ( |  | ) | `[protected]`

| Get the Grammar resolver. This provides derived classes with access to the grammar resolver.

bool AbstractDOMParser::getIncludeIgnorableWhitespace | ( |  | ) |

Get the 'include ignorable whitespace' flag.

This method returns the state of the parser's include ignorable whitespace flag.

Returns:
  'true' if the include ignorable whitespace flag is set on the parser, 'false' otherwise.

See also:
  setIncludeIgnorableWhitespace

bool AbstractDOMParser::getLoadExternalDTD | ( |  | ) |

Get the 'Loading External DTD' flag.

This method returns the state of the parser's loading external DTD flag.

Returns:
  false, if the parser is currently configured to ignore external DTD completely, true otherwise.

See also:
  setLoadExternalDTD , getValidationScheme

MemoryManager * AbstractDOMParser::getMemoryManager | ( |  | ) | `[protected]`

bool AbstractDOMParser::getParseInProgress | ( |  | ) | `[protected]`

| Get the parse in progress flag. This provides derived classes with access to the parse in progress flag.

XMLScanner * AbstractDOMParser::getScanner | ( |  | ) | `[protected]`

| Get the XML scanner. This provides derived classes with access to the XML scanner.

SecurityManager* AbstractDOMParser::getSecurityManager | ( |  | ) |

Get the SecurityManager instance attached to this parser.

This method returns the security manager that was specified using setSecurityManager.

The SecurityManager instance must have been specified by the application; this should not be deleted until after the parser has been deleted (or a new SecurityManager instance has been supplied to the parser).

Returns:
  a pointer to the SecurityManager instance specified externally. A null pointer is returned if nothing was specified externally.

See also:
  setSecurityManager(const SecurityManager* const)

bool AbstractDOMParser::getStandardUriConformant | ( |  | ) |

Get the 'force standard uri flag'.

This method returns the state if the parser forces standard uri

Returns:
  true, if the parser is currently configured to force standard uri, i.e. malformed uri will be rejected.

See also:
  setStandardUriConformant

bool AbstractDOMParser::getValidationConstraintFatal | ( |  | ) |

This method returns the state of the parser's validation-constraint-fatal flag.

Returns:
  true, if the parser is currently configured to set validation constraint errors as fatal, false otherwise.

See also:
  setValidationContraintFatal

bool AbstractDOMParser::getValidationSchemaFullChecking | ( |  | ) |

Get the 'full schema constraint checking' flag.

This method returns the state of the parser's full schema constraint checking flag.

Returns:
  true, if the parser is currently configured to have full schema constraint checking, false otherwise.

See also:
  setValidationSchemaFullChecking

ValSchemes AbstractDOMParser::getValidationScheme | ( |  | ) |

This method returns an enumerated value that indicates the current validation scheme set on this parser.

Returns:
  The ValSchemes value current set on this parser.

See also:
  setValidationScheme

const XMLValidator& AbstractDOMParser::getValidator | ( |  | ) |

Get a const reference to the validator.

This method returns a reference to the parser's installed validator.

Returns:
  A const reference to the installed validator object.

virtual void AbstractDOMParser::ignorableWhitespace | ( | const XMLCh *const | chars,
|  | const unsigned int | length,
|  | const bool | cdataSection
| ) | `[virtual]`

Handle an ignorable whitespace vent.

This method is used to report all the whitespace characters, which are determined to be 'ignorable'. This distinction between characters is only made, if validation is enabled.

Any whitespace before content is ignored. If the current node is already of type DOMNode::TEXT_NODE, then these whitespaces are appended, otherwise a new Text node is created which stores this data. Essentially all contiguous ignorable characters are collected in one node.

Parameters:

  chars | A const pointer to a Unicode string representing the ignorable whitespace character data.
  length | The length of the Unicode string 'chars'.
  cdataSection | A flag indicating if the characters represent content from the CDATA section.

Implements XMLDocumentHandler.

bool AbstractDOMParser::isDocumentAdopted | ( |  | ) | `[protected]`

| Returns true if the user has adopted the document.

virtual void AbstractDOMParser::notationDecl | ( | const XMLNotationDecl & | notDecl,
|  | const bool | isIgnored
| ) | `[virtual]`

void AbstractDOMParser::parse | ( | const char *const | systemId | ) |

Parse via a file path or URL (in the local code page).

This method invokes the parsing process on the XML file specified by the native char* string parameter 'systemId'.

Parameters:

  systemId | A const char pointer to a native string which contains the path to the XML file to be parsed.

Exceptions:

  SAXException | Any SAX exception, possibly wrapping another exception.
  XMLException | An exception from the parser or client handler code.
  DOMException | A DOM exception as per DOM spec.

See also:
  parse(InputSource,...)

void AbstractDOMParser::parse | ( | const XMLCh *const | systemId | ) |

Parse via a file path or URL.

This method invokes the parsing process on the XML file specified by the Unicode string parameter 'systemId'. This method is borrowed from the SAX Parser interface.

Parameters:

  systemId | A const XMLCh pointer to the Unicode string which contains the path to the XML file to be parsed.

Exceptions:

  SAXException | Any SAX exception, possibly wrapping another exception.
  XMLException | An exception from the parser or client handler code.
  DOMException | A DOM exception as per DOM spec.

See also:
  parse(InputSource,...)

void AbstractDOMParser::parse | ( | const InputSource & | source | ) |

Parse via an input source object.

This method invokes the parsing process on the XML file specified by the InputSource parameter. This API is borrowed from the SAX Parser interface.

Parameters:

  source | A const reference to the InputSource object which points to the XML file to be parsed.

Exceptions:

  SAXException | Any SAX exception, possibly wrapping another exception.
  XMLException | An exception from the parser or client handler code.
  DOMException | A DOM exception as per DOM spec.

See also:
  InputSource::InputSource

bool AbstractDOMParser::parseFirst | ( | const InputSource & | source,
|  | XMLPScanToken & | toFill
| ) |

Begin a progressive parse operation.

This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.

It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls.

Parameters:

  source | A const reference to the InputSource object which points to the XML file to be parsed.
  toFill | A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.

Returns:
  'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.

See also:
  parseNext , parseFirst(XMLCh*,...) , parseFirst(char*,...)

bool AbstractDOMParser::parseFirst | ( | const char *const | systemId,
|  | XMLPScanToken & | toFill
| ) |

Begin a progressive parse operation.

This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.

It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls.

Parameters:

  systemId | A pointer to a regular native string represting the path to the XML file to be parsed.
  toFill | A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.

Returns:
  'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.

See also:
  parseNext , parseFirst(XMLCh*,...) , parseFirst(InputSource&,...)

bool AbstractDOMParser::parseFirst | ( | const XMLCh *const | systemId,
|  | XMLPScanToken & | toFill
| ) |

Begin a progressive parse operation.

This method is used to start a progressive parse on a XML file. To continue parsing, subsequent calls must be to the parseNext method.

It scans through the prolog and returns a token to be used on subsequent scanNext() calls. If the return value is true, then the token is legal and ready for further use. If it returns false, then the scan of the prolog failed and the token is not going to work on subsequent scanNext() calls.

Parameters:

  systemId | A pointer to a Unicode string represting the path to the XML file to be parsed.
  toFill | A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.

Returns:
  'true', if successful in parsing the prolog. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not parse the prolog.

See also:
  parseNext , parseFirst(char*,...) , parseFirst(InputSource&,...)

bool AbstractDOMParser::parseNext | ( | XMLPScanToken & | token | ) |

Continue a progressive parse operation.

This method is used to continue with progressive parsing of XML files started by a call to 'parseFirst' method.

It parses the XML file and stops as soon as it comes across a XML token (as defined in the XML specification).

Parameters:

  token | A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.

Returns:
  'true', if successful in parsing the next XML token. It indicates the user can go ahead with parsing the rest of the file. It returns 'false' to indicate that the parser could not find next token as per the XML specification production rule.

See also:
  parseFirst(XMLCh*,...) , parseFirst(char*,...) , parseFirst(InputSource&,...)

void AbstractDOMParser::parseReset | ( | XMLPScanToken & | token | ) |

Reset the parser after a progressive parse.

If a progressive parse loop exits before the end of the document is reached, the parser has no way of knowing this. So it will leave open any files or sockets or memory buffers that were in use at the time that the parse loop exited.

The next parse operation will cause these open files and such to be closed, but the next parse operation might occur at some unknown future point. To avoid this problem, you should reset the parser if you exit the loop early.

If you exited because of an error, then this cleanup will be done for you. Its only when you exit the file prematurely of your own accord, because you've found what you wanted in the file most likely.

Parameters:

  token | A token maintaing state information to maintain internal consistency between invocation of 'parseNext' calls.

See also:
  parseFirst(XMLCh*,...) , parseFirst(char*,...) , parseFirst(InputSource&,...)

void AbstractDOMParser::reset | ( |  | ) |

| Reset the parser. This method resets the state of the DOM driver and makes it ready for a fresh parse run.

virtual void AbstractDOMParser::resetDocType | ( |  | ) | `[virtual]`

virtual void AbstractDOMParser::resetDocument | ( |  | ) | `[virtual]`

| Handle a document reset event. This method allows the user installed Document Handler to 'reset' itself, freeing all the memory resources. The scanner calls this method before starting a new parse event. Implements XMLDocumentHandler.

void AbstractDOMParser::resetPool | ( |  | ) | `[protected]`

void AbstractDOMParser::setCalculateSrcOfs | ( | const bool | newState | ) |

Enable/disable src offset calculation.

This method allows users to enable/disable src offset calculation. Disabling the calculation will improve performance.

The parser's default state is: false.

Parameters:

  newState | The value specifying whether we should enable or disable src offset calculation

See also:
  getCalculateSrcOfs

void AbstractDOMParser::setCreateCommentNodes | ( | const bool | create | ) |

Set the 'create comment nodes' flag.

This method allows the user to specify whether the parser should create comment nodes in the DOM tree being produced.

The default value is 'true'.

Parameters:

  create | The new state of the create comment nodes flag.

See also:
  getCreateCommentNodes

void AbstractDOMParser::setCreateEntityReferenceNodes | ( | const bool | create | ) |

Set the 'include entity references' flag.

This method allows the user to specify whether the parser should create entity reference nodes in the DOM tree being produced. When the 'create' flag is true, the parser will create EntityReference nodes in the DOM tree. The EntityReference nodes and their child nodes will be read-only. When the 'create' flag is false, no EntityReference nodes will be created.

The replacement text of the entity is included in either case, either as a child of the Entity Reference node or in place at the location of the reference.

The default value is 'true'.

Parameters:

  create | The new state of the create entity reference nodes flag.

See also:
  getCreateEntityReferenceNodes

void AbstractDOMParser::setCurrentNode | ( | DOMNode * | toSet | ) | `[protected]`

Set the current DOM node.

This method sets the current node maintained inside the parser to the one specified.

Parameters:

  toSet | The DOM node which will be the current node.

void AbstractDOMParser::setDocument | ( | DOMDocument * | toSet | ) | `[protected]`

Set the document node.

This method sets the DOM Document node to the one specified.

Parameters:

  toSet | The new DOM Document node for this XML document.

void AbstractDOMParser::setDoNamespaces | ( | const bool | newState | ) |

Set the 'do namespaces' flag.

This method allows users to enable or disable the parser's namespace processing. When set to true, parser starts enforcing all the constraints and rules specified by the NameSpace specification.

The parser's default state is: false.

Parameters:

  newState | The value specifying whether NameSpace rules should be enforced or not.

See also:
  getDoNamespaces

void AbstractDOMParser::setDoSchema | ( | const bool | newState | ) |

Set the 'do schema' flag.

This method allows users to enable or disable the parser's schema processing. When set to false, parser will not process any schema found.

The parser's default state is: false.

Note: If set to true, namespace processing must also be turned on.

Parameters:

  newState | The value specifying whether schema support should be enforced or not.

See also:
  getDoSchema

void AbstractDOMParser::setDoValidation | ( | const bool | newState | ) |

This method allows users to enable or disable the parser's validation checks.

By default, the parser does not to any validation. The default value is false.

Parameters:

  newState | The value specifying whether the parser should do validity checks or not against the DTD in the input XML document.

See also:
  getDoValidation

void AbstractDOMParser::setExitOnFirstFatalError | ( | const bool | newState | ) |

Set the 'exit on first error' flag.

This method allows users to set the parser's behaviour when it encounters the first fatal error. If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.

The default value is 'true' and the parser exits on the first fatal error.

Parameters:

  newState | The value specifying whether the parser should continue or exit when it encounters the first fatal error.

See also:
  getExitOnFirstFatalError

void AbstractDOMParser::setExpandEntityReferences | ( | const bool | expand | ) |

Set the 'expand entity references' flag.

DEPRECATED. USE setCreateEntityReferenceNodes instead. This method allows the user to specify whether the parser should expand all entity reference nodes. When the 'do expansion' flag is true, the DOM tree does not have any entity reference nodes. It is replaced by the sub-tree representing the replacement text of the entity. When the 'do expansion' flag is false, the DOM tree contains an extra entity reference node, whose children is the sub tree of the replacement text.

The default value is 'false'.

Parameters:

  expand | The new state of the expand entity reference flag.

See also:
  setCreateEntityReferenceNodes

void AbstractDOMParser::setExternalNoNamespaceSchemaLocation | ( | const char *const | noNamespaceSchemaLocation | ) |

This method is same as setExternalNoNamespaceSchemaLocation(const XMLCh* const).

It takes native char string as parameter

Parameters:

  noNamespaceSchemaLocation | the XML Schema Location with no target namespace

See also:
  setExternalNoNamespaceSchemaLocation(const XMLCh* const)

void AbstractDOMParser::setExternalNoNamespaceSchemaLocation | ( | const XMLCh *const | noNamespaceSchemaLocation | ) |

This method allows the user to specify the no target namespace XML Schema Location externally.

If specified, the instance document's noNamespaceSchemaLocation attribute will be effectively ignored.

If this method is called more than once, only the last one takes effect.

The syntax is the same as for the noNamespaceSchemaLocation attribute that may occur in an instance document: e.g."file_name.xsd".

Parameters:

  noNamespaceSchemaLocation | the XML Schema Location with no target namespace

See also:
  getExternalNoNamespaceSchemaLocation

void AbstractDOMParser::setExternalSchemaLocation | ( | const char *const | schemaLocation | ) |

This method is same as setExternalSchemaLocation(const XMLCh* const).

It takes native char string as parameter

Parameters:

  schemaLocation | the list of schemas to use

See also:
  setExternalSchemaLocation(const XMLCh* const)

void AbstractDOMParser::setExternalSchemaLocation | ( | const XMLCh *const | schemaLocation | ) |

This method allows the user to specify a list of schemas to use.

If the targetNamespace of a schema specified using this method matches the targetNamespace of a schema occuring in the instance document in the schemaLocation attribute, or if the targetNamespace matches the namespace attribute of the "import" element, the schema specified by the user using this method will be used (i.e., the schemaLocation attribute in the instance document or on the "import" element will be effectively ignored).

If this method is called more than once, only the last one takes effect.

The syntax is the same as for schemaLocation attributes in instance documents: e.g, "http://www.example.com file_name.xsd". The user can specify more than one XML Schema in the list.

Parameters:

  schemaLocation | the list of schemas to use

See also:
  getExternalSchemaLocation

void AbstractDOMParser::setIncludeIgnorableWhitespace | ( | const bool | include | ) |

Set the 'include ignorable whitespace' flag.

This method allows the user to specify whether a validating parser should include ignorable whitespaces as text nodes. It has no effect on non-validating parsers which always include non-markup text.

When set to true (also the default), ignorable whitespaces will be added to the DOM tree as text nodes. The method DOMText::isIgnorableWhitespace() will return true for those text nodes only.

When set to false, all ignorable whitespace will be discarded and no text node is added to the DOM tree. Note: applications intended to process the "xml:space" attribute should not set this flag to false. And this flag also overrides any schema datateye whitespace facets, that is, all ignorable whitespace will be discarded even though 'preserve' is set in schema datatype whitespace facets.

Parameters:

  include | The new state of the include ignorable whitespace flag.

See also:
  getIncludeIgnorableWhitespace

void AbstractDOMParser::setLoadExternalDTD | ( | const bool | newState | ) |

Set the 'Loading External DTD' flag.

This method allows users to enable or disable the loading of external DTD. When set to false, the parser will ignore any external DTD completely if the validationScheme is set to Val_Never.

The parser's default state is: true.

This flag is ignored if the validationScheme is set to Val_Always or Val_Auto.

Parameters:

  newState | The value specifying whether external DTD should be loaded or not.

See also:
  getLoadExternalDTD , setValidationScheme

void AbstractDOMParser::setParseInProgress | ( | const bool | toSet | ) | `[protected]`

Set the parse in progress flag.

This method sets the parse in progress flag to true or false.

Parameters:

  toSet | The value of the flag to be set.

void AbstractDOMParser::setSecurityManager | ( | SecurityManager *const | securityManager | ) |

This allows an application to set a SecurityManager on the parser; this object stores information that various components use to limit their consumption of system resources while processing documents.

If this method is called more than once, only the last one takes effect. It may not be reset during a parse.

Parameters:

  securityManager | the SecurityManager instance to be used by this parser

See also:
  getSecurityManager

void AbstractDOMParser::setStandardUriConformant | ( | const bool | newState | ) |

Force standard uri.

This method allows users to tell the parser to force standard uri conformance.

The parser's default state is: false.

Parameters:

  newState | The value specifying whether the parser should reject malformed URI.

See also:
  getStandardUriConformant

void AbstractDOMParser::setValidationConstraintFatal | ( | const bool | newState | ) |

This method allows users to set the parser's behaviour when it encounters a validtion constraint error.

If set to true, and the the parser will treat validation error as fatal and will exit depends on the state of "getExitOnFirstFatalError". If false, then it will report the error and continue processing.

Note: setting this true does not mean the validation error will be printed with the word "Fatal Error". It is still printed as "Error", but the parser will exit if "setExitOnFirstFatalError" is set to true.

The default value is 'false'.

Parameters:

  newState | If true, the parser will exit if "setExitOnFirstFatalError" is set to true.

See also:
  getValidationConstraintFatal , setExitOnFirstFatalError

void AbstractDOMParser::setValidationSchemaFullChecking | ( | const bool | schemaFullChecking | ) |

This method allows the user to turn full Schema constraint checking on/off.

Only takes effect if Schema validation is enabled. If turned off, partial constraint checking is done.

Full schema constraint checking includes those checking that may be time-consuming or memory intensive. Currently, particle unique attribution constraint checking and particle derivation resriction checking are controlled by this option.

The parser's default state is: false.

Parameters:

  schemaFullChecking | True to turn on full schema constraint checking.

See also:
  getValidationSchemaFullChecking

void AbstractDOMParser::setValidationScheme | ( | const ValSchemes | newScheme | ) |

This method allows users to set the validation scheme to be used by this parser.

The value is one of the ValSchemes enumerated values defined by this class:

Val_Never - turn off validation
Val_Always - turn on validation
Val_Auto - turn on validation if any internal/external DTD subset have been seen

The parser's default state is: Val_Auto.

Parameters:

  newScheme | The new validation scheme to use.

See also:
  getValidationScheme

virtual void AbstractDOMParser::startAttList | ( | const DTDElementDecl & | elemDecl | ) | `[virtual]`

virtual void AbstractDOMParser::startDocument | ( |  | ) | `[virtual]`

| Handle a start document event. This method is used to report the start of the parsing process. Implements XMLDocumentHandler.

virtual void AbstractDOMParser::startElement | ( | const XMLElementDecl & | elemDecl,
|  | const unsigned int | urlId,
|  | const XMLCh *const | elemPrefix,
|  | const RefVectorOf< XMLAttr > & | attrList,
|  | const unsigned int | attrCount,
|  | const bool | isEmpty,
|  | const bool | isRoot
| ) | `[virtual]`

Handle a start element event.

This method is used to report the start of an element. It is called at the end of the element, by which time all attributes specified are also parsed. A new DOM Element node is created along with as many attribute nodes as required. This new element is added appended as a child of the current node in the tree, and then replaces it as the current node (if the isEmpty flag is false.)

Parameters:

  elemDecl | A const reference to the object containing element declaration information.
  urlId | An id referring to the namespace prefix, if namespaces setting is switched on.
  elemPrefix | A const pointer to a Unicode string containing the namespace prefix for this element. Applicable only when namespace processing is enabled.
  attrList | A const reference to the object containing the list of attributes just scanned for this element.
  attrCount | A count of number of attributes in the list specified by the parameter 'attrList'.
  isEmpty | A flag indicating whether this is an empty element or not. If empty, then no endElement() call will be made.
  isRoot | A flag indicating whether this element was the root element.

See also:
  DocumentHandler::startElement

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::startEntityReference | ( | const XMLEntityDecl & | entDecl | ) | `[virtual]`

Handle a start entity reference event.

This method is used to indicate the start of an entity reference. If the expand entity reference flag is true, then a new DOM Entity reference node is created.

Parameters:

  entDecl | A const reference to the object containing the entity declaration information.

Implements XMLDocumentHandler.

virtual void AbstractDOMParser::startExtSubset | ( |  | ) | `[virtual]`

virtual void AbstractDOMParser::startIntSubset | ( |  | ) | `[virtual]`

virtual void AbstractDOMParser::TextDecl | ( | const XMLCh *const | versionStr,
|  | const XMLCh *const | encodingStr
| ) | `[virtual]`

void AbstractDOMParser::useScanner | ( | const XMLCh *const | scannerName | ) |

Set the scanner to use when scanning the XML document.

This method allows users to set the the scanner to use when scanning a given XML document.

Parameters:

  scannerName | The name of the desired scanner

virtual void AbstractDOMParser::XMLDecl | ( | const XMLCh *const | versionStr,
|  | const XMLCh *const | encodingStr,
|  | const XMLCh *const | standaloneStr,
|  | const XMLCh *const | actualEncStr
| ) | `[virtual]`

Handle an XMLDecl event.

This method is used to report the XML decl scanned by the parser. Refer to the XML specification to see the meaning of parameters.

<font color="FF0000">This method is a no-op for this DOM implementation.</font>

Parameters:

  versionStr | A const pointer to a Unicode string representing version string value.
  encodingStr | A const pointer to a Unicode string representing the encoding string value.
  standaloneStr | A const pointer to a Unicode string representing the standalone string value.
  actualEncStr | A const pointer to a Unicode string representing the actual encoding string value.

Implements XMLDocumentHandler.

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

- AbstractDOMParser.hpp

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