dtw.webmail.plugin.std
Class CastorPreferences

java.lang.Object
  |
  +--dtw.webmail.util.AbstractIdentifiable
        |
        +--dtw.webmail.plugin.std.CastorPreferences

All Implemented Interfaces:

Associator, java.lang.Cloneable, Identifiable, JwmaPreferences, JwmaPreferencesImpl, org.exolab.castor.jdo.TimeStampable

public class CastorPreferences

extends AbstractIdentifiable

implements JwmaPreferencesImpl, Associator, org.exolab.castor.jdo.TimeStampable

Class implementing a specialized JwmaPreferencesImpl for being persisted with the Castor Plugins.

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Field Summary

int	m_MessageSortCriteria

Fields inherited from interface org.exolab.castor.jdo.TimeStampable

NO_TIMESTAMP

Constructor Summary

CastorPreferences()
Constructs a JwmaPreferences instance.

Method Summary

void	addMailIdentity(JwmaMailIdentity identity) Adds the given JwmaMailIdentity to this JwmaPreferences.
JwmaMailIdentityImpl	createMailIdentity() Factory method for an implementation specific JwmaMailIdentityImpl.
boolean	existsMailIdentity(java.lang.String uid) Tests if a JwmaMailIdentity with the given index exists.
JwmaPreferencesImpl	getClone() Returns a clone of this preferences.
java.lang.String	getContactDatabaseID() Returns a String representing the user's contact database UID.
java.text.DateFormat	getDateFormat() Returns a DateFormat representing the user's preferred date format.
java.lang.String	getDateFormatPattern()
java.lang.String	getDefaultMailIdentity()
java.lang.String	getDraftFolder() Returns a String representing the full name of the draft folder.
java.lang.String	getFirstname() Returns a String representing the firstname of the owner of this JwmaPreferences.
java.lang.String	getLanguage() Returns a String representing the language.
java.lang.String	getLastLogin() Returns a String representing the user's last login date and originating host.
java.lang.String	getLastname() Returns a String representing the lastname of the owner of this JwmaPreferences.
java.util.Locale	getLocale() Returns the Locale associated with this JwmaPreferences.
java.util.List	getMailIdentities()
JwmaMailIdentity	getMailIdentity() Returns the user's default JwmaMailIdentity.
JwmaMailIdentity	getMailIdentity(java.lang.String uid) Returns the JwmaMailIdentity with the given unique identifier.
java.util.Collection	getMailIdentityCollection()
int	getMailIdentityCount() Returns the count of JwmaMailIdentity instances that are associated with this JwmaPreferences.
net.wimpi.text.Processor	getMessageProcessor() Returns a Processor representing the users preferred message processor for processing text/plain messages.
java.lang.String	getMessageProcessorName() Convenience method that returns a String representing the users preferred message processor name.
int	getMessageSortCriteria() Returns the sort criteria preference for messages.
java.lang.String	getQuoteChar() Returns a String representing the quote character.
java.lang.String	getReadMailArchive() Returns a String representing the path of the read-mail-archive.
java.util.List	getRemovedAssociations() Returns the associated instances.
java.lang.String	getRootFolder() Returns a String representing the path of the mail root folder.
java.lang.String	getSentMailArchive() Returns a String representing the path of the sent-mail-archive.
java.lang.String	getStyle() Returns a String representing the users preferred style.
java.lang.String	getTrashFolder() Returns a String representing the path of the read-mail-archive.
java.lang.String	getUserIdentity() Returns a String representing identity of the owner of this JwmaPreferences.
boolean	isAutoArchiveSent() Tests if messages should be automatically archived when sent.
boolean	isAutoEmpty() Tests if the trash should be emptied automatically when logging out.
boolean	isAutoMoveRead() Tests if messages should be automatically moved when read.
boolean	isAutoQuote() Tests if messages should be quoted automatically when replying.
boolean	isDisplayingInlined() Tests if known mime message content should be inlined when displaying the message.
boolean	isExpert() Tests if the user considers to be an xpert.
long	jdoGetTimeStamp()
void	jdoSetTimeStamp(long timeStamp)
JwmaMailIdentity[]	listMailIdentities() Returns a JwmaMailIdentities[] that contains all JwmaMailIdentity instances of this JwmaPreferences.
void	persistPreferences(org.exolab.castor.jdo.Database db)
void	removeMailIdentity(java.lang.String uid) Removes the JwmaMailIdentity with the given id from this JwmaPreferences.
void	setAutoArchiveSent(boolean doarchive) Sets the flag that controls wheter messages should be automatically archived when sent.
void	setAutoEmpty(boolean b) Sets the flag that controls wheter messages should be automatically deleted from the trash on logout.
void	setAutoMoveRead(boolean domoveread) Sets the flag that controls wheter messages should be automatically moved when read.
void	setAutoQuote(boolean doquote) Sets the flag that controls wheter messages should be automatically quoted on reply.
void	setContactDatabaseID(java.lang.String dbid) Sets a String representing the user's contact database UID.
void	setDateFormat(java.text.SimpleDateFormat dateformat) Sets the DateFormat representing the user's preferred date format.
void	setDateFormatPattern(java.lang.String pattern)
void	setDefaultMailIdentity(java.lang.String uid) Sets the user's default identity JwmaMailIdentity instance.
void	setDisplayingInlined(boolean b) Sets the flag that controls whether known mime message content is displayed inline.
void	setDraftFolder(java.lang.String path) Sets the path of the draft folder.
void	setExpert(boolean b) Sets the flag that shows wheter the owner of this JwmaPreferences considers to be an xpert.
void	setFirstname(java.lang.String firstname) Sets the firstname of the owner of this JwmaPreferences.
void	setLanguage(java.lang.String str) Sets the language of this JwmaPreferences.
void	setLastLogin(java.lang.String lastlogin) Sets the the user's last login date and originating host.
void	setLastname(java.lang.String lastname) Sets the lastname of the owner of this JwmaPreferences.
void	setLocale(java.util.Locale locale) Sets the Locale associated with this JwmaPreferences.
void	setMailIdentityCollection(java.util.Collection collection)
void	setMessageProcessor(net.wimpi.text.Processor processor) Sets the Processor representing the users preferred message processor for processing plain/text messages.
void	setMessageProcessorName(java.lang.String name) Sets the Processor representing the users preferred message processor for processing plain/text messages by its name.
void	setMessageSortCriteria(int messageSortCriteria) Sets the sort criteria preference for messages.
void	setQuoteChar(java.lang.String qc) Sets the quoting character.
void	setReadMailArchive(java.lang.String path) Sets the path of the read-mail-archive.
void	setRootFolder(java.lang.String path) Sets the path of the mail root folder.
void	setSentMailArchive(java.lang.String path) Sets the path of the sent-mail-archive.
void	setStyle(java.lang.String style) Sets a String representing the users preferred style.
void	setTrashFolder(java.lang.String path) Sets the path of the trashfolder.
void	setUserIdentity(java.lang.String userid) Sets the identity of this JwmaPreferences.
void	updatePreferences(org.exolab.castor.jdo.Database db)

Methods inherited from class dtw.webmail.util.AbstractIdentifiable

equals, getUID, setUID

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_MessageSortCriteria

public int m_MessageSortCriteria

Constructor Detail

CastorPreferences

public CastorPreferences()

Constructs a JwmaPreferences instance.

Method Detail

getUserIdentity

public java.lang.String getUserIdentity()

Description copied from interface: JwmaPreferences

Returns a String representing identity of the owner of this JwmaPreferences.

Note:
The format of the string has to be <username>@<postofficehost>.

Specified by:

getUserIdentity in interface JwmaPreferences

Returns:

the firstname of this preferences owner.

setUserIdentity

public void setUserIdentity(java.lang.String userid)

Sets the identity of this JwmaPreferences.

Note:
The format of the string has to be <username>@<postofficehost>.

Specified by:

setUserIdentity in interface JwmaPreferencesImpl

getFirstname

public java.lang.String getFirstname()

Description copied from interface: JwmaPreferences

Returns a String representing the firstname of the owner of this JwmaPreferences.

Specified by:

getFirstname in interface JwmaPreferences

Returns:

the firstname of this preferences owner.

setFirstname

public void setFirstname(java.lang.String firstname)

Sets the firstname of the owner of this JwmaPreferences.

Specified by:

setFirstname in interface JwmaPreferencesImpl

Parameters:

firstname - the owner's firstname.

getLastname

public java.lang.String getLastname()

Description copied from interface: JwmaPreferences

Returns a String representing the lastname of the owner of this JwmaPreferences.

Specified by:

getLastname in interface JwmaPreferences

Returns:

the lastname of this preferences owner.

setLastname

public void setLastname(java.lang.String lastname)

Sets the lastname of the owner of this JwmaPreferences.

Specified by:

setLastname in interface JwmaPreferencesImpl

Parameters:

lastname - the owner's lastname.

getLastLogin

public java.lang.String getLastLogin()

Description copied from interface: JwmaPreferences

Returns a String representing the user's last login date and originating host.

Specified by:

getLastLogin in interface JwmaPreferences

Returns:

the last login with date and originating host as String.

setLastLogin

public void setLastLogin(java.lang.String lastlogin)

Sets the the user's last login date and originating host.

Specified by:

setLastLogin in interface JwmaPreferencesImpl

getQuoteChar

public java.lang.String getQuoteChar()

Description copied from interface: JwmaPreferences

Returns a String representing the quote character. Note: it always contains only one character.

Specified by:

getQuoteChar in interface JwmaPreferences

Returns:

the quote character as String.

setQuoteChar

public void setQuoteChar(java.lang.String qc)

Sets the quoting character.

Note: only the first character is taken from the String.

Specified by:

setQuoteChar in interface JwmaPreferencesImpl

Returns:

the quote character as String.

isAutoQuote

public boolean isAutoQuote()

Description copied from interface: JwmaPreferences

Tests if messages should be quoted automatically when replying.

Specified by:

isAutoQuote in interface JwmaPreferences

Returns:

true if messages should be quoted automatically, false otherwise.

setAutoQuote

public void setAutoQuote(boolean doquote)

Sets the flag that controls wheter messages should be automatically quoted on reply.

Specified by:

setAutoQuote in interface JwmaPreferencesImpl

Parameters:

doquote - true if messages being replied to should be automatically quoted, false otherwise.

getRootFolder

public java.lang.String getRootFolder()

Description copied from interface: JwmaPreferences

Returns a String representing the path of the mail root folder.

Note: This setting varies for different IMAP implementations.

Specified by:

getRootFolder in interface JwmaPreferences

Returns:

the mail root folder as String.

setRootFolder

public void setRootFolder(java.lang.String path)

Sets the path of the mail root folder.

Specified by:

setRootFolder in interface JwmaPreferencesImpl

Parameters:

path - the path of root mail folder as String.

getSentMailArchive

public java.lang.String getSentMailArchive()

Description copied from interface: JwmaPreferences

Returns a String representing the path of the sent-mail-archive.

Specified by:

getSentMailArchive in interface JwmaPreferences

Returns:

the path of the sent-mail-archive as String.

setSentMailArchive

public void setSentMailArchive(java.lang.String path)

Sets the path of the sent-mail-archive.

Specified by:

setSentMailArchive in interface JwmaPreferencesImpl

Parameters:

path - the path of the sent-mail-archive as String.

getReadMailArchive

public java.lang.String getReadMailArchive()

Description copied from interface: JwmaPreferences

Returns a String representing the path of the read-mail-archive.

Specified by:

getReadMailArchive in interface JwmaPreferences

Returns:

the path of the read-mail-archive as String.

setReadMailArchive

public void setReadMailArchive(java.lang.String path)

Sets the path of the read-mail-archive.

Specified by:

setReadMailArchive in interface JwmaPreferencesImpl

Parameters:

path - the path of the read-mail-archive as String.

getTrashFolder

public java.lang.String getTrashFolder()

Description copied from interface: JwmaPreferences

Returns a String representing the path of the read-mail-archive.

Specified by:

getTrashFolder in interface JwmaPreferences

Returns:

the path of the read-mail-archive as String.

setTrashFolder

public void setTrashFolder(java.lang.String path)

Sets the path of the trashfolder.

Specified by:

setTrashFolder in interface JwmaPreferencesImpl

Parameters:

path - the path of the trashfolder as String.

getDraftFolder

public java.lang.String getDraftFolder()

Description copied from interface: JwmaPreferences

Returns a String representing the full name of the draft folder.

Specified by:

getDraftFolder in interface JwmaPreferences

Returns:

the full name of the draft folder as String.

setDraftFolder

public void setDraftFolder(java.lang.String path)

Sets the path of the draft folder.

Specified by:

setDraftFolder in interface JwmaPreferencesImpl

Parameters:

path - the path of the draft folder as String.

setAutoArchiveSent

public void setAutoArchiveSent(boolean doarchive)

Sets the flag that controls wheter messages should be automatically archived when sent.

Specified by:

setAutoArchiveSent in interface JwmaPreferencesImpl

Parameters:

doarchive - true if messages being sent should be automatically archived, false otherwise.

isAutoArchiveSent

public boolean isAutoArchiveSent()

Description copied from interface: JwmaPreferences

Tests if messages should be automatically archived when sent.

Specified by:

isAutoArchiveSent in interface JwmaPreferences

Returns:

true if messages should be archived automatically, false otherwise.

setAutoMoveRead

public void setAutoMoveRead(boolean domoveread)

Sets the flag that controls wheter messages should be automatically moved when read.

Specified by:

setAutoMoveRead in interface JwmaPreferencesImpl

Parameters:

domoveread - true if read messages should be automatically moved, false otherwise.

isAutoMoveRead

public boolean isAutoMoveRead()

Description copied from interface: JwmaPreferences

Tests if messages should be automatically moved when read.

Specified by:

isAutoMoveRead in interface JwmaPreferences

Returns:

true if messages should be moved automatically, false otherwise.

isAutoEmpty

public boolean isAutoEmpty()

Description copied from interface: JwmaPreferences

Tests if the trash should be emptied automatically when logging out.

Specified by:

isAutoEmpty in interface JwmaPreferences

Returns:

true if the trash should be emptied automatically, false otherwise.

setAutoEmpty

public void setAutoEmpty(boolean b)

Sets the flag that controls wheter messages should be automatically deleted from the trash on logout.

Specified by:

setAutoEmpty in interface JwmaPreferencesImpl

Parameters:

b - true if messages in trash should be automatically deleted on logout, false otherwise.

getLanguage

public java.lang.String getLanguage()

Description copied from interface: JwmaPreferences

Returns a String representing the language.

Note that this method is a shortcut for getLocale().getLanguage().

Specified by:

getLanguage in interface JwmaPreferences

Returns:

the language locale as String.

setLanguage

public void setLanguage(java.lang.String str)

Sets the language of this JwmaPreferences.

Specified by:

setLanguage in interface JwmaPreferencesImpl

Parameters:

str - the language locale as String.

getLocale

public java.util.Locale getLocale()

Description copied from interface: JwmaPreferences

Returns the Locale associated with this JwmaPreferences.

Specified by:

getLocale in interface JwmaPreferences

Returns:

the associated Locale.

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: JwmaPreferencesImpl

Sets the Locale associated with this JwmaPreferences.

Specified by:

setLocale in interface JwmaPreferencesImpl

Parameters:

locale - the Locale to be set.

getContactDatabaseID

public java.lang.String getContactDatabaseID()

Description copied from interface: JwmaPreferencesImpl

Returns a String representing the user's contact database UID.

Specified by:

getContactDatabaseID in interface JwmaPreferencesImpl

Returns:

the UID of the contact database as String.

setContactDatabaseID

public void setContactDatabaseID(java.lang.String dbid)

Description copied from interface: JwmaPreferencesImpl

Sets a String representing the user's contact database UID.

Specified by:

setContactDatabaseID in interface JwmaPreferencesImpl

Returns:

the UID of the contact database as String.

setMessageProcessorName

public void setMessageProcessorName(java.lang.String name)

Description copied from interface: JwmaPreferencesImpl

Sets the Processor representing the users preferred message processor for processing plain/text messages by its name.

Note that this method is a shortcut for

 
 setMessageProcessor(
         JwmaKernel.getReference().getMessageProcessor(String name)
 );
 
 

Specified by:

setMessageProcessorName in interface JwmaPreferencesImpl

Parameters:

name - the Processor's identifier as String.

getMessageProcessorName

public java.lang.String getMessageProcessorName()

Description copied from interface: JwmaPreferences

Convenience method that returns a String representing the users preferred message processor name.

Specified by:

getMessageProcessorName in interface JwmaPreferences

Returns:

the name of the message processor as String.

getMessageProcessor

public net.wimpi.text.Processor getMessageProcessor()

Description copied from interface: JwmaPreferences

Returns a Processor representing the users preferred message processor for processing text/plain messages.

Specified by:

getMessageProcessor in interface JwmaPreferences

Returns:

the message processor as Processor.

setMessageProcessor

public void setMessageProcessor(net.wimpi.text.Processor processor)

Description copied from interface: JwmaPreferencesImpl

Sets the Processor representing the users preferred message processor for processing plain/text messages.

Specified by:

setMessageProcessor in interface JwmaPreferencesImpl

Parameters:

processor - the preferred message processor.

getDateFormat

public java.text.DateFormat getDateFormat()

Description copied from interface: JwmaPreferences

Returns a DateFormat representing the user's preferred date format.

Specified by:

getDateFormat in interface JwmaPreferences

Returns:

the user's preferred DateFormat.

setDateFormat

public void setDateFormat(java.text.SimpleDateFormat dateformat)

Description copied from interface: JwmaPreferencesImpl

Sets the DateFormat representing the user's preferred date format. Note that the passed in dateformat should be an instance of SimpleDateFormat, which is enforced by the parameter type.

Specified by:

setDateFormat in interface JwmaPreferencesImpl

Parameters:

dateformat - the user's preferred SimpleDateFormat.

getDateFormatPattern

public java.lang.String getDateFormatPattern()

setDateFormatPattern

public void setDateFormatPattern(java.lang.String pattern)

setDefaultMailIdentity

public void setDefaultMailIdentity(java.lang.String uid)

Description copied from interface: JwmaPreferencesImpl

Sets the user's default identity JwmaMailIdentity instance.

Specified by:

setDefaultMailIdentity in interface JwmaPreferencesImpl

Parameters:

uid - the identifier of the JwmaMailIdentity to be set as default.

getDefaultMailIdentity

public java.lang.String getDefaultMailIdentity()

getMailIdentity

public JwmaMailIdentity getMailIdentity()

Description copied from interface: JwmaPreferences

Returns the user's default JwmaMailIdentity.

Specified by:

getMailIdentity in interface JwmaPreferences

Returns:

a the preferred or default JwmaMailIdentity.

getMailIdentityCollection

public java.util.Collection getMailIdentityCollection()

setMailIdentityCollection

public void setMailIdentityCollection(java.util.Collection collection)

getMailIdentities

public java.util.List getMailIdentities()

listMailIdentities

public JwmaMailIdentity[] listMailIdentities()

Description copied from interface: JwmaPreferences

Returns a JwmaMailIdentities[] that contains all JwmaMailIdentity instances of this JwmaPreferences.

Specified by:

listMailIdentities in interface JwmaPreferences

Returns:

the user's mail identities as JwmaMailIdentity[].

existsMailIdentity

public boolean existsMailIdentity(java.lang.String uid)

Description copied from interface: JwmaPreferencesImpl

Tests if a JwmaMailIdentity with the given index exists.

Specified by:

existsMailIdentity in interface JwmaPreferencesImpl

Parameters:

uid - the identifier of the JwmaMailIdentity.

getMailIdentity

public JwmaMailIdentity getMailIdentity(java.lang.String uid)

Description copied from interface: JwmaPreferences

Returns the JwmaMailIdentity with the given unique identifier. If the identifier is invalid, the method will return the default mail identity.

Specified by:

getMailIdentity in interface JwmaPreferences

Parameters:

uid - a unique identifier of a mail identity.

Returns:

the JwmaMailIdentity with the given uid.

addMailIdentity

public void addMailIdentity(JwmaMailIdentity identity)

Description copied from interface: JwmaPreferencesImpl

Adds the given JwmaMailIdentity to this JwmaPreferences.

Specified by:

addMailIdentity in interface JwmaPreferencesImpl

Parameters:

identity - the JwmaMailIdentity to be added.

removeMailIdentity

public void removeMailIdentity(java.lang.String uid)

Description copied from interface: JwmaPreferencesImpl

Removes the JwmaMailIdentity with the given id from this JwmaPreferences.

Specified by:

removeMailIdentity in interface JwmaPreferencesImpl

Parameters:

uid - the identifier of the JwmaMailIdentity to be removed.

getMailIdentityCount

public int getMailIdentityCount()

Description copied from interface: JwmaPreferencesImpl

Returns the count of JwmaMailIdentity instances that are associated with this JwmaPreferences.

Specified by:

getMailIdentityCount in interface JwmaPreferencesImpl

Returns:

the number of JwmaMailIdentity instances associated with this JwmaPreferences.

isExpert

public boolean isExpert()

Description copied from interface: JwmaPreferences

Tests if the user considers to be an xpert.

Specified by:

isExpert in interface JwmaPreferences

Returns:

true if expert, false otherwise.

setExpert

public void setExpert(boolean b)

Description copied from interface: JwmaPreferencesImpl

Sets the flag that shows wheter the owner of this JwmaPreferences considers to be an xpert.

Specified by:

setExpert in interface JwmaPreferencesImpl

Parameters:

b - true if expert, false otherwise.

setStyle

public void setStyle(java.lang.String style)

Description copied from interface: JwmaPreferencesImpl

Sets a String representing the users preferred style.

Specified by:

setStyle in interface JwmaPreferencesImpl

Parameters:

style - the style as String.

getStyle

public java.lang.String getStyle()

Description copied from interface: JwmaPreferences

Returns a String representing the users preferred style.

Specified by:

getStyle in interface JwmaPreferences

Returns:

the style as String.

isDisplayingInlined

public boolean isDisplayingInlined()

Description copied from interface: JwmaPreferences

Tests if known mime message content should be inlined when displaying the message.

Specified by:

isDisplayingInlined in interface JwmaPreferences

Returns:

true if inlining is enabled, false otherwise.

setDisplayingInlined

public void setDisplayingInlined(boolean b)

Description copied from interface: JwmaPreferencesImpl

Sets the flag that controls whether known mime message content is displayed inline.

Specified by:

setDisplayingInlined in interface JwmaPreferencesImpl

Returns:

true if inline displaying is to be enabled, false otherwise.

getMessageSortCriteria

public int getMessageSortCriteria()

Description copied from interface: JwmaPreferences

Returns the sort criteria preference for messages.

Specified by:

getMessageSortCriteria in interface JwmaPreferences

Returns:

the sort criteria as int.

setMessageSortCriteria

public void setMessageSortCriteria(int messageSortCriteria)

Description copied from interface: JwmaPreferences

Sets the sort criteria preference for messages.

Specified by:

setMessageSortCriteria in interface JwmaPreferences

Parameters:

messageSortCriteria - the sort criteria as int.

createMailIdentity

public JwmaMailIdentityImpl createMailIdentity()

Description copied from interface: JwmaPreferencesImpl

Factory method for an implementation specific JwmaMailIdentityImpl.

Specified by:

createMailIdentity in interface JwmaPreferencesImpl

Returns:

an instance of the related JwmaMailIdentityImpl implementation.

getClone

public JwmaPreferencesImpl getClone()

Returns a clone of this preferences.

Returns:

the clone, or null if the cloning process failed.

getRemovedAssociations

public java.util.List getRemovedAssociations()

Description copied from interface: Associator

Returns the associated instances.

Specified by:

getRemovedAssociations in interface Associator

Returns:

the associated instances as List.

updatePreferences

public void updatePreferences(org.exolab.castor.jdo.Database db)
                       throws org.exolab.castor.jdo.PersistenceException

org.exolab.castor.jdo.PersistenceException

persistPreferences

public void persistPreferences(org.exolab.castor.jdo.Database db)
                        throws org.exolab.castor.jdo.PersistenceException

org.exolab.castor.jdo.PersistenceException

jdoGetTimeStamp

public long jdoGetTimeStamp()

Specified by:

jdoGetTimeStamp in interface org.exolab.castor.jdo.TimeStampable

jdoSetTimeStamp

public void jdoSetTimeStamp(long timeStamp)

Specified by:

jdoSetTimeStamp in interface org.exolab.castor.jdo.TimeStampable