EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.oxm.record
Class XMLRootRecord

java.lang.Object
  extended by org.eclipse.persistence.internal.sessions.AbstractRecord
      extended by org.eclipse.persistence.oxm.record.XMLRecord
          extended by org.eclipse.persistence.oxm.record.UnmarshalRecord
              extended by org.eclipse.persistence.oxm.record.XMLRootRecord
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, org.eclipse.persistence.internal.oxm.record.ExtendedContentHandler, Record, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

public class XMLRootRecord
extends UnmarshalRecord

Record for handling simple root elements that have a single text child node, and are being unmarshalled to a primitive wrapper object. The characters method will be used to gather the text to be converted.

See Also:
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
 
Fields inherited from class org.eclipse.persistence.oxm.record.UnmarshalRecord
childRecordPool, DEFAULT_UNMAPPED_CONTENT_HANDLER, parentRecord, rootElementLocalName, rootElementName, rootElementNamespaceUri, xmlReader
 
Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord
currentObject, marshaller, NIL, session, unmarshaller
 
Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord
fields, lookupField, noEntry, nullValueInFields, size, values
 
Constructor Summary
XMLRootRecord(java.lang.Class cls)
          Default constructor.
 
Method Summary
 void characters(char[] ch, int start, int length)
           
 void endDocument()
           
 void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
           
 java.lang.Object getCurrentObject()
          Return a populated XMLRoot object.
 void initializeRecord(XMLMapping selfRecordMapping)
           
 void startDocument()
           
 void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
           
 
Methods inherited from class org.eclipse.persistence.oxm.record.UnmarshalRecord
addAttributeValue, addAttributeValue, characters, clear, comment, endCDATA, endDTD, endEntity, endPrefixMapping, endUnmappedElement, get, getAttributeChildNodeValue, getAttributes, getCharacters, getChildRecord, getChildUnmarshalRecord, getContainerInstance, getDescriptor, getDocument, getDOM, getEncoding, getFragmentBuilder, getLevelIndex, getLocalName, getNamespaceURI, getNoNamespaceSchemaLocation, getNonAttributeXPathNode, getNullCapableValues, getParentRecord, getPrefixesForFragment, getRootElementName, getRootElementNamespaceUri, getSchemaLocation, getSelfNodeValueForAttribute, getStringBuffer, getTransformationRecord, getTypeQName, getUnmarshalContext, getUnmarshalNamespaceResolver, getVersion, getXMLReader, getXPathNode, ignorableWhitespace, initialize, isBufferCDATA, isNil, isSelfRecord, processingInstruction, reference, removeNullCapableValue, resetStringBuffer, resolveNamespacePrefix, resolveNamespaceUri, setAttributes, setAttributeValue, setChildRecord, setDocumentLocator, setEncoding, setFragmentBuilder, setLocalName, setNil, setNoNamespaceSchemaLocation, setParentRecord, setRootElementName, setRootElementNamespaceUri, setSchemaLocation, setSelfRecord, setTransformationRecord, setTypeQName, setUnmarshalContext, setUnmarshalNamespaceResolver, setVersion, setXMLReader, skippedEntity, startCDATA, startDTD, startEntity, startPrefixMapping, startUnmappedElement, toString, transformToXML, unmappedContent
 
Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord
contains, convertToXMLField, convertToXMLField, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, isXOPPackage, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller, setXOPPackage
 
Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord
add, clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, get, getField, getFields, getIndicatingNoEntry, getLookupField, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, put, put, putAll, remove, remove, remove, replaceAt, resetSize, setFields, setNullValueInFields, setValues, size, 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
 

Constructor Detail

XMLRootRecord

public XMLRootRecord(java.lang.Class cls)
Default constructor.

Method Detail

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
Specified by:
characters in interface org.xml.sax.ContentHandler
Overrides:
characters in class UnmarshalRecord
Throws:
org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class UnmarshalRecord
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class UnmarshalRecord
Throws:
org.xml.sax.SAXException

getCurrentObject

public java.lang.Object getCurrentObject()
Return a populated XMLRoot object.

Overrides:
getCurrentObject in class XMLRecord

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class UnmarshalRecord
Throws:
org.xml.sax.SAXException

initializeRecord

public void initializeRecord(XMLMapping selfRecordMapping)
                      throws org.xml.sax.SAXException
Overrides:
initializeRecord in class UnmarshalRecord
Throws:
org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException
Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class UnmarshalRecord
Throws:
org.xml.sax.SAXException

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference