Java Doc for XMLParserConfiguration.java in  » XML » xerces-2_9_1 » org » apache » xerces » xni » parser » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xerces 2_9_1 » org.apache.xerces.xni.parser 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.xerces.xni.parser.XMLParserConfiguration

All known Subclasses:   org.apache.xerces.parsers.BasicParserConfiguration,  org.apache.xerces.dom.DOMConfigurationImpl,
XMLParserConfiguration
public interface XMLParserConfiguration extends XMLComponentManager(Code)
Represents a parser configuration. The parser configuration maintains a table of recognized features and properties, assembles components for the parsing pipeline, and is responsible for initiating parsing of an XML document.

By separating the configuration of a parser from the specific parser instance, applications can create new configurations and re-use the existing parser components and external API generators (e.g. the DOMParser and SAXParser).

The internals of any specific parser configuration instance are hidden. Therefore, each configuration may implement the parsing mechanism any way necessary. However, the parser configuration should follow these guidelines:

  • Call the reset method on each component before parsing. This is only required if the configuration is re-using existing components that conform to the XMLComponent interface. If the configuration uses all custom parts, then it is free to implement everything as it sees fit as long as it follows the other guidelines.
  • Call the setFeature and setProperty method on each component during parsing to propagate features and properties that have changed. This is only required if the configuration is re-using existing components that conform to the XMLComponent interface. If the configuration uses all custom parts, then it is free to implement everything as it sees fit as long as it follows the other guidelines.
  • Pass the same unique String references for all symbols that are propagated to the registered handlers. Symbols include, but may not be limited to, the names of elements and attributes (including their uri, prefix, and localpart). This is suggested but not an absolute must. However, the standard parser components may require access to the same symbol table for creation of unique symbol references to be propagated in the XNI pipeline.

author:
   Arnaud Le Hors, IBM
author:
   Andy Clark, IBM
version:
   $Id: XMLParserConfiguration.java 447244 2006-09-18 05:20:40Z mrglavas $




Method Summary
public  voidaddRecognizedFeatures(String[] featureIds)
     Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
public  voidaddRecognizedProperties(String[] propertyIds)
     Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
public  XMLDTDContentModelHandlergetDTDContentModelHandler()
     Returns the registered DTD content model handler.
public  XMLDTDHandlergetDTDHandler()
     Returns the registered DTD handler.
public  XMLDocumentHandlergetDocumentHandler()
     Returns the registered document handler.
public  XMLEntityResolvergetEntityResolver()
     Returns the registered entity resolver.
public  XMLErrorHandlergetErrorHandler()
     Returns the registered error handler.
public  booleangetFeature(String featureId)
     Returns the state of a feature.
public  LocalegetLocale()
     Returns the locale.
public  ObjectgetProperty(String propertyId)
     Returns the value of a property.
public  voidparse(XMLInputSource inputSource)
     Parse an XML document.

The parser can use this method to instruct this configuration to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Parsers may not invoke this method while a parse is in progress. Once a parse is complete, the parser may then parse another XML document.

This method is synchronous: it will not return until parsing has ended.

public  voidsetDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
     Sets the DTD content model handler.
public  voidsetDTDHandler(XMLDTDHandler dtdHandler)
     Sets the DTD handler.
public  voidsetDocumentHandler(XMLDocumentHandler documentHandler)
     Sets the document handler to receive information about the document.
public  voidsetEntityResolver(XMLEntityResolver entityResolver)
     Sets the entity resolver.
public  voidsetErrorHandler(XMLErrorHandler errorHandler)
     Sets the error handler.
public  voidsetFeature(String featureId, boolean state)
     Sets the state of a feature.
public  voidsetLocale(Locale locale)
     Set the locale to use for messages.
public  voidsetProperty(String propertyId, Object value)
     Sets the value of a property.



Method Detail
addRecognizedFeatures
public void addRecognizedFeatures(String[] featureIds)(Code)
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
Parameters:
  featureIds - An array of the additional feature identifiers to be recognized.



addRecognizedProperties
public void addRecognizedProperties(String[] propertyIds)(Code)
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
Parameters:
  propertyIds - An array of the additional property identifiers to be recognized.



getDTDContentModelHandler
public XMLDTDContentModelHandler getDTDContentModelHandler()(Code)
Returns the registered DTD content model handler.



getDTDHandler
public XMLDTDHandler getDTDHandler()(Code)
Returns the registered DTD handler.



getDocumentHandler
public XMLDocumentHandler getDocumentHandler()(Code)
Returns the registered document handler.



getEntityResolver
public XMLEntityResolver getEntityResolver()(Code)
Returns the registered entity resolver.



getErrorHandler
public XMLErrorHandler getErrorHandler()(Code)
Returns the registered error handler.



getFeature
public boolean getFeature(String featureId) throws XMLConfigurationException(Code)
Returns the state of a feature.
Parameters:
  featureId - The feature identifier.
throws:
  XMLConfigurationException - Thrown if there is a configurationerror.



getLocale
public Locale getLocale()(Code)
Returns the locale.



getProperty
public Object getProperty(String propertyId) throws XMLConfigurationException(Code)
Returns the value of a property.
Parameters:
  propertyId - The property identifier.
throws:
  XMLConfigurationException - Thrown if there is a configurationerror.



parse
public void parse(XMLInputSource inputSource) throws XNIException, IOException(Code)
Parse an XML document.

The parser can use this method to instruct this configuration to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Parsers may not invoke this method while a parse is in progress. Once a parse is complete, the parser may then parse another XML document.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

When this method returns, all characters streams and byte streams opened by the parser are closed.
Parameters:
  inputSource - The input source for the top-level of theXML document.
exception:
  XNIException - Any XNI exception, possibly wrapping another exception.
exception:
  IOException - An IO exception from the parser, possiblyfrom a byte stream or character streamsupplied by the parser.




setDTDContentModelHandler
public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)(Code)
Sets the DTD content model handler.
Parameters:
  dtdContentModelHandler - The DTD content model handler.



setDTDHandler
public void setDTDHandler(XMLDTDHandler dtdHandler)(Code)
Sets the DTD handler.
Parameters:
  dtdHandler - The DTD handler.



setDocumentHandler
public void setDocumentHandler(XMLDocumentHandler documentHandler)(Code)
Sets the document handler to receive information about the document.
Parameters:
  documentHandler - The document handler.



setEntityResolver
public void setEntityResolver(XMLEntityResolver entityResolver)(Code)
Sets the entity resolver.
Parameters:
  entityResolver - The new entity resolver.



setErrorHandler
public void setErrorHandler(XMLErrorHandler errorHandler)(Code)
Sets the error handler.
Parameters:
  errorHandler - The error resolver.



setFeature
public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code)
Sets the state of a feature. This method is called by the parser and gets propagated to components in this parser configuration.
Parameters:
  featureId - The feature identifier.
Parameters:
  state - The state of the feature.
throws:
  XMLConfigurationException - Thrown if there is a configurationerror.



setLocale
public void setLocale(Locale locale) throws XNIException(Code)
Set the locale to use for messages.
Parameters:
  locale - The locale object to use for localization of messages.
exception:
  XNIException - Thrown if the parser does not support thespecified locale.



setProperty
public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code)
Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.
Parameters:
  propertyId - The property identifier.
Parameters:
  value - The value of the property.
throws:
  XMLConfigurationException - Thrown if there is a configurationerror.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.