|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XMLStreamHelper
Helper interface for reading and writing SDO DataObjects from XML streams (StAX).
Field Summary | |
---|---|
static String |
OPTION_DEFAULT_ROOT_TYPE
Default Type to load DataObject if the element is unqualified/local without xsi:type or the qualified/global element or xsi:type fail to resolve. |
Method Summary | |
---|---|
javax.xml.stream.XMLStreamReader |
createXMLStreamReader(DataObject sdo)
Creates and returns a XMLStreamReader that can be used to read a DataObject as a XML event stream. |
javax.xml.stream.XMLStreamReader |
createXMLStreamReader(XMLDocument document)
Creates and returns a XMLStreamReader that can be used to read an XMLDocument as a XML event stream. |
HelperContext |
getHelperContext()
|
XMLDocument |
load(javax.xml.stream.XMLStreamReader reader)
Creates and returns an XMLDocument from an XML input stream. |
DataObject |
loadObject(javax.xml.stream.XMLStreamReader reader)
Create a DataObject from an element in a XML stream. |
DataObject |
loadObject(javax.xml.stream.XMLStreamReader reader,
Map options)
Create a DataObject from an element in a XML stream. |
void |
save(XMLDocument document,
javax.xml.stream.XMLStreamWriter writer)
Save a XMLDocument to an XML stream. |
void |
save(XMLDocument document,
javax.xml.stream.XMLStreamWriter writer,
Map options)
|
void |
saveObject(DataObject sdo,
javax.xml.stream.XMLStreamWriter writer)
Save a DataObject to an XML stream. |
void |
saveObject(DataObject sdo,
javax.xml.stream.XMLStreamWriter writer,
Map options)
|
Field Detail |
---|
static final String OPTION_DEFAULT_ROOT_TYPE
Method Detail |
---|
XMLDocument load(javax.xml.stream.XMLStreamReader reader) throws javax.xml.stream.XMLStreamException, IllegalStateException
reader
- the stream to read
javax.xml.stream.XMLStreamException
- if there was a problem reading the stream
IllegalStateException
- if the reader is not positioned on a
START_DOCUMENT eventvoid save(XMLDocument document, javax.xml.stream.XMLStreamWriter writer) throws javax.xml.stream.XMLStreamException
document
- the document to be writtenwriter
- the stream to write to
javax.xml.stream.XMLStreamException
- if there was a problem writing to the streamvoid save(XMLDocument document, javax.xml.stream.XMLStreamWriter writer, Map options) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamReader createXMLStreamReader(XMLDocument document) throws javax.xml.stream.XMLStreamException
document
- the XMLDocument to be read
javax.xml.stream.XMLStreamException
DataObject loadObject(javax.xml.stream.XMLStreamReader reader) throws javax.xml.stream.XMLStreamException, IllegalStateException
reader
- the stream to read
javax.xml.stream.XMLStreamException
- if there was a problem reading the stream
IllegalStateException
- if the reader is not positioned on a
START_ELEMENT eventDataObject loadObject(javax.xml.stream.XMLStreamReader reader, Map options) throws javax.xml.stream.XMLStreamException, IllegalStateException
reader
- the stream to readoptions
- OPTION_DEFAULT_ROOT_TYPE
; can be null or empty
javax.xml.stream.XMLStreamException
- if there was a problem reading the stream
IllegalStateException
- if the reader is not positioned on a
START_ELEMENT eventvoid saveObject(DataObject sdo, javax.xml.stream.XMLStreamWriter writer) throws javax.xml.stream.XMLStreamException
sdo
- the DataObject to be writtenwriter
- the stream to write to
javax.xml.stream.XMLStreamException
- if there was a problem writing to the streamvoid saveObject(DataObject sdo, javax.xml.stream.XMLStreamWriter writer, Map options) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamReader createXMLStreamReader(DataObject sdo)
sdo
- the DataObject to be read
HelperContext getHelperContext()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |