oracle.toplink.xml.stream
Class XMLStreamAccessor

java.lang.Object
oracle.toplink.sdk.SDKAccessor
oracle.toplink.xml.stream.XMLStreamAccessor

All Implemented Interfaces:

oracle.toplink.internal.databaseaccess.Accessor, java.lang.Cloneable, XMLAccessor

public class XMLStreamAccessor

extends SDKAccessor

implements XMLAccessor

Constructor Summary

XMLStreamAccessor()

Method Summary

DatabaseRow	convert(DatabaseRow row, oracle.toplink.publicinterface.Session session) Everything in XML must be strings.
void	createStreamSource(java.lang.String rootElementName) Create a source for data streams for the XML documents with the specified root element name.
java.lang.Integer	deleteStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) Delete the data for the specified root element and primary key.
void	dropStreamSource(java.lang.String rootElementName) Drop the source for data streams for the XML documents with the specified root element name.
java.io.Reader	getExistenceCheckStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) If it exists, return a read stream on the data for the specified root element and primary key.
java.io.Writer	getExistingWriteStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) Return a write stream that will overwrite the data for the specified root element and primary key.
java.io.Writer	getNewWriteStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) Return a new write stream for the specified root element and primary key.
java.io.Reader	getReadStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) Return a read stream on the data for the specified root element and primary key.
java.util.Enumeration	getReadStreams(java.lang.String rootElementName) Return an enumeration on a collection of read streams, one for *every* document with the specified root element.
java.util.Enumeration	getReadStreams(java.lang.String rootElementName, java.util.Vector foreignKeys, java.util.Vector orderedForeignKeyElements) Return an enumeration on a collection of streams, one for every specified foreign key.
XMLTranslator	getXMLTranslator() Return the default XML translator for all data store calls.
void	setXMLStreamDatabase(XMLStreamDatabase newXMLStreamDatabase)
void	setXMLTranslator(XMLTranslator translator) Set the default XML translator for all data store calls.

Methods inherited from class oracle.toplink.sdk.SDKAccessor

afterJTSTransaction, beginTransaction, clone, closeConnection, commitTransaction, connect, decrementCallCount, disconnect, executeCall, flushSelectCalls, getCallCount, getColumnInfo, getConnection, getTableInfo, incrementCallCount, isConnected, logMessage, reestablishConnection, rollbackTransaction, toString, usesExternalTransactionController

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStreamAccessor

public XMLStreamAccessor()

Method Detail

setXMLStreamDatabase

public void setXMLStreamDatabase(XMLStreamDatabase newXMLStreamDatabase)

convert

public DatabaseRow convert(DatabaseRow row,
                           oracle.toplink.publicinterface.Session session)

Everything in XML must be strings.

Specified by:

convert in interface XMLAccessor

createStreamSource

public void createStreamSource(java.lang.String rootElementName)
                        throws XMLDataStoreException

Create a source for data streams for the XML documents with the specified root element name.

Specified by:

createStreamSource in interface XMLAccessor

Throws:

XMLDataStoreException

deleteStream

public java.lang.Integer deleteStream(java.lang.String rootElementName,
                                      DatabaseRow row,
                                      java.util.Vector orderedPrimaryKeyElements)
                               throws XMLDataStoreException

Delete the data for the specified root element and primary key. Return the stream count (1 or 0).

Specified by:

deleteStream in interface XMLAccessor

Throws:

XMLDataStoreException

dropStreamSource

public void dropStreamSource(java.lang.String rootElementName)
                      throws XMLDataStoreException

Drop the source for data streams for the XML documents with the specified root element name.

Specified by:

dropStreamSource in interface XMLAccessor

Throws:

XMLDataStoreException

getExistenceCheckStream

public java.io.Reader getExistenceCheckStream(java.lang.String rootElementName,
                                              DatabaseRow row,
                                              java.util.Vector orderedPrimaryKeyElements)
                                       throws XMLDataStoreException

If it exists, return a read stream on the data for the specified root element and primary key. If it does not exist, return null.

Specified by:

getExistenceCheckStream in interface XMLAccessor

Throws:

XMLDataStoreException

getExistingWriteStream

public java.io.Writer getExistingWriteStream(java.lang.String rootElementName,
                                             DatabaseRow row,
                                             java.util.Vector orderedPrimaryKeyElements)
                                      throws XMLDataStoreException

Return a write stream that will overwrite the data for the specified root element and primary key.

Specified by:

getExistingWriteStream in interface XMLAccessor

Throws:

XMLDataStoreException

getNewWriteStream

public java.io.Writer getNewWriteStream(java.lang.String rootElementName,
                                        DatabaseRow row,
                                        java.util.Vector orderedPrimaryKeyElements)
                                 throws XMLDataStoreException

Return a new write stream for the specified root element and primary key.

Specified by:

getNewWriteStream in interface XMLAccessor

Throws:

XMLDataStoreException

getReadStream

public java.io.Reader getReadStream(java.lang.String rootElementName,
                                    DatabaseRow row,
                                    java.util.Vector orderedPrimaryKeyElements)
                             throws XMLDataStoreException

Return a read stream on the data for the specified root element and primary key. If the stream is not found return null.

Specified by:

getReadStream in interface XMLAccessor

Throws:

XMLDataStoreException

getReadStreams

public java.util.Enumeration getReadStreams(java.lang.String rootElementName)
                                     throws XMLDataStoreException

Return an enumeration on a collection of read streams, one for *every* document with the specified root element.

Specified by:

getReadStreams in interface XMLAccessor

Throws:

XMLDataStoreException

getReadStreams

public java.util.Enumeration getReadStreams(java.lang.String rootElementName,
                                            java.util.Vector foreignKeys,
                                            java.util.Vector orderedForeignKeyElements)
                                     throws XMLDataStoreException

Return an enumeration on a collection of streams, one for every specified foreign key. If a particular stream is not found the enumeration will return null in its place.

Specified by:

getReadStreams in interface XMLAccessor

Throws:

XMLDataStoreException

getXMLTranslator

public XMLTranslator getXMLTranslator()

Return the default XML translator for all data store calls.

Specified by:

getXMLTranslator in interface XMLAccessor

setXMLTranslator

public void setXMLTranslator(XMLTranslator translator)

Set the default XML translator for all data store calls.

Specified by:

setXMLTranslator in interface XMLAccessor