oracle.toplink.xml
Class XMLStreamStreamPolicy

java.lang.Object
oracle.toplink.xml.XMLStreamStreamPolicy

All Implemented Interfaces:

java.io.Serializable, XMLStreamPolicy

public class XMLStreamStreamPolicy

extends java.lang.Object

implements XMLStreamPolicy

This implementation of the XMLStreamPolicy interface simply returns the supplied stream (or streams).

Since:

TopLink 4.0

See Also:

XMLCall, XMLAccessor, XMLFileAccessor, Serialized Form

Constructor Summary

XMLStreamStreamPolicy(java.util.Enumeration readers)
Construct a policy for the specified read streams.

XMLStreamStreamPolicy(java.io.Reader reader)
Construct a policy for the specified read stream.

XMLStreamStreamPolicy(java.io.Writer writer)
Construct a policy for the specified write stream.

Method Summary

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

XMLStreamStreamPolicy

public XMLStreamStreamPolicy(java.io.Reader reader)

Construct a policy for the specified read stream.

XMLStreamStreamPolicy

public XMLStreamStreamPolicy(java.io.Writer writer)

Construct a policy for the specified write stream.

XMLStreamStreamPolicy

public XMLStreamStreamPolicy(java.util.Enumeration readers)

Construct a policy for the specified read streams.

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). Do nothing - subclasses might want to override....

Specified by:

deleteStream in interface XMLStreamPolicy

Throws:

XMLDataStoreException

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.

Specified by:

getExistenceCheckStream in interface XMLStreamPolicy

Throws:

XMLDataStoreException

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.

Specified by:

getExistingWriteStream in interface XMLStreamPolicy

Throws:

XMLDataStoreException

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.

Specified by:

getNewWriteStream in interface XMLStreamPolicy

Throws:

XMLDataStoreException

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.

Specified by:

getReadStream in interface XMLStreamPolicy

Throws:

XMLDataStoreException

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.

Specified by:

getReadStreams in interface XMLStreamPolicy

Throws:

XMLDataStoreException

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.

Specified by:

getReadStreams in interface XMLStreamPolicy

Throws:

XMLDataStoreException

toString

public java.lang.String toString()