oracle.toplink.xml
Interface XMLFileAccessorFilePolicy

All Known Implementing Classes:

DefaultXMLFileAccessorFilePolicy

public interface XMLFileAccessorFilePolicy

This policy is used by XMLFileAccessor to build the files that will be wrapped in XML streams.

Since:

TOPLink/Java 4.5

Method Summary

void	createFileSource(java.lang.String rootElementName) If necessary, create the source that holds all the files for the XML documents with the specified root element name.
void	dropFileSource(java.lang.String rootElementName) If necessary, drop the source that holds all the files for the XML documents with the specified root element name.
java.util.Enumeration	getAllFiles(java.lang.String rootElementName) Return an enumeration on a every file for the specified root element name.
java.io.File	getFile(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) Return a file for the specified root element name and primary key.
void	validateConfiguration() The accessor is connecting; if necessary, validate the policy's settings.

Method Detail

createFileSource

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

If necessary, create the source that holds all the files for the XML documents with the specified root element name.

Throws:

XMLDataStoreException

dropFileSource

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

If necessary, drop the source that holds all the files for the XML documents with the specified root element name.

Throws:

XMLDataStoreException

getAllFiles

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

Return an enumeration on a every file for the specified root element name.

Throws:

XMLDataStoreException

getFile

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

Return a file for the specified root element name and primary key. The name of this file will typically take the form of [base dir]/[root element]/[key].xml

Throws:

XMLDataStoreException

validateConfiguration

public void validateConfiguration()
                           throws XMLDataStoreException

The accessor is connecting; if necessary, validate the policy's settings.

Throws:

XMLDataStoreException