oracle.toplink.xml
Interface XMLStreamPolicy

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

XMLAccessorStreamPolicy, XMLFileStreamPolicy, XMLStreamStreamPolicy, XMLZipFileStreamPolicy

public interface XMLStreamPolicy

extends java.io.Serializable

This interface defines methods needed for stream handling in the XML environment.

Since:

TOPLink/Java 3.0

See Also:

XMLAccessor, XMLFileAccessor

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.

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).

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.

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.

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.

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.

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.

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.

Throws:

XMLDataStoreException