org.apache.wsrp4j.persistence.xml
Interface PersistentInformationXML

All Superinterfaces:

PersistentInformation

All Known Implementing Classes:

PersistentInformationImpl

public interface PersistentInformationXML

extends PersistentInformation

This class defines the interface for persistent information needed to store and retrieve PersistentDataObjects with castor XML support.

Version:

$Id: PersistentInformationXML.java,v 1.4 2005/08/10 14:59:59 cziegeler Exp $

Author:

Ralf Altrichter

Method Summary

java.lang.String	getExtension() Returns the file extension used for persistent XML files
java.lang.String	getFilename() Returns a fully qualified file name for a persistent XML file.
java.lang.String	getFilenameStub() Returns the file name stub for persistent XML files.
java.lang.String	getMappingFileName() Returns the XML mapping file name, fully qualified
java.lang.String	getSeparator() Set the Separator, to be used in a fully qualified file name.
java.lang.String	getStoreDirectory() Returns the directory for the persistent XML files
void	setExtension(java.lang.String extension) Set the file extension for persistent XML files.
void	setFilename(java.lang.String filename) Set the fully qualified file name for a persistent XML file.
void	setFilenameStub(java.lang.String stub) Set the file name stub for persistent XML files.
void	setMappingFileName(java.lang.String mappingFileName) Set the Castor XML mapping file name, fully qualified
void	setSeparator(java.lang.String separator) Set the separator character.
void	setStoreDirectory(java.lang.String storeDirectory) Set the Store directory for the persistent XML files
java.lang.String	toString()
void	updateFileName(java.lang.String token) Updates the file name, enhanced by a string token, like a handle to idportlet a unique persistent XML file.

Methods inherited from interface org.apache.wsrp4j.persistence.PersistentInformation

getGroupID, setGroupID

Method Detail

setStoreDirectory

public void setStoreDirectory(java.lang.String storeDirectory)

Set the Store directory for the persistent XML files

Parameters:

storeDirectory - String name of the store

getStoreDirectory

public java.lang.String getStoreDirectory()

Returns the directory for the persistent XML files

Returns:

String nanme of the store

setMappingFileName

public void setMappingFileName(java.lang.String mappingFileName)

Set the Castor XML mapping file name, fully qualified

Parameters:

mappingFileName - String fully qualified filename

getMappingFileName

public java.lang.String getMappingFileName()

Returns the XML mapping file name, fully qualified

Returns:

String fully qualified filename

setFilenameStub

public void setFilenameStub(java.lang.String stub)

Set the file name stub for persistent XML files. The name contains the store directory followed by a file separator and the class name of the object to be restored.

Parameters:

stub - String file name stub

getFilenameStub

public java.lang.String getFilenameStub()

Returns the file name stub for persistent XML files. @see setFilenameStub

Returns:

String file name stub

getFilename

public java.lang.String getFilename()

Returns a fully qualified file name for a persistent XML file.

Returns:

String file name

setFilename

public void setFilename(java.lang.String filename)

Set the fully qualified file name for a persistent XML file.

Parameters:

filename - String file name

updateFileName

public void updateFileName(java.lang.String token)

Updates the file name, enhanced by a string token, like a handle to idportlet a unique persistent XML file. If a groupID is set, the groupID is used instead of the token to build the filename.

Parameters:

token - String token, like a handle

getExtension

public java.lang.String getExtension()

Returns the file extension used for persistent XML files

setExtension

public void setExtension(java.lang.String extension)

Set the file extension for persistent XML files.

Parameters:

extension - String file extension

getSeparator

public java.lang.String getSeparator()

Set the Separator, to be used in a fully qualified file name.

Returns:

String Separator character

setSeparator

public void setSeparator(java.lang.String separator)

Set the separator character. (e.g. '@')

Parameters:

separator - String Separator character

toString

public java.lang.String toString()

Returns:

this object as String