Java Doc for NamespaceSupport.java in  » 6.0-JDK-Modules » jax-ws-runtime » com » sun » xml » ws » util » 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 » 6.0 JDK Modules » jax ws runtime » com.sun.xml.ws.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.xml.ws.util.NamespaceSupport

NamespaceSupport
public class NamespaceSupport (Code)
Encapsulate Namespace logic for use by SAX drivers.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This class encapsulates the logic of Namespace processing: it tracks the declarations currently in force for each context and automatically processes qualified XML 1.0 names into their Namespace parts; it can also be used in reverse for generating XML 1.0 from Namespaces.

Namespace support objects are reusable, but the reset method must be invoked between each session.

Here is a simple session:

 String parts[] = new String[3];
 NamespaceSupport support = new NamespaceSupport();
 support.pushContext();
 support.declarePrefix("", "http://www.w3.org/1999/xhtml");
 support.declarePrefix("dc", "http://www.purl.org/dc#");
 String parts[] = support.processName("p", parts, false);
 System.out.println("Namespace URI: " + parts[0]);
 System.out.println("Local name: " + parts[1]);
 System.out.println("Raw name: " + parts[2]);
 String parts[] = support.processName("dc:title", parts, false);
 System.out.println("Namespace URI: " + parts[0]);
 System.out.println("Local name: " + parts[1]);
 System.out.println("Raw name: " + parts[2]);
 support.popContext();
 

Note that this class is optimized for the use case where most elements do not contain Namespace declarations: if the same prefix/URI mapping is repeated for each context (for example), this class will be somewhat less efficient.


author:
   David Megginson
author:
   WS Development Team

Inner Class :final static class Context

Field Summary
final public static  StringXMLNS
     The XML Namespace as a constant.

Constructor Summary
public  NamespaceSupport()
     Create a new Namespace support object.
public  NamespaceSupport(NamespaceSupport that)
    

Method Summary
public  booleandeclarePrefix(String prefix, String uri)
     Declare a Namespace prefix.

This method declares a prefix in the current Namespace context; the prefix will remain in force until this context is popped, unless it is shadowed in a descendant context.

To declare a default Namespace, use the empty string.

public  Iterable<String>getDeclaredPrefixes()
     Return an enumeration of all prefixes declared in this context.
public  StringgetPrefix(String uri)
     Return one of the prefixes mapped to a Namespace URI.

If more than one prefix is currently mapped to the same URI, this method will make an arbitrary selection; if you want all of the prefixes, use the NamespaceSupport.getPrefixes method instead.

Note: this will never return the empty (default) prefix; to check for a default prefix, use the NamespaceSupport.getURI getURI method with an argument of "".


Parameters:
  uri - The Namespace URI.
public  Iterable<String>getPrefixes()
     Return an enumeration of all prefixes currently declared.
public  IteratorgetPrefixes(String uri)
     Return an enumeration of all prefixes currently declared for a URI.

This method returns prefixes mapped to a specific Namespace URI.

public  StringgetURI(String prefix)
     Look up a prefix and get the currently-mapped Namespace URI.

This method looks up the prefix in the current context. Use the empty string ("") for the default Namespace.


Parameters:
  prefix - The prefix to look up.
public  voidpopContext()
     Revert to the previous Namespace context.

Normally, you should pop the context at the end of each XML element.

public  String[]processName(String qName, String parts, boolean isAttribute)
     Process a raw XML 1.0 name.

This method processes a raw XML 1.0 name in the current context by removing the prefix and looking it up among the prefixes currently declared.

public  voidpushContext()
     Start a new Namespace context.
public  voidreset()
     Reset this Namespace support object for reuse.
public  voidslideContextDown()
    
public  voidslideContextUp()
    

Field Detail
XMLNS
final public static String XMLNS(Code)
The XML Namespace as a constant.

This is the Namespace URI that is automatically mapped to the "xml" prefix.





Constructor Detail
NamespaceSupport
public NamespaceSupport()(Code)
Create a new Namespace support object.



NamespaceSupport
public NamespaceSupport(NamespaceSupport that)(Code)




Method Detail
declarePrefix
public boolean declarePrefix(String prefix, String uri)(Code)
Declare a Namespace prefix.

This method declares a prefix in the current Namespace context; the prefix will remain in force until this context is popped, unless it is shadowed in a descendant context.

To declare a default Namespace, use the empty string. The prefix must not be "xml" or "xmlns".

Note that you must not declare a prefix after you've pushed and popped another Namespace.

Note that there is an asymmetry in this library: while NamespaceSupport.getPrefix getPrefix will not return the default "" prefix, even if you have declared one; to check for a default prefix, you have to look it up explicitly using NamespaceSupport.getURI getURI . This asymmetry exists to make it easier to look up prefixes for attribute names, where the default prefix is not allowed.


Parameters:
  prefix - The prefix to declare, or null for the emptystring.
Parameters:
  uri - The Namespace URI to associate with the prefix. true if the prefix was legal, false otherwise
See Also:   NamespaceSupport.processName
See Also:   NamespaceSupport.getURI
See Also:   NamespaceSupport.getPrefix



getDeclaredPrefixes
public Iterable<String> getDeclaredPrefixes()(Code)
Return an enumeration of all prefixes declared in this context.

The empty (default) prefix will be included in this enumeration; note that this behaviour differs from that of NamespaceSupport.getPrefix and NamespaceSupport.getPrefixes .

An enumeration of all prefixes declared in thiscontext.
See Also:   NamespaceSupport.getPrefixes
See Also:   NamespaceSupport.getURI



getPrefix
public String getPrefix(String uri)(Code)
Return one of the prefixes mapped to a Namespace URI.

If more than one prefix is currently mapped to the same URI, this method will make an arbitrary selection; if you want all of the prefixes, use the NamespaceSupport.getPrefixes method instead.

Note: this will never return the empty (default) prefix; to check for a default prefix, use the NamespaceSupport.getURI getURI method with an argument of "".


Parameters:
  uri - The Namespace URI. One of the prefixes currently mapped to the URI supplied,or null if none is mapped or if the URI is assigned tothe default Namespace.
See Also:   NamespaceSupport.getPrefixes(java.lang.String)
See Also:   NamespaceSupport.getURI



getPrefixes
public Iterable<String> getPrefixes()(Code)
Return an enumeration of all prefixes currently declared.

Note: if there is a default prefix, it will not be returned in this enumeration; check for the default prefix using the NamespaceSupport.getURI getURI with an argument of "".

An enumeration of all prefixes declared in thecurrent context except for the empty (default)prefix.
See Also:   NamespaceSupport.getDeclaredPrefixes
See Also:   NamespaceSupport.getURI



getPrefixes
public Iterator getPrefixes(String uri)(Code)
Return an enumeration of all prefixes currently declared for a URI.

This method returns prefixes mapped to a specific Namespace URI. The xml: prefix will be included. If you want only one prefix that's mapped to the Namespace URI, and you don't care which one you get, use the NamespaceSupport.getPrefix getPrefix method instead.

Note: the empty (default) prefix is never included in this enumeration; to check for the presence of a default Namespace, use the NamespaceSupport.getURI getURI method with an argument of "".


Parameters:
  uri - The Namespace URI. An enumeration of all prefixes declared in thecurrent context.
See Also:   NamespaceSupport.getPrefix
See Also:   NamespaceSupport.getDeclaredPrefixes
See Also:   NamespaceSupport.getURI



getURI
public String getURI(String prefix)(Code)
Look up a prefix and get the currently-mapped Namespace URI.

This method looks up the prefix in the current context. Use the empty string ("") for the default Namespace.


Parameters:
  prefix - The prefix to look up. The associated Namespace URI, or null if the prefixis undeclared in this context.
See Also:   NamespaceSupport.getPrefix
See Also:   NamespaceSupport.getPrefixes



popContext
public void popContext()(Code)
Revert to the previous Namespace context.

Normally, you should pop the context at the end of each XML element. After popping the context, all Namespace prefix mappings that were previously in force are restored.

You must not attempt to declare additional Namespace prefixes after popping a context, unless you push another context first.


See Also:   NamespaceSupport.pushContext



processName
public String[] processName(String qName, String parts, boolean isAttribute)(Code)
Process a raw XML 1.0 name.

This method processes a raw XML 1.0 name in the current context by removing the prefix and looking it up among the prefixes currently declared. The return value will be the array supplied by the caller, filled in as follows:

parts[0]
The Namespace URI, or an empty string if none is in use.
parts[1]
The local name (without prefix).
parts[2]
The original raw name.

All of the strings in the array will be internalized. If the raw name has a prefix that has not been declared, then the return value will be null.

Note that attribute names are processed differently than element names: an unprefixed element name will received the default Namespace (if any), while an unprefixed element name will not.


Parameters:
  qName - The raw XML 1.0 name to be processed.
Parameters:
  parts - An array supplied by the caller, capable ofholding at least three members.
Parameters:
  isAttribute - A flag indicating whether this is anattribute name (true) or an element name (false). The supplied array holding three internalized stringsrepresenting the Namespace URI (or empty string), thelocal name, and the raw XML 1.0 name; or null if thereis an undeclared prefix.
See Also:   NamespaceSupport.declarePrefix
See Also:   java.lang.String.intern
See Also:   



pushContext
public void pushContext()(Code)
Start a new Namespace context.

Normally, you should push a new context at the beginning of each XML element: the new context will automatically inherit the declarations of its parent context, but it will also keep track of which declarations were made within this context.

The Namespace support object always starts with a base context already in force: in this context, only the "xml" prefix is declared.


See Also:   NamespaceSupport.popContext



reset
public void reset()(Code)
Reset this Namespace support object for reuse.

It is necessary to invoke this method before reusing the Namespace support object for a new session.




slideContextDown
public void slideContextDown()(Code)



slideContextUp
public void slideContextUp()(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.