Java Doc for XIncludeHandler.java in  » XML » xerces-2_9_1 » org » apache » xerces » xinclude » 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.xinclude 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xerces.xinclude.XIncludeHandler

All known Subclasses:   org.apache.xerces.xpointer.XPointerHandler,
XIncludeHandler
public class XIncludeHandler implements XMLComponent,XMLDocumentFilter,XMLDTDFilter(Code)

This is a pipeline component which performs XInclude handling, according to the W3C specification for XML Inclusions.

This component analyzes each event in the pipeline, looking for <include> elements. An <include> element is one which has a namespace of http://www.w3.org/2001/XInclude and a localname of include. When it finds an <include> element, it attempts to include the file specified in the href attribute of the element. If inclusion succeeds, all children of the <include> element are ignored (with the exception of checking for invalid children as outlined in the specification). If the inclusion fails, the <fallback> child of the <include> element is processed.

See the XInclude specification for more information on how XInclude is to be used.

This component requires the following features and properties from the component manager that uses it:

  • http://xml.org/sax/features/allow-dtd-events-after-endDTD
  • http://apache.org/xml/properties/internal/error-reporter
  • http://apache.org/xml/properties/internal/entity-resolver
Optional property:
  • http://apache.org/xml/properties/input-buffer-size
Furthermore, the NamespaceContext used in the pipeline is required to be an instance of XIncludeNamespaceSupport.

Currently, this implementation has only partial support for the XInclude specification. Specifically, it is missing support for XPointer document fragments. Thus, only whole documents can be included using this component in the pipeline.


author:
   Peter McCracken, IBM
author:
   Michael Glavassevich, IBM
version:
   $Id: XIncludeHandler.java 572045 2007-09-02 17:32:09Z mrglavas $
See Also:   XIncludeNamespaceSupport

Inner Class :protected static class Notation
Inner Class :protected static class UnparsedEntity

Field Summary
final protected static  StringALLOW_UE_AND_NOTATION_EVENTS
     Feature identifier: allow notation and unparsed entity events to be sent out of order.
final protected static  StringBUFFER_SIZE
     property identifier: buffer size.
final public static  StringCURRENT_BASE_URI
    
final protected static  StringDYNAMIC_VALIDATION
     Feature identifier: dynamic validation.
final protected static  StringENTITY_RESOLVER
     Property identifier: entity resolver.
final protected static  StringERROR_REPORTER
     Property identifier: error reporter.
final public static  StringHTTP_ACCEPT
    
final public static  StringHTTP_ACCEPT_LANGUAGE
    
final protected static  StringJAXP_SCHEMA_LANGUAGE
     Property identifier: JAXP schema language.
final protected static  StringPARSER_SETTINGS
    
final protected static  StringSCHEMA_VALIDATION
     Feature identifier: schema validation.
final protected static  StringSECURITY_MANAGER
     property identifier: security manager.
final protected static  StringSYMBOL_TABLE
     Property identifier: symbol table.
final protected static  StringVALIDATION
     Feature identifier: validation.
final public static  StringXINCLUDE_ATTR_ACCEPT
    
final public static  StringXINCLUDE_ATTR_ACCEPT_LANGUAGE
    
final public static  StringXINCLUDE_ATTR_ENCODING
    
final public static  StringXINCLUDE_ATTR_HREF
    
final public static  StringXINCLUDE_ATTR_PARSE
    
final public static  StringXINCLUDE_DEFAULT_CONFIGURATION
    
final public static  StringXINCLUDE_FALLBACK
    
final protected static  StringXINCLUDE_FIXUP_BASE_URIS
     Feature identifier: fixup base URIs.
final protected static  StringXINCLUDE_FIXUP_LANGUAGE
     Feature identifier: fixup language.
final public static  StringXINCLUDE_INCLUDE
    
final public static  StringXINCLUDE_INCLUDED
    
final public static  StringXINCLUDE_NS_URI
    
final public static  StringXINCLUDE_PARSE_TEXT
    
final public static  StringXINCLUDE_PARSE_XML
    
final public static  StringXPOINTER
    
final protected  StackfBaseURI
    
final protected  IntStackfBaseURIScope
    
protected  intfBufferSize
    
protected  XMLParserConfigurationfChildConfig
    
final protected  XMLResourceIdentifierfCurrentBaseURI
    
protected  StringfCurrentLanguage
    
protected  XMLDTDHandlerfDTDHandler
    
protected  XMLDTDSourcefDTDSource
    
protected  XMLLocatorfDocLocation
    
protected  XMLDocumentHandlerfDocumentHandler
    
protected  XMLDocumentSourcefDocumentSource
    
protected  XMLEntityResolverfEntityResolver
    
protected  XMLErrorReporterfErrorReporter
    
final protected  StackfExpandedSystemID
    
 booleanfHasIncludeReportedContent
    
protected  StringfHrefFromParent
    
final protected  IntStackfLanguageScope
    
final protected  StackfLanguageStack
    
final protected  StackfLiteralSystemID
    
protected  XIncludeNamespaceSupportfNamespaceContext
    
protected  StringfParentRelativeURI
    
protected  XIncludeHandlerfParentXIncludeHandler
    
protected  SecurityManagerfSecurityManager
    
protected  ParserConfigurationSettingsfSettings
    
protected  SymbolTablefSymbolTable
    
protected  XIncludeTextReaderfXInclude10TextReader
    
protected  XIncludeTextReaderfXInclude11TextReader
    
protected  XMLParserConfigurationfXIncludeChildConfig
    
protected  XMLLocatorWrapperfXIncludeLocator
    
protected  XIncludeMessageFormatterfXIncludeMessageFormatter
    
protected  XMLParserConfigurationfXPointerChildConfig
    
protected  XPointerProcessorfXPtrProcessor
    

Constructor Summary
public  XIncludeHandler()
    

Method Summary
protected  voidaddNotation(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
     Caches a notation.
protected  voidaddUnparsedEntity(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)
     Caches an unparsed entity.
public  voidattributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations)
    
public  voidcharacters(XMLString text, Augmentations augs)
    
protected  voidcheckAndSendNotation(Notation not)
     The purpose of this method is to check if a Notation conflicts with a previously declared notation in the current pipeline stack.
protected  voidcheckAndSendUnparsedEntity(UnparsedEntity ent)
     The purpose of this method is to check if an UnparsedEntity conflicts with a previously declared entity in the current pipeline stack.
protected  voidcheckNotation(String notName)
     Checks if a Notation with the given name was declared in the DTD of the document for the current pipeline.
protected  voidcheckUnparsedEntity(String entName)
     Checks if an UnparsedEntity with the given name was declared in the DTD of the document for the current pipeline.
public  voidcomment(XMLString text, Augmentations augs)
    
protected  voidcopyFeatures(XMLComponentManager from, ParserConfigurationSettings to)
    
protected  voidcopyFeatures(XMLComponentManager from, XMLParserConfiguration to)
    
public  voiddoctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
    
public  voidelementDecl(String name, String contentModel, Augmentations augmentations)
    
public  voidemptyElement(QName element, XMLAttributes attributes, Augmentations augs)
    
public  voidendAttlist(Augmentations augmentations)
    
public  voidendCDATA(Augmentations augs)
    
public  voidendConditional(Augmentations augmentations)
    
public  voidendDTD(Augmentations augmentations)
    
public  voidendDocument(Augmentations augs)
    
public  voidendElement(QName element, Augmentations augs)
    
public  voidendExternalSubset(Augmentations augmentations)
    
public  voidendGeneralEntity(String name, Augmentations augs)
    
public  voidendParameterEntity(String name, Augmentations augmentations)
    
public  voidexternalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
    
public  StringgetBaseURI(int depth)
    
public  XMLDTDHandlergetDTDHandler()
    
public  XMLDTDSourcegetDTDSource()
    
public  XMLDocumentHandlergetDocumentHandler()
    
public  XMLDocumentSourcegetDocumentSource()
    
public  BooleangetFeatureDefault(String featureId)
     Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
public  StringgetLanguage(int depth)
     Gets the language that was in use at that depth.
public  ObjectgetPropertyDefault(String propertyId)
     Returns the default state for a property, or null if this component does not want to report a default value for this property.
public  String[]getRecognizedFeatures()
     Returns a list of feature identifiers that are recognized by this component.
public  String[]getRecognizedProperties()
     Returns a list of property identifiers that are recognized by this component.
protected  StringgetRelativeBaseURI()
     Returns a URI, relative to the include parent's base URI, of the current [base URI].
public  StringgetRelativeURI(int depth)
     Returns a relative URI, which when resolved against the base URI at the specified depth, will create the current base URI.
protected  booleangetSawFallback(int depth)
     Returns whether an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.
protected  booleangetSawInclude(int depth)
     Return whether an <include> was encountered at the specified depth, as an ancestor of the current item.
protected  intgetState(int depth)
    
protected  intgetState()
    
protected  voidhandleFallbackElement()
    
protected  booleanhandleIncludeElement(XMLAttributes attributes)
    
protected  booleanhasXIncludeNamespace(QName element)
    
public  voidignorableWhitespace(XMLString text, Augmentations augs)
    
public  voidignoredCharacters(XMLString text, Augmentations augmentations)
    
public  voidinternalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations)
    
protected  booleanisFallbackElement(QName element)
     Checks if the element is an <fallback> element.
protected  booleanisIncludeElement(QName element)
     Checks if the element is an <include> element.
protected  booleanisRootDocument()
    
protected  booleanisTopLevelIncludedItem()
     Returns true if the current element is a top level included item.
protected  booleanisTopLevelIncludedItemViaFallback()
    
protected  booleanisTopLevelIncludedItemViaInclude()
    
protected  AugmentationsmodifyAugmentations(Augmentations augs)
     Modify the augmentations.
protected  AugmentationsmodifyAugmentations(Augmentations augs, boolean force)
     Modify the augmentations.
public  voidnotationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
    
protected  XMLAttributesprocessAttributes(XMLAttributes attributes)
     Processes the XMLAttributes object of startElement() calls.
protected  voidprocessXMLBaseAttributes(XMLAttributes attributes)
     Search for a xml:base attribute, and if one is found, put the new base URI into effect.
protected  voidprocessXMLLangAttributes(XMLAttributes attributes)
     Search for a xml:lang attribute, and if one is found, put the new [language] into effect.
public  voidprocessingInstruction(String target, XMLString data, Augmentations augs)
    
protected  voidreportFatalError(String key)
    
protected  voidreportFatalError(String key, Object[] args)
    
protected  voidreportResourceError(String key)
    
protected  voidreportResourceError(String key, Object[] args)
    
public  voidreset(XMLComponentManager componentManager)
    
protected  voidrestoreBaseURI()
     Discards the URIs at the top of the stack, and restores the ones beneath it.
public  StringrestoreLanguage()
     Discards the language at the top of the stack, and returns the one beneath it.
protected  booleansameBaseURIAsIncludeParent()
     Returns true if the current [base URI] is the same as the [base URI] that was in effect on the include parent.
protected  booleansameLanguageAsIncludeParent()
     Returns true if the current [language] is equivalent to the [language] that was in effect on the include parent, taking case-insensitivity into account as per [RFC 3066].
protected  voidsaveBaseURI()
     Saves the current base URI to the top of the stack.
protected  voidsaveLanguage(String language)
     Saves the given language on the top of the stack.
protected  booleansearchForRecursiveIncludes(String includedSysId)
     Checks if the file indicated by the given system id has already been included in the current stack.
public  voidsetDTDHandler(XMLDTDHandler handler)
    
public  voidsetDTDSource(XMLDTDSource source)
    
public  voidsetDocumentHandler(XMLDocumentHandler handler)
    
public  voidsetDocumentSource(XMLDocumentSource source)
    
public  voidsetFeature(String featureId, boolean state)
     Sets the state of a feature.
protected  voidsetHref(String href)
    
protected  voidsetParent(XIncludeHandler parent)
    
public  voidsetProperty(String propertyId, Object value)
     Sets the value of a property.
protected  voidsetSawFallback(int depth, boolean val)
     Records that an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.
protected  voidsetSawInclude(int depth, boolean val)
     Records that an <include> was encountered at the specified depth, as an ancestor of the current item.
protected  voidsetState(int state)
    
protected  voidsetXIncludeLocator(XMLLocatorWrapper locator)
    
protected  voidsetupCurrentBaseURI(XMLLocator locator)
    
public  voidstartAttlist(String elementName, Augmentations augmentations)
    
public  voidstartCDATA(Augmentations augs)
    
public  voidstartConditional(short type, Augmentations augmentations)
    
public  voidstartDTD(XMLLocator locator, Augmentations augmentations)
    
public  voidstartDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
     Event sent at the start of the document.
public  voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
    
public  voidstartExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations)
    
public  voidstartGeneralEntity(String name, XMLResourceIdentifier resId, String encoding, Augmentations augs)
    
public  voidstartParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations)
    
public  voidtextDecl(String version, String encoding, Augmentations augs)
    
public  voidunparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)
    
public  voidxmlDecl(String version, String encoding, String standalone, Augmentations augs)
    

Field Detail
ALLOW_UE_AND_NOTATION_EVENTS
final protected static String ALLOW_UE_AND_NOTATION_EVENTS(Code)
Feature identifier: allow notation and unparsed entity events to be sent out of order.



BUFFER_SIZE
final protected static String BUFFER_SIZE(Code)
property identifier: buffer size.



CURRENT_BASE_URI
final public static String CURRENT_BASE_URI(Code)
The identifier for the Augmentation that contains the current base URI



DYNAMIC_VALIDATION
final protected static String DYNAMIC_VALIDATION(Code)
Feature identifier: dynamic validation.



ENTITY_RESOLVER
final protected static String ENTITY_RESOLVER(Code)
Property identifier: entity resolver.



ERROR_REPORTER
final protected static String ERROR_REPORTER(Code)
Property identifier: error reporter.



HTTP_ACCEPT
final public static String HTTP_ACCEPT(Code)



HTTP_ACCEPT_LANGUAGE
final public static String HTTP_ACCEPT_LANGUAGE(Code)



JAXP_SCHEMA_LANGUAGE
final protected static String JAXP_SCHEMA_LANGUAGE(Code)
Property identifier: JAXP schema language.



PARSER_SETTINGS
final protected static String PARSER_SETTINGS(Code)



SCHEMA_VALIDATION
final protected static String SCHEMA_VALIDATION(Code)
Feature identifier: schema validation.



SECURITY_MANAGER
final protected static String SECURITY_MANAGER(Code)
property identifier: security manager.



SYMBOL_TABLE
final protected static String SYMBOL_TABLE(Code)
Property identifier: symbol table.



VALIDATION
final protected static String VALIDATION(Code)
Feature identifier: validation.



XINCLUDE_ATTR_ACCEPT
final public static String XINCLUDE_ATTR_ACCEPT(Code)



XINCLUDE_ATTR_ACCEPT_LANGUAGE
final public static String XINCLUDE_ATTR_ACCEPT_LANGUAGE(Code)



XINCLUDE_ATTR_ENCODING
final public static String XINCLUDE_ATTR_ENCODING(Code)



XINCLUDE_ATTR_HREF
final public static String XINCLUDE_ATTR_HREF(Code)



XINCLUDE_ATTR_PARSE
final public static String XINCLUDE_ATTR_PARSE(Code)



XINCLUDE_DEFAULT_CONFIGURATION
final public static String XINCLUDE_DEFAULT_CONFIGURATION(Code)



XINCLUDE_FALLBACK
final public static String XINCLUDE_FALLBACK(Code)



XINCLUDE_FIXUP_BASE_URIS
final protected static String XINCLUDE_FIXUP_BASE_URIS(Code)
Feature identifier: fixup base URIs.



XINCLUDE_FIXUP_LANGUAGE
final protected static String XINCLUDE_FIXUP_LANGUAGE(Code)
Feature identifier: fixup language.



XINCLUDE_INCLUDE
final public static String XINCLUDE_INCLUDE(Code)



XINCLUDE_INCLUDED
final public static String XINCLUDE_INCLUDED(Code)



XINCLUDE_NS_URI
final public static String XINCLUDE_NS_URI(Code)



XINCLUDE_PARSE_TEXT
final public static String XINCLUDE_PARSE_TEXT(Code)



XINCLUDE_PARSE_XML
final public static String XINCLUDE_PARSE_XML(Code)



XPOINTER
final public static String XPOINTER(Code)



fBaseURI
final protected Stack fBaseURI(Code)



fBaseURIScope
final protected IntStack fBaseURIScope(Code)



fBufferSize
protected int fBufferSize(Code)



fChildConfig
protected XMLParserConfiguration fChildConfig(Code)



fCurrentBaseURI
final protected XMLResourceIdentifier fCurrentBaseURI(Code)



fCurrentLanguage
protected String fCurrentLanguage(Code)



fDTDHandler
protected XMLDTDHandler fDTDHandler(Code)



fDTDSource
protected XMLDTDSource fDTDSource(Code)



fDocLocation
protected XMLLocator fDocLocation(Code)



fDocumentHandler
protected XMLDocumentHandler fDocumentHandler(Code)



fDocumentSource
protected XMLDocumentSource fDocumentSource(Code)



fEntityResolver
protected XMLEntityResolver fEntityResolver(Code)



fErrorReporter
protected XMLErrorReporter fErrorReporter(Code)



fExpandedSystemID
final protected Stack fExpandedSystemID(Code)



fHasIncludeReportedContent
boolean fHasIncludeReportedContent(Code)



fHrefFromParent
protected String fHrefFromParent(Code)



fLanguageScope
final protected IntStack fLanguageScope(Code)



fLanguageStack
final protected Stack fLanguageStack(Code)



fLiteralSystemID
final protected Stack fLiteralSystemID(Code)



fNamespaceContext
protected XIncludeNamespaceSupport fNamespaceContext(Code)



fParentRelativeURI
protected String fParentRelativeURI(Code)



fParentXIncludeHandler
protected XIncludeHandler fParentXIncludeHandler(Code)



fSecurityManager
protected SecurityManager fSecurityManager(Code)



fSettings
protected ParserConfigurationSettings fSettings(Code)



fSymbolTable
protected SymbolTable fSymbolTable(Code)



fXInclude10TextReader
protected XIncludeTextReader fXInclude10TextReader(Code)



fXInclude11TextReader
protected XIncludeTextReader fXInclude11TextReader(Code)



fXIncludeChildConfig
protected XMLParserConfiguration fXIncludeChildConfig(Code)



fXIncludeLocator
protected XMLLocatorWrapper fXIncludeLocator(Code)



fXIncludeMessageFormatter
protected XIncludeMessageFormatter fXIncludeMessageFormatter(Code)



fXPointerChildConfig
protected XMLParserConfiguration fXPointerChildConfig(Code)



fXPtrProcessor
protected XPointerProcessor fXPtrProcessor(Code)




Constructor Detail
XIncludeHandler
public XIncludeHandler()(Code)




Method Detail
addNotation
protected void addNotation(String name, XMLResourceIdentifier identifier, Augmentations augmentations)(Code)
Caches a notation.
Parameters:
  name - the name of the notation
Parameters:
  identifier - the location of the notation
Parameters:
  augmentations - any Augmentations that were on the original notation declaration



addUnparsedEntity
protected void addUnparsedEntity(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)(Code)
Caches an unparsed entity.
Parameters:
  name - the name of the unparsed entity
Parameters:
  identifier - the location of the unparsed entity
Parameters:
  augmentations - any Augmentations that were on the original unparsed entity declaration



attributeDecl
public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations) throws XNIException(Code)



characters
public void characters(XMLString text, Augmentations augs) throws XNIException(Code)



checkAndSendNotation
protected void checkAndSendNotation(Notation not)(Code)
The purpose of this method is to check if a Notation conflicts with a previously declared notation in the current pipeline stack. If there is no conflict, the Notation is sent by the root pipeline.
Parameters:
  not - the Notation to check for conflicts



checkAndSendUnparsedEntity
protected void checkAndSendUnparsedEntity(UnparsedEntity ent)(Code)
The purpose of this method is to check if an UnparsedEntity conflicts with a previously declared entity in the current pipeline stack. If there is no conflict, the UnparsedEntity is sent by the root pipeline.
Parameters:
  ent - the UnparsedEntity to check for conflicts



checkNotation
protected void checkNotation(String notName)(Code)
Checks if a Notation with the given name was declared in the DTD of the document for the current pipeline. If so, that Notation is passed to the root pipeline to be checked for conflicts, and sent to the root DTDHandler
Parameters:
  notName - the name of the Notation to check



checkUnparsedEntity
protected void checkUnparsedEntity(String entName)(Code)
Checks if an UnparsedEntity with the given name was declared in the DTD of the document for the current pipeline. If so, then the notation for the UnparsedEntity is checked. If that turns out okay, then the UnparsedEntity is passed to the root pipeline to be checked for conflicts, and sent to the root DTDHandler.
Parameters:
  entName - the name of the UnparsedEntity to check



comment
public void comment(XMLString text, Augmentations augs) throws XNIException(Code)



copyFeatures
protected void copyFeatures(XMLComponentManager from, ParserConfigurationSettings to)(Code)



copyFeatures
protected void copyFeatures(XMLComponentManager from, XMLParserConfiguration to)(Code)



doctypeDecl
public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException(Code)



elementDecl
public void elementDecl(String name, String contentModel, Augmentations augmentations) throws XNIException(Code)



emptyElement
public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code)



endAttlist
public void endAttlist(Augmentations augmentations) throws XNIException(Code)



endCDATA
public void endCDATA(Augmentations augs) throws XNIException(Code)



endConditional
public void endConditional(Augmentations augmentations) throws XNIException(Code)



endDTD
public void endDTD(Augmentations augmentations) throws XNIException(Code)



endDocument
public void endDocument(Augmentations augs) throws XNIException(Code)



endElement
public void endElement(QName element, Augmentations augs) throws XNIException(Code)



endExternalSubset
public void endExternalSubset(Augmentations augmentations) throws XNIException(Code)



endGeneralEntity
public void endGeneralEntity(String name, Augmentations augs) throws XNIException(Code)



endParameterEntity
public void endParameterEntity(String name, Augmentations augmentations) throws XNIException(Code)



externalEntityDecl
public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException(Code)



getBaseURI
public String getBaseURI(int depth)(Code)
Gets the base URI that was in use at that depth
Parameters:
  depth - the base URI



getDTDHandler
public XMLDTDHandler getDTDHandler()(Code)



getDTDSource
public XMLDTDSource getDTDSource()(Code)



getDocumentHandler
public XMLDocumentHandler getDocumentHandler()(Code)



getDocumentSource
public XMLDocumentSource getDocumentSource()(Code)



getFeatureDefault
public Boolean getFeatureDefault(String featureId)(Code)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
Parameters:
  featureId - The feature identifier.
since:
   Xerces 2.2.0



getLanguage
public String getLanguage(int depth)(Code)
Gets the language that was in use at that depth.
Parameters:
  depth - the language



getPropertyDefault
public Object getPropertyDefault(String propertyId)(Code)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
Parameters:
  propertyId - The property identifier.
since:
   Xerces 2.2.0



getRecognizedFeatures
public String[] getRecognizedFeatures()(Code)
Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.



getRecognizedProperties
public String[] getRecognizedProperties()(Code)
Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.



getRelativeBaseURI
protected String getRelativeBaseURI() throws MalformedURIException(Code)
Returns a URI, relative to the include parent's base URI, of the current [base URI]. For instance, if the current [base URI] was "dir1/dir2/file.xml" and the include parent's [base URI] was "dir/", this would return "dir2/file.xml". the relative URI



getRelativeURI
public String getRelativeURI(int depth) throws MalformedURIException(Code)
Returns a relative URI, which when resolved against the base URI at the specified depth, will create the current base URI. This is accomplished by merged the literal system IDs.
Parameters:
  depth - the depth at which to start creating the relative URI a relative URI to convert the base URI at the given depth to the currentbase URI



getSawFallback
protected boolean getSawFallback(int depth)(Code)
Returns whether an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.
Parameters:
  depth -



getSawInclude
protected boolean getSawInclude(int depth)(Code)
Return whether an <include> was encountered at the specified depth, as an ancestor of the current item.
Parameters:
  depth - true if an include was seen at the given depth, false otherwise



getState
protected int getState(int depth)(Code)



getState
protected int getState()(Code)



handleFallbackElement
protected void handleFallbackElement()(Code)



handleIncludeElement
protected boolean handleIncludeElement(XMLAttributes attributes) throws XNIException(Code)



hasXIncludeNamespace
protected boolean hasXIncludeNamespace(QName element)(Code)
Returns true if the element has the namespace "http://www.w3.org/2001/XInclude"
Parameters:
  element - the element to check true if the element has the namespace "http://www.w3.org/2001/XInclude"



ignorableWhitespace
public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException(Code)



ignoredCharacters
public void ignoredCharacters(XMLString text, Augmentations augmentations) throws XNIException(Code)



internalEntityDecl
public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations) throws XNIException(Code)



isFallbackElement
protected boolean isFallbackElement(QName element)(Code)
Checks if the element is an <fallback> element. The element must have the XInclude namespace, and a local name of "fallback".
Parameters:
  element - the element to check true if the element is an <fallback; element
See Also:   XIncludeHandler.hasXIncludeNamespace(QName)



isIncludeElement
protected boolean isIncludeElement(QName element)(Code)
Checks if the element is an <include> element. The element must have the XInclude namespace, and a local name of "include".
Parameters:
  element - the element to check true if the element is an <include> element
See Also:   XIncludeHandler.hasXIncludeNamespace(QName)



isRootDocument
protected boolean isRootDocument()(Code)



isTopLevelIncludedItem
protected boolean isTopLevelIncludedItem()(Code)
Returns true if the current element is a top level included item. This means it's either the child of a fallback element, or the top level item in an included document true if the current element is a top level included item



isTopLevelIncludedItemViaFallback
protected boolean isTopLevelIncludedItemViaFallback()(Code)



isTopLevelIncludedItemViaInclude
protected boolean isTopLevelIncludedItemViaInclude()(Code)



modifyAugmentations
protected Augmentations modifyAugmentations(Augmentations augs)(Code)
Modify the augmentations. Add an [included] infoset item, if the current element is a top level included item.
Parameters:
  augs - the Augmentations to modify. the modified Augmentations



modifyAugmentations
protected Augmentations modifyAugmentations(Augmentations augs, boolean force)(Code)
Modify the augmentations. Add an [included] infoset item, if force is true, or if the current element is a top level included item.
Parameters:
  augs - the Augmentations to modify.
Parameters:
  force - whether to force modification the modified Augmentations



notationDecl
public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException(Code)



processAttributes
protected XMLAttributes processAttributes(XMLAttributes attributes)(Code)
Processes the XMLAttributes object of startElement() calls. Performs the following tasks:
  • If the element is a top level included item whose [base URI] is different from the [base URI] of the include parent, then an xml:base attribute is added to specify the true [base URI]
  • For all namespace prefixes which are in-scope in an included item, but not in scope in the include parent, a xmlns:prefix attribute is added
  • For all attributes with a type of ENTITY, ENTITIES or NOTATIONS, the notations and unparsed entities are processed as described in the spec, sections 4.5.1 and 4.5.2

Parameters:
  attributes - the processed XMLAttributes



processXMLBaseAttributes
protected void processXMLBaseAttributes(XMLAttributes attributes)(Code)
Search for a xml:base attribute, and if one is found, put the new base URI into effect.



processXMLLangAttributes
protected void processXMLLangAttributes(XMLAttributes attributes)(Code)
Search for a xml:lang attribute, and if one is found, put the new [language] into effect.



processingInstruction
public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException(Code)



reportFatalError
protected void reportFatalError(String key)(Code)



reportFatalError
protected void reportFatalError(String key, Object[] args)(Code)



reportResourceError
protected void reportResourceError(String key)(Code)



reportResourceError
protected void reportResourceError(String key, Object[] args)(Code)



reset
public void reset(XMLComponentManager componentManager) throws XNIException(Code)



restoreBaseURI
protected void restoreBaseURI()(Code)
Discards the URIs at the top of the stack, and restores the ones beneath it.



restoreLanguage
public String restoreLanguage()(Code)
Discards the language at the top of the stack, and returns the one beneath it.



sameBaseURIAsIncludeParent
protected boolean sameBaseURIAsIncludeParent()(Code)
Returns true if the current [base URI] is the same as the [base URI] that was in effect on the include parent. This method should only be called when the current element is a top level included element, i.e. the direct child of a fallback element, or the root elements in an included document. The "include parent" is the element which, in the result infoset, will be the direct parent of the current element. true if the [base URIs] are the same string



sameLanguageAsIncludeParent
protected boolean sameLanguageAsIncludeParent()(Code)
Returns true if the current [language] is equivalent to the [language] that was in effect on the include parent, taking case-insensitivity into account as per [RFC 3066]. This method should only be called when the current element is a top level included element, i.e. the direct child of a fallback element, or the root elements in an included document. The "include parent" is the element which, in the result infoset, will be the direct parent of the current element. true if the [language] properties have the same valuetaking case-insensitivity into account as per [RFC 3066].



saveBaseURI
protected void saveBaseURI()(Code)
Saves the current base URI to the top of the stack.



saveLanguage
protected void saveLanguage(String language)(Code)
Saves the given language on the top of the stack.
Parameters:
  language - the language to push onto the stack.



searchForRecursiveIncludes
protected boolean searchForRecursiveIncludes(String includedSysId)(Code)
Checks if the file indicated by the given system id has already been included in the current stack.
Parameters:
  includedSysId - the system id to check for inclusion true if the source has already been included



setDTDHandler
public void setDTDHandler(XMLDTDHandler handler)(Code)



setDTDSource
public void setDTDSource(XMLDTDSource source)(Code)



setDocumentHandler
public void setDocumentHandler(XMLDocumentHandler handler)(Code)



setDocumentSource
public void setDocumentSource(XMLDocumentSource source)(Code)



setFeature
public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code)
Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

Note: Components should silently ignore features that do not affect the operation of the component.
Parameters:
  featureId - The feature identifier.
Parameters:
  state - The state of the feature.
throws:
  SAXNotRecognizedException - The component should not throwthis exception.
throws:
  SAXNotSupportedException - The component should not throwthis exception.




setHref
protected void setHref(String href)(Code)



setParent
protected void setParent(XIncludeHandler parent)(Code)
Set the parent of this XIncludeHandler in the tree
Parameters:
  parent -



setProperty
public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code)
Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

Note: Components should silently ignore properties that do not affect the operation of the component.
Parameters:
  propertyId - The property identifier.
Parameters:
  value - The value of the property.
throws:
  SAXNotRecognizedException - The component should not throwthis exception.
throws:
  SAXNotSupportedException - The component should not throwthis exception.




setSawFallback
protected void setSawFallback(int depth, boolean val)(Code)
Records that an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.
Parameters:
  depth -
Parameters:
  val -



setSawInclude
protected void setSawInclude(int depth, boolean val)(Code)
Records that an <include> was encountered at the specified depth, as an ancestor of the current item.
Parameters:
  depth -
Parameters:
  val -



setState
protected void setState(int state)(Code)



setXIncludeLocator
protected void setXIncludeLocator(XMLLocatorWrapper locator)(Code)



setupCurrentBaseURI
protected void setupCurrentBaseURI(XMLLocator locator)(Code)



startAttlist
public void startAttlist(String elementName, Augmentations augmentations) throws XNIException(Code)



startCDATA
public void startCDATA(Augmentations augs) throws XNIException(Code)



startConditional
public void startConditional(short type, Augmentations augmentations) throws XNIException(Code)



startDTD
public void startDTD(XMLLocator locator, Augmentations augmentations) throws XNIException(Code)



startDocument
public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException(Code)
Event sent at the start of the document. A fatal error will occur here, if it is detected that this document has been processed before. This event is only passed on to the document handler if this is the root document.



startElement
public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code)



startExternalSubset
public void startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException(Code)



startGeneralEntity
public void startGeneralEntity(String name, XMLResourceIdentifier resId, String encoding, Augmentations augs) throws XNIException(Code)



startParameterEntity
public void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations) throws XNIException(Code)



textDecl
public void textDecl(String version, String encoding, Augmentations augs) throws XNIException(Code)



unparsedEntityDecl
public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations) throws XNIException(Code)



xmlDecl
public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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