org.eclipse.persistence.oxm.record

Class ContentHandlerRecord

java.lang.Object

org.eclipse.persistence.internal.core.sessions.CoreAbstractRecord

org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl<CoreAbstractSession,CoreField,MARSHALLER,NamespaceResolver>

org.eclipse.persistence.oxm.record.MarshalRecord

org.eclipse.persistence.oxm.record.ContentHandlerRecord

All Implemented Interfaces:

AbstractMarshalRecord, MarshalRecord, XMLRecord

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord

MarshalRecord.CycleDetectionStack<E>

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

XMLRecord.Nil

Field Summary

Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

DEFAULT_ATTRIBUTE_GROUP, NIL

Constructor Summary

Constructors

Constructor and Description
ContentHandlerRecord()

Method Summary

Modifier and Type	Method and Description
void	attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value) INTERNAL:
void	attribute(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(XPathFragment frag) INTERNAL:
void	endDocument() INTERNAL:
void	endElement(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	namespaceDeclarations(NamespaceResolver namespaceResolver) INTERNAL: Add the namespace declarations to the XML document.
void	node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver, java.lang.String uri, java.lang.String name) Receive notification of a node.
void	openStartElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
java.lang.String	resolveNamespacePrefix(java.lang.String s)
java.lang.String	resolveNamespacePrefix(XPathFragment frag, NamespaceResolver resolver)
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 receive 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:
void	startPrefixMappings(NamespaceResolver namespaceResolver)

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

add, addGroupingElement, afterContainmentMarshal, attribute, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, defaultNamespaceDeclaration, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endCollection, endPrefixMappings, flush, forceValueWrapper, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNamespaceURI, getPositionalNodes, getTextWrapperFragment, getValueToWrite, isWrapperAsCollectionName, marshalWithoutRootElement, namespaceDeclaration, nilComplex, nilSimple, node, openStartGroupingElements, popAttributeGroup, predicateAttribute, pushAttributeGroup, put, removeGroupingElement, setGroupingElement, setSession, startCollection, transformToXML, writeHeader

Methods inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl

addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, attributeWithoutQName, getConversionManager, getLeafElementType, getMarshaller, getNamespaceResolver, getNamespaceSeparator, getOwningObject, getSession, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord

attributeWithoutQName, hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType, setMarshaller

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord

addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, hasEqualNamespaceResolvers, isNamespaceAware, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

getConversionManager, getNamespaceSeparator, getSession

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 receive 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

startPrefixMappings

public void startPrefixMappings(NamespaceResolver namespaceResolver)

Overrides:

startPrefixMappings in class MarshalRecord

startPrefixMapping

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

INTERNAL:

Specified by:

startPrefixMapping in interface MarshalRecord

Overrides:

startPrefixMapping in class MarshalRecord

Parameters:

prefix - The namespace prefix.

namespaceURI - The namespace URI.

namespaceDeclarations

public void namespaceDeclarations(NamespaceResolver namespaceResolver)

INTERNAL: Add the namespace declarations to the XML document.

Overrides:

namespaceDeclarations in class MarshalRecord

Parameters:

namespaceResolver - The NamespaceResolver contains the namespace prefix and URI pairings that need to be declared.

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

INTERNAL:

Specified by:

endPrefixMapping in interface MarshalRecord

Overrides:

endPrefixMapping in class MarshalRecord

Parameters:

prefix - The namespace prefix.

openStartElement

public void openStartElement(XPathFragment xPathFragment,
                             NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

openStartElement in interface MarshalRecord

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(XPathFragment frag)

INTERNAL:

Specified by:

element in class MarshalRecord

Parameters:

frag - The XPathFragment of the element

attribute

public void attribute(XPathFragment xPathFragment,
                      NamespaceResolver namespaceResolver,
                      java.lang.String value)

INTERNAL:

Specified by:

attribute in interface MarshalRecord

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 interface AbstractMarshalRecord

Specified by:

attribute in interface MarshalRecord

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 interface MarshalRecord

Specified by:

closeStartElement in class MarshalRecord

endElement

public void endElement(XPathFragment xPathFragment,
                       NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

endElement in interface MarshalRecord

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 interface MarshalRecord

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 interface MarshalRecord

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,
                 java.lang.String uri,
                 java.lang.String name)

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

uri - replacement root name for the node

name - replacement root namespace for the node namespace URI/prefix of the node

resolveNamespacePrefix

public java.lang.String resolveNamespacePrefix(XPathFragment frag,
                                               NamespaceResolver resolver)

resolveNamespacePrefix

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

Specified by:

resolveNamespacePrefix in interface AbstractMarshalRecord

Overrides:

resolveNamespacePrefix in class AbstractMarshalRecordImpl