|
Oracle Application Server TopLink API Reference 10g Release 2 (10.1.2) B15903-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.toplink.xml.DefaultXMLFileAccessorFilePolicy
Default implementation of accessor file policy.
XMLFileAccessor
Field Summary | |
static java.lang.String |
DEFAULT_FILE_NAME_EXTENSION |
Constructor Summary | |
DefaultXMLFileAccessorFilePolicy() Default constructor. |
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. |
boolean |
createsDirectoriesAsNeeded() Return whether the policy will create directories as needed, if they do not exist already. |
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 |
getBaseDirectory() All the XML documents are stored in subdirectories under this base directory. |
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. |
java.lang.String |
getFileNameExtension() Return the standard file name extension that will be appended to the primary key element value(s) to generate the complete file name. |
FileNameNormalizer |
getFileNameNormalizer() Return the normalizer that will convert invalid file names into something usable. |
void |
setBaseDirectory(java.io.File baseDirectory) All the XML documents will be stored in subdirectories under the specified base directory. |
void |
setBaseDirectoryName(java.lang.String baseDirectoryName) All the XML documents will be stored in subdirectories under the specified base directory. |
void |
setCreatesDirectoriesAsNeeded(boolean createsDirectoriesAsNeeded) Set whether the policy will create directories as needed, if they do not exist already. |
void |
setFileNameExtension(java.lang.String fileNameExtension) Set the standard file name extension that will be appended to the primary key element value(s) to generate the complete file name. |
void |
setFileNameNormalizer(FileNameNormalizer fileNameNormalizer) Set the normalizer that will convert invalid file names into something usable. |
java.lang.String |
toString() Call #toString(PrintWriter) , to allow subclasses to insert additional information. |
void |
validateConfiguration() The accessor is connecting; if necessary, validate the policy's settings. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static java.lang.String DEFAULT_FILE_NAME_EXTENSION
Constructor Detail |
public DefaultXMLFileAccessorFilePolicy()
Method Detail |
public void createFileSource(java.lang.String rootElementName) throws XMLDataStoreException
XMLFileAccessorFilePolicy
createFileSource
in interface XMLFileAccessorFilePolicy
XMLDataStoreException
The name of this directory will typically take the form of [base dir]/[root element]
public void dropFileSource(java.lang.String rootElementName) throws XMLDataStoreException
XMLFileAccessorFilePolicy
dropFileSource
in interface XMLFileAccessorFilePolicy
XMLDataStoreException
The name of this directory will typically take the form of [base dir]/[root element]
public java.util.Enumeration getAllFiles(java.lang.String rootElementName) throws XMLDataStoreException
XMLFileAccessorFilePolicy
getAllFiles
in interface XMLFileAccessorFilePolicy
XMLDataStoreException
The name of these files will typically take the form of [base dir]/[root element]/*.xml
public java.io.File getFile(java.lang.String rootElementName, DatabaseRow row, java.util.Vector orderedPrimaryKeyElements) throws XMLDataStoreException
XMLFileAccessorFilePolicy
getFile
in interface XMLFileAccessorFilePolicy
XMLDataStoreException
The name of this file will typically take the form of [base dir]/[root element]/[key].xml
public void validateConfiguration() throws XMLDataStoreException
XMLFileAccessorFilePolicy
validateConfiguration
in interface XMLFileAccessorFilePolicy
XMLDataStoreException
Make sure the base directory is OK.
public boolean createsDirectoriesAsNeeded()
public java.io.File getBaseDirectory()
public java.lang.String getFileNameExtension()
public FileNameNormalizer getFileNameNormalizer()
public void setBaseDirectory(java.io.File baseDirectory)
public void setBaseDirectoryName(java.lang.String baseDirectoryName)
public void setCreatesDirectoriesAsNeeded(boolean createsDirectoriesAsNeeded)
public void setFileNameExtension(java.lang.String fileNameExtension)
public void setFileNameNormalizer(FileNameNormalizer fileNameNormalizer)
public java.lang.String toString()
#toString(PrintWriter)
, to allow subclasses to insert additional information.
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |