oracle.toplink.xml
Class XMLAccessorStreamPolicy

java.lang.Object
  |
  +--oracle.toplink.xml.XMLAccessorStreamPolicy

All Implemented Interfaces:

java.io.Serializable, XMLStreamPolicy

public class XMLAccessorStreamPolicy

extends java.lang.Object

implements XMLStreamPolicy

This implementation of the XMLStreamPolicy interface simply forwards any message to the accessor, which is assumed to be an XMLAccessor.

Since:

TOPLink/Java 3.0

See Also:

XMLCall, XMLAccessor, XMLFileAccessor, Serialized Form

Constructor Summary

XMLAccessorStreamPolicy()
Default constructor.

Method Summary

Type	Method
java.lang.Integer	deleteStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements, oracle.toplink.internal.databaseaccess.Accessor accessor) Delete the data for the specified root element and primary key.
java.io.Reader	getExistenceCheckStream(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements, oracle.toplink.internal.databaseaccess.Accessor accessor) 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, oracle.toplink.internal.databaseaccess.Accessor accessor) 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, oracle.toplink.internal.databaseaccess.Accessor accessor) 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, oracle.toplink.internal.databaseaccess.Accessor accessor) Return a read stream on the data for the specified root element and primary key.
java.util.Enumeration	getReadStreams(java.lang.String rootElementName, oracle.toplink.internal.databaseaccess.Accessor accessor) 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, oracle.toplink.internal.databaseaccess.Accessor accessor) Return an enumeration on a collection of streams, one for every specified foreign key.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLAccessorStreamPolicy

public XMLAccessorStreamPolicy()

Default constructor.

Method Detail

deleteStream

public java.lang.Integer deleteStream(java.lang.String rootElementName,
                                      DatabaseRow row,
                                      java.util.Vector orderedPrimaryKeyElements,
                                      oracle.toplink.internal.databaseaccess.Accessor accessor)
                               throws XMLDataStoreException

Delete the data for the specified root element and primary key. Return the stream count (1 or 0). Simply forward the message to the accessor.

Specified by:

deleteStream in interface XMLStreamPolicy

getExistenceCheckStream

public java.io.Reader getExistenceCheckStream(java.lang.String rootElementName,
                                              DatabaseRow row,
                                              java.util.Vector orderedPrimaryKeyElements,
                                              oracle.toplink.internal.databaseaccess.Accessor accessor)
                                       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. Simply forward the message to the accessor.

Specified by:

getExistenceCheckStream in interface XMLStreamPolicy

getExistingWriteStream

public java.io.Writer getExistingWriteStream(java.lang.String rootElementName,
                                             DatabaseRow row,
                                             java.util.Vector orderedPrimaryKeyElements,
                                             oracle.toplink.internal.databaseaccess.Accessor accessor)
                                      throws XMLDataStoreException

Return a write stream that will overwrite the data for the specified root element and primary key. Simply forward the message to the accessor.

Specified by:

getExistingWriteStream in interface XMLStreamPolicy

getNewWriteStream

public java.io.Writer getNewWriteStream(java.lang.String rootElementName,
                                        DatabaseRow row,
                                        java.util.Vector orderedPrimaryKeyElements,
                                        oracle.toplink.internal.databaseaccess.Accessor accessor)
                                 throws XMLDataStoreException

Return a new write stream for the specified root element and primary key. Simply forward the message to the accessor.

Specified by:

getNewWriteStream in interface XMLStreamPolicy

getReadStream

public java.io.Reader getReadStream(java.lang.String rootElementName,
                                    DatabaseRow row,
                                    java.util.Vector orderedPrimaryKeyElements,
                                    oracle.toplink.internal.databaseaccess.Accessor accessor)
                             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. Simply forward the message to the accessor.

Specified by:

getReadStream in interface XMLStreamPolicy

getReadStreams

public java.util.Enumeration getReadStreams(java.lang.String rootElementName,
                                            java.util.Vector foreignKeys,
                                            java.util.Vector orderedForeignKeyElements,
                                            oracle.toplink.internal.databaseaccess.Accessor accessor)
                                     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. Simply forward the message to the accessor.

Specified by:

getReadStreams in interface XMLStreamPolicy

getReadStreams

public java.util.Enumeration getReadStreams(java.lang.String rootElementName,
                                            oracle.toplink.internal.databaseaccess.Accessor accessor)
                                     throws XMLDataStoreException

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

Specified by:

getReadStreams in interface XMLStreamPolicy

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object