|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.persistence.oxm.NamespaceResolver
public class NamespaceResolver
It is common for an XML document to include one or more namespaces. TopLink supports this using its NamespaceResolver. The namespace resolver maintains pairs of namespace prefixes and URIs. TopLink uses these prefixes in conjunction with the XPath statements you specify on EIS mappings to XML records and XML mappings.
Although TopLink captures namespace prefixes in the XPath statements for mappings (if applicable), the input document is not required to use the same namespace prefixes. TopLink will use the namespace prefixes specified in the mapping when creating new documents.
Code Sample
NamespaceResolver resolver = new NamespaceResolver();
resolver.put( "ns", "urn:namespace-example");
XMLDescriptor descriptor = new XMLDescriptor();
descriptor.setJavaClass(Customer.class);
descriptor.setDefaultRootElement("ns:customer");
descriptor.setNamespaceResolver(resolver);
XMLDirectMapping mapping = new XMLDirectMapping();
mapping.setAttributeName("id");
mapping.setXPath("ns:id/text()");
descriptor.addMapping(mapping);
XMLDescriptor
,
EISDescriptor
Constructor Summary | |
---|---|
NamespaceResolver()
Default constructor, creates a new NamespaceResolver. |
Method Summary | |
---|---|
java.lang.String |
generatePrefix()
|
java.lang.String |
generatePrefix(java.lang.String defaultPrefix)
|
java.lang.String |
getDefaultNamespaceURI()
|
java.util.Vector |
getNamespaces()
INTERNAL: Returns a Vector of of Namespace objects in the current Namespace Resolver Used for deployment XML |
java.util.Enumeration |
getPrefixes()
Returns the list of prefixes in the NamespaceResolver |
java.util.Map<java.lang.String,java.lang.String> |
getPrefixesToNamespaces()
|
void |
put(java.lang.String prefix,
java.lang.String namespaceURI)
Adds a namespace to the collection of namespaces on the NamespaceResolver |
void |
removeNamespace(java.lang.String prefix)
|
java.lang.String |
resolveNamespacePrefix(java.lang.String prefix)
Returns the namespace URI associated with a specified namespace prefix |
java.lang.String |
resolveNamespaceURI(java.lang.String uri)
Return the namespace prefix associated with a namespace URI. |
void |
setDefaultNamespaceURI(java.lang.String namespaceUri)
|
void |
setDOM(org.w3c.dom.Node dom)
|
void |
setNamespaces(java.util.Vector names)
INTERNAL: Set the namespaces on the namespace resolver based on the specified Vector of Namespace objects Used for deployment XML |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NamespaceResolver()
Method Detail |
---|
public java.util.Map<java.lang.String,java.lang.String> getPrefixesToNamespaces()
public void setDOM(org.w3c.dom.Node dom)
public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
resolveNamespacePrefix
in interface XMLNamespaceResolver
prefix
- The prefix to lookup a namespace URI for
public java.lang.String resolveNamespaceURI(java.lang.String uri)
uri
- A namespace URI.
public void put(java.lang.String prefix, java.lang.String namespaceURI)
prefix
- The prefix for a namespacenamespaceURI
- The namespace URI associated with the specified prefixpublic java.util.Enumeration getPrefixes()
public java.util.Vector getNamespaces()
public void setNamespaces(java.util.Vector names)
names
- A Vector of namespace URIspublic java.lang.String generatePrefix()
public java.lang.String generatePrefix(java.lang.String defaultPrefix)
public void removeNamespace(java.lang.String prefix)
public void setDefaultNamespaceURI(java.lang.String namespaceUri)
public java.lang.String getDefaultNamespaceURI()
|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |