~ubuntu-branches/ubuntu/precise/xerces-c/precise

« back to all changes in this revision

Viewing changes to src/xercesc/parsers/SAXParser.hpp

  • Committer: Bazaar Package Importer
  • Author(s): Jay Berkenbilt
  • Date: 2010-05-01 08:39:53 UTC
  • mfrom: (2.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100501083953-2rm5l9kbziszygpx
Tags: 3.1.1-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 */
17
17
 
18
18
/*
19
 
 * $Id: SAXParser.hpp 903123 2010-01-26 08:23:46Z borisk $
 
19
 * $Id: SAXParser.hpp 932887 2010-04-11 13:04:59Z borisk $
20
20
 */
21
21
 
22
22
#if !defined(XERCESC_INCLUDE_GUARD_SAXPARSER_HPP)
106
106
      *                   parser is responsible for freeing the memory.
107
107
      * @param manager    Pointer to the memory manager to be used to
108
108
      *                   allocate objects.
109
 
      * @param gramPool   The collection of cached grammers.
 
109
      * @param gramPool   The collection of cached grammars.
110
110
      */
111
111
    SAXParser
112
112
    (
306
306
      */
307
307
    bool getValidationConstraintFatal() const;
308
308
 
309
 
   /** Get the set of Namespace/SchemaLocation that is specified externaly.
 
309
   /** Get the set of Namespace/SchemaLocation that is specified externally.
310
310
      *
311
311
      * This method returns the list of Namespace/SchemaLocation that was
312
312
      * specified using setExternalSchemaLocation.
314
314
      * The parser owns the returned string, and the memory allocated for
315
315
      * the returned string will be destroyed when the parser is deleted.
316
316
      *
317
 
      * To ensure assessiblity of the returned information after the parser
 
317
      * To ensure accessibility of the returned information after the parser
318
318
      * is deleted, callers need to copy and store the returned information
319
319
      * somewhere else.
320
320
      *
327
327
      */
328
328
    XMLCh* getExternalSchemaLocation() const;
329
329
 
330
 
   /** Get the noNamespace SchemaLocation that is specified externaly.
 
330
   /** Get the noNamespace SchemaLocation that is specified externally.
331
331
      *
332
332
      * This method returns the no target namespace XML Schema Location
333
333
      * that was specified using setExternalNoNamespaceSchemaLocation.
335
335
      * The parser owns the returned string, and the memory allocated for
336
336
      * the returned string will be destroyed when the parser is deleted.
337
337
      *
338
 
      * To ensure assessiblity of the returned information after the parser
 
338
      * To ensure accessibility of the returned information after the parser
339
339
      * is deleted, callers need to copy and store the returned information
340
340
      * somewhere else.
341
341
      *
639
639
      *
640
640
      * Full schema constraint checking includes those checking that may
641
641
      * be time-consuming or memory intensive. Currently, particle unique
642
 
      * attribution constraint checking and particle derivation resriction checking
 
642
      * attribution constraint checking and particle derivation restriction checking
643
643
      * are controlled by this option.
644
644
      *
645
645
      * The parser's default state is: false.
682
682
 
683
683
    /**
684
684
      * This method allows users to set the parser's behaviour when it
685
 
      * encounters a validtion constraint error. If set to true, and the
 
685
      * encounters a validation constraint error. If set to true, and the
686
686
      * the parser will treat validation error as fatal and will exit depends on the
687
687
      * state of "getExitOnFirstFatalError". If false, then it will
688
688
      * report the error and continue processing.
704
704
    /**
705
705
      * This method allows the user to specify a list of schemas to use.
706
706
      * If the targetNamespace of a schema specified using this method matches
707
 
      * the targetNamespace of a schema occuring in the instance document in
 
707
      * the targetNamespace of a schema occurring in the instance document in
708
708
      * the schemaLocation attribute, or if the targetNamespace matches the
709
709
      * namespace attribute of the "import" element, the schema specified by the
710
710
      * user using this method will be used (i.e., the schemaLocation attribute
1041
1041
      * the scan of the prolog failed and the token is not going to work on
1042
1042
      * subsequent scanNext() calls.
1043
1043
      *
1044
 
      * @param systemId A pointer to a Unicode string represting the path
 
1044
      * @param systemId A pointer to a Unicode string representing the path
1045
1045
      *                 to the XML file to be parsed.
1046
1046
      * @param toFill   A token maintaing state information to maintain
1047
1047
      *                 internal consistency between invocation of 'parseNext'
1074
1074
      * the scan of the prolog failed and the token is not going to work on
1075
1075
      * subsequent scanNext() calls.
1076
1076
      *
1077
 
      * @param systemId A pointer to a regular native string represting
 
1077
      * @param systemId A pointer to a regular native string representing
1078
1078
      *                 the path to the XML file to be parsed.
1079
1079
      * @param toFill   A token maintaing state information to maintain
1080
 
      *                 internal consIstency between invocation of 'parseNext'
 
1080
      *                 internal consistency between invocation of 'parseNext'
1081
1081
      *                 calls.
1082
1082
      *
1083
1083
      * @return 'true', if successful in parsing the prolog. It indicates the
1199
1199
      *               points to the schema grammar file to be preparsed.
1200
1200
      * @param grammarType The grammar type (Schema or DTD).
1201
1201
      * @param toCache If <code>true</code>, we cache the preparsed grammar,
1202
 
      *                otherwise, no chaching. Default is <code>false</code>.
 
1202
      *                otherwise, no caching. Default is <code>false</code>.
1203
1203
      * @return The preparsed schema grammar object (SchemaGrammar or
1204
1204
      *         DTDGrammar). That grammar object is owned by the parser.
1205
1205
      *
1229
1229
      *                 preparsed.
1230
1230
      * @param grammarType The grammar type (Schema or DTD).
1231
1231
      * @param toCache If <code>true</code>, we cache the preparsed grammar,
1232
 
      *                otherwise, no chaching. Default is <code>false</code>.
 
1232
      *                otherwise, no caching. Default is <code>false</code>.
1233
1233
      * @return The preparsed schema grammar object (SchemaGrammar or
1234
1234
      *         DTDGrammar). That grammar object is owned by the parser.
1235
1235
      *
1256
1256
      *                 the path to the XML grammar file to be preparsed.
1257
1257
      * @param grammarType The grammar type (Schema or DTD).
1258
1258
      * @param toCache If <code>true</code>, we cache the preparsed grammar,
1259
 
      *                otherwise, no chaching. Default is <code>false</code>.
 
1259
      *                otherwise, no caching. Default is <code>false</code>.
1260
1260
      * @return The preparsed schema grammar object (SchemaGrammar or
1261
1261
      *         DTDGrammar). That grammar object is owned by the parser.
1262
1262
      *
1511
1511
      * was just scanned.
1512
1512
      *
1513
1513
      * <p>If any advanced callback handlers are installed, the
1514
 
      * corresponding 'endEnityReference' method is invoked.</p>
 
1514
      * corresponding 'endEntityReference' method is invoked.</p>
1515
1515
      *
1516
1516
      * @param entDecl A const reference to the object containing the
1517
1517
      *                entity declaration information.
1606
1606
      * This method is used to indicate the start of an entity reference.
1607
1607
      *
1608
1608
      * <p>If any advanced callback handlers are installed, the
1609
 
      * corresponding 'endEnityReference' method is invoked.</p>
 
1609
      * corresponding 'endEntityReference' method is invoked.</p>
1610
1610
      *
1611
1611
      * @param entDecl A const reference to the object containing the
1612
1612
      *                entity declaration information.
1717
1717
 
1718
1718
    /**
1719
1719
      * This method allows an installed XMLEntityHandler to further
1720
 
      * process any system id's of enternal entities encountered in
 
1720
      * process any system id's of external entities encountered in
1721
1721
      * the XML file being parsed, such as redirection etc.
1722
1722
      *
1723
1723
      * <b>This method always returns 'false'