Java Doc for XCatalog.java in  » Web-Server » Rimfaxe-Web-Server » org » apache » xerces » readers » 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 » Web Server » Rimfaxe Web Server » org.apache.xerces.readers 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xerces.readers.XMLCatalogHandler
      org.apache.xerces.readers.XCatalog

XCatalog
public class XCatalog extends XMLCatalogHandler (Code)
This catalog supports the XCatalog proposal draft 0.2 posted to the xml-dev mailing list by John Cowan. XCatalog is an XML representation of the SGML Open TR9401:1997 catalog format. The current proposal supports public identifier maps, system identifier aliases, and public identifier prefix delegates. Refer to the XCatalog DTD for the full specification of this catalog format at http://www.ccil.org/~cowan/XML/XCatalog.html.

In order to use XCatalogs, you must write the catalog files with the following restrictions:

  • You must follow the XCatalog grammar.
  • You must specify the <!DOCTYPE> line with the PUBLIC specified as "-//DTD XCatalog//EN" or make sure that the system identifier is able to locate the XCatalog 0.2 DTD (which is included in the Jar file containing the org.apache.xerces.readers.XCatalog class). For example:
     <!DOCTYPE XCatalog PUBLIC "-//DTD XCatalog//EN" "org/apache/xerces/readers/xcatalog.dtd">
     
  • The enclosing <XCatalog> document root element is not optional -- it must be specified.
  • The Version attribute of the <XCatalog> has been modified from '#FIXED "1.0"' to '(0.1|0.2) "0.2"'.

To use this catalog in a parser, set an XCatalog instance as the parser's EntityResolver. For example:

 XMLParser parser  = new AnyParser();
 Catalog   catalog = new XCatalog();
 parser.getEntityHandler().setEntityResolver(catalog);
 

Once installed, catalog files that conform to the XCatalog grammar can be appended to the catalog by calling the loadCatalog method on the parser or the catalog instance. The following example loads the contents of two catalog files:

 parser.loadCatalog(new InputSource("catalogs/cat1.xml"));
 parser.loadCatalog(new InputSource("http://host/catalogs/cat2.xml"));
 

Limitations: The following are the current limitations of this XCatalog implementation:

  • No error checking is done to avoid circular Delegate or Extend references. Do not specify a combination of catalog files that reference each other.

author:
   Andy Clark, IBM
version:
   $Id: XCatalog.java,v 1.2 2000/04/04 21:14:25 andyc Exp $

Inner Class :class Parser extends SAXParser implements DocumentHandler

Field Summary
final static  StringBASE
     Base element name ("Base").
final static  StringDELEGATE
     Delegate element name ("Delegate").
final static  StringDTD
     XCatalog DTD resource name ("xcatalog.dtd").
final static  StringEXTEND
     Extend element name ("Extend").
final static  StringHREF
     HRef attribute name ("HRef").
final static  StringMAP
     Map element name ("Map").
final static  StringPUBLICID
     PublicID attribute name ("PublicID").
final static  StringREMAP
     Remap element name ("Remap").
final static  StringSYSTEMID
     SystemID attribute name ("SystemID").
final static  StringXCATALOG
     XCatalog element name ("XCatalog").
final public static  StringXCATALOG_DTD_PUBLICID
     XCatalog public identifier string ("-//DTD XCatalog//EN").

Constructor Summary
public  XCatalog()
     Constructs an XCatalog instance.

Method Summary
public  voidaddDelegateCatalog(String prefix, XCatalog catalog)
     Adds a delegate mapping.
public  XCataloggetDelegateCatalog(String prefix)
     Returns the catalog for the given delegate prefix.
public  EnumerationgetDelegateCatalogKeys()
     Returns an enumeration of delegate prefixes.
 booleanisURL(String str)
     Returns true if the string is a valid URL.
public  voidloadCatalog(InputSource source)
     Loads the catalog stream specified by the given input source and appends the contents to the catalog.
public  voidremoveDelegateCatalog(String prefix)
     Removes a delegate.
public  InputSourceresolveEntity(String publicId, String systemId)
     Resolves external entities.
Parameters:
  publicId - The public identifier used for entity resolution.
Parameters:
  systemId - If the publicId is not null, this systemId isto be considered the default system identifier;else a system identifier alias mapping isrequested.

Field Detail
BASE
final static String BASE(Code)
Base element name ("Base").



DELEGATE
final static String DELEGATE(Code)
Delegate element name ("Delegate").



DTD
final static String DTD(Code)
XCatalog DTD resource name ("xcatalog.dtd").



EXTEND
final static String EXTEND(Code)
Extend element name ("Extend").



HREF
final static String HREF(Code)
HRef attribute name ("HRef").



MAP
final static String MAP(Code)
Map element name ("Map").



PUBLICID
final static String PUBLICID(Code)
PublicID attribute name ("PublicID").



REMAP
final static String REMAP(Code)
Remap element name ("Remap").



SYSTEMID
final static String SYSTEMID(Code)
SystemID attribute name ("SystemID").



XCATALOG
final static String XCATALOG(Code)
XCatalog element name ("XCatalog").



XCATALOG_DTD_PUBLICID
final public static String XCATALOG_DTD_PUBLICID(Code)
XCatalog public identifier string ("-//DTD XCatalog//EN").




Constructor Detail
XCatalog
public XCatalog()(Code)
Constructs an XCatalog instance.




Method Detail
addDelegateCatalog
public void addDelegateCatalog(String prefix, XCatalog catalog)(Code)
Adds a delegate mapping. If the prefix of a public identifier matches a delegate prefix, then the delegate catalog is searched in order to resolve the identifier.

This method makes sure that prefixes that match each other are inserted into the delegate list in order of longest prefix length first.
Parameters:
  prefix - The delegate prefix.
Parameters:
  catalog - The delegate catalog.




getDelegateCatalog
public XCatalog getDelegateCatalog(String prefix)(Code)
Returns the catalog for the given delegate prefix.



getDelegateCatalogKeys
public Enumeration getDelegateCatalogKeys()(Code)
Returns an enumeration of delegate prefixes.



isURL
boolean isURL(String str)(Code)
Returns true if the string is a valid URL.



loadCatalog
public void loadCatalog(InputSource source) throws SAXException, IOException(Code)
Loads the catalog stream specified by the given input source and appends the contents to the catalog.
Parameters:
  source - The catalog source.
exception:
  org.xml.sax.SAXException - Throws exception on SAX error.
exception:
  java.io.IOException - Throws exception on i/o error.



removeDelegateCatalog
public void removeDelegateCatalog(String prefix)(Code)
Removes a delegate.
Parameters:
  prefix - The delegate prefix to remove.



resolveEntity
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException(Code)
Resolves external entities.
Parameters:
  publicId - The public identifier used for entity resolution.
Parameters:
  systemId - If the publicId is not null, this systemId isto be considered the default system identifier;else a system identifier alias mapping isrequested. Returns the input source of the resolved entity or nullif no resolution is possible.
exception:
  org.xml.sax.SAXException - Exception thrown on SAX error.
exception:
  java.io.IOException - Exception thrown on i/o error.



Methods inherited from org.apache.xerces.readers.XMLCatalogHandler
public void addPublicMapping(String publicId, String systemId)(Code)(Java Doc)
public void addSystemMapping(String systemId1, String systemId2)(Code)(Java Doc)
public String getPublicMapping(String publicId)(Code)(Java Doc)
public Enumeration getPublicMappingKeys()(Code)(Java Doc)
public String getSystemMapping(String systemId)(Code)(Java Doc)
public Enumeration getSystemMappingKeys()(Code)(Java Doc)
abstract public void loadCatalog(InputSource source) throws Exception(Code)(Java Doc)
public void removePublicMapping(System publicId)(Code)(Java Doc)
public void removeSystemMapping(String systemId)(Code)(Java Doc)
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException(Code)(Java Doc)

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.