org.eclipse.persistence.oxm.record
Class ContentHandlerRecord

java.lang.Object
  org.eclipse.persistence.internal.sessions.AbstractRecord
      org.eclipse.persistence.oxm.record.XMLRecord
          org.eclipse.persistence.oxm.record.MarshalRecord
              org.eclipse.persistence.oxm.record.ContentHandlerRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, Record

public class ContentHandlerRecord
extends MarshalRecord

Use this type of MarshalRecord when the marshal target is a ContentHandler.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
ContentHandlerRecord contentHandlerRecord = new ContentHandlerRecord();
marshalRecord.setContentHandler(myContentHandler);
xmlMarshaller.marshal(myObject, contentHandlerRecord);


If the marshal(ContentHandler) method is called on XMLMarshaller, then the ContentHanlder is automatically wrapped in a ContentHandlerRecord.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller.marshal(myObject, contentHandler);


See Also:

XMLMarshaller, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

org.eclipse.persistence.internal.sessions.AbstractRecord.EntrySet, org.eclipse.persistence.internal.sessions.AbstractRecord.KeySet, org.eclipse.persistence.internal.sessions.AbstractRecord.NoEntry, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordEntry, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordEntryIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordKeyIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordValuesIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.ValuesSet

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

protected boolean

isStartElementOpen

Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord

session

Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

fields, lookupField, noEntry, size, values

Constructor Summary

ContentHandlerRecord()

Method Summary

void	attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value) INTERNAL:
void	attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver, java.lang.String value) INTERNAL:
void	cdata(java.lang.String value) INTERNAL:
void	characters(java.lang.String value) INTERNAL:
void	closeStartElement() INTERNAL:
void	element(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) INTERNAL:
void	endDocument() INTERNAL:
void	endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
void	endPrefixMapping(java.lang.String prefix) INTERNAL:
org.xml.sax.ContentHandler	getContentHandler() Return the ContentHandler that the object will be marshalled to.
void	node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver) Receive notification of a node.
void	openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
java.lang.String	resolveNamespacePrefix(java.lang.String s)
java.lang.String	resolveNamespacePrefix(org.eclipse.persistence.internal.oxm.XPathFragment frag, NamespaceResolver resolver) INTERNAL: Return the namespace URI associated with the prefix held onto by the XPathFragment.
void	setContentHandler(org.xml.sax.ContentHandler contentHandler) Set the ContentHandler that the object will be marshalled to.
void	setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler) Set the LexicalHandler to recieve CDATA related events
void	startDocument(java.lang.String encoding, java.lang.String version) INTERNAL:
void	startPrefixMapping(java.lang.String prefix, java.lang.String namespaceURI) INTERNAL:

Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord

add, addGroupingElement, addPositionalNodes, clear, closeStartGroupingElements, endPrefixMappings, getDocument, getDOM, getLocalName, getNamespaceURI, getPositionalNodes, namespaceDeclarations, openStartGroupingElements, put, removeGroupingElement, startPrefixMappings, transformToXML

Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord

contains, convertToXMLField, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller

Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, get, getField, getFields, getIndicatingNoEntry, getValues, getValues, getValues, isEmpty, keys, keySet, mergeFrom, put, put, putAll, remove, remove, remove, replaceAt, resetSize, setFields, setValues, size, toString, values

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

isStartElementOpen

protected boolean isStartElementOpen

Constructor Detail

ContentHandlerRecord

public ContentHandlerRecord()

Method Detail

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()

Return the ContentHandler that the object will be marshalled to.

Returns:

The marshal target.

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)

Set the ContentHandler that the object will be marshalled to.

Parameters:

contentHandler - The marshal target.

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)

Set the LexicalHandler to recieve CDATA related events

startDocument

public void startDocument(java.lang.String encoding,
                          java.lang.String version)

INTERNAL:

Specified by:

startDocument in class MarshalRecord

Parameters:

encoding - The XML document will be encoded using this encoding.

version - This specifies the version of XML.

endDocument

public void endDocument()

INTERNAL:

Specified by:

endDocument in class MarshalRecord

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String namespaceURI)

INTERNAL:

Overrides:

startPrefixMapping in class MarshalRecord

Parameters:

prefix - The namespace prefix.

namespaceURI - The namespace URI.

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

INTERNAL:

Overrides:

endPrefixMapping in class MarshalRecord

Parameters:

prefix - The namespace prefix.

openStartElement

public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                             NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

openStartElement in class MarshalRecord

Parameters:

xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

element

public void element(java.lang.String namespaceURI,
                    java.lang.String localName,
                    java.lang.String qName)

INTERNAL:

Specified by:

element in class MarshalRecord

Parameters:

namespaceURI - The namespace URI, if the element is not namespace qualified the value of this parameter wil be null.

localName - The local name of the element.

attribute

public void attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                      NamespaceResolver namespaceResolver,
                      java.lang.String value)

INTERNAL:

Specified by:

attribute in class MarshalRecord

Parameters:

xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

value - This is the complete value for the attribute.

attribute

public void attribute(java.lang.String namespaceURI,
                      java.lang.String localName,
                      java.lang.String qName,
                      java.lang.String value)

INTERNAL:

Specified by:

attribute in class MarshalRecord

Parameters:

namespaceURI - The namespace URI, if the attribute is not namespace qualified the value of this parameter wil be null.

localName - The local name of the attribute.

qName - The qualified name of the attribute.

value - This is the complete value for the attribute.

closeStartElement

public void closeStartElement()

INTERNAL:

Specified by:

closeStartElement in class MarshalRecord

endElement

public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                       NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

endElement in class MarshalRecord

Parameters:

xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

characters

public void characters(java.lang.String value)

INTERNAL:

Specified by:

characters in class MarshalRecord

Parameters:

value - This is the entire value of the text node.

cdata

public void cdata(java.lang.String value)

INTERNAL:

Specified by:

cdata in class MarshalRecord

Parameters:

value - This is the value of the text to be wrapped

node

public void node(org.w3c.dom.Node node,
                 NamespaceResolver namespaceResolver)

Receive notification of a node.

Specified by:

node in class MarshalRecord

Parameters:

node - The Node to be added to the document

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI/prefix of the node

resolveNamespacePrefix

public java.lang.String resolveNamespacePrefix(org.eclipse.persistence.internal.oxm.XPathFragment frag,
                                               NamespaceResolver resolver)

Description copied from class: MarshalRecord

INTERNAL: Return the namespace URI associated with the prefix held onto by the XPathFragment.

Overrides:

resolveNamespacePrefix in class MarshalRecord

Parameters:

frag - The XPathFragment contains the name and prefix information about the XML element being ended.

resolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).

Returns:

A namespace URI.

resolveNamespacePrefix

public java.lang.String resolveNamespacePrefix(java.lang.String s)

Overrides:

resolveNamespacePrefix in class XMLRecord