Java Doc for AbstractLocalFolder.java in  » Mail-Clients » columba-1.4 » org » columba » mail » folder » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Mail Clients » columba 1.4 » org.columba.mail.folder 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.columba.mail.folder.AbstractFolder
   org.columba.mail.folder.AbstractMessageFolder
      org.columba.mail.folder.AbstractLocalFolder

All known Subclasses:   org.columba.mail.folder.zippedmh.ZippedMHFolder,  org.columba.mail.folder.mh.CachedMHFolder,  org.columba.mail.folder.mbox.CachedMboxFolder,
AbstractLocalFolder
abstract public class AbstractLocalFolder extends AbstractMessageFolder (Code)
AbstractLocalFolder is a near-to working folder, which only needs a specific IDataStorage , DefaultSearchEngine and IHeaderListStorage "plugged in" to make it work.

This class is abstract becaused, instead use MHCachedFolder a complete implementation.

AbstractLocalFolder uses an internal ColumbaMessage object as cache. This allows parsing of a message only once, while accessing the data of the message multiple times.

Attribute nextMessageUid handles the next unique message ID. When adding a new message to this folder, it gets this ID assigned for later reference. Then nextMessageUid is simply increased.


See Also:   org.columba.mail.folder.mh.MHCachedFolder
author:
   fdietz



Field Summary
protected  ColumbaMessageaktMessage
    
protected  IDataStoragedataStorage
    
protected  IPersistantHeaderListheaderList
    
protected  intnextMessageUid
    

Constructor Summary
public  AbstractLocalFolder(FolderItem item, String path)
    
public  AbstractLocalFolder(String name, String type, String path)
    

Method Summary
public  ObjectaddMessage(InputStream in)
    
public  ObjectaddMessage(InputStream in, Attributes attributes, Flags flags)
    
public  voidexpungeFolder()
    
protected  ObjectgenerateNextMessageUid()
    
public  HeadergetAllHeaderFields(Object uid)
    
abstract public  IDataStoragegetDataStorageInstance()
     Implement a IDataStorage for the mailbox format of your pleasure.
public  HeadergetHeaderFields(Object uid, String[] keys)
     This method first tries to find the requested header in the header cache.
public synchronized  IHeaderListgetHeaderList()
    
protected  ColumbaMessagegetMessage(Object uid)
    
protected  IColumbaHeadergetMessageHeader(Object uid)
    
public  InputStreamgetMessageSourceStream(Object uid)
    
public  InputStreamgetMimePartBodyStream(Object uid, Integer[] address)
    
public  InputStreamgetMimePartSourceStream(Object uid, Integer[] address)
    
public  MimeTreegetMimePartTree(Object uid)
    
public  voidinnerCopy(IMailbox destFolder, Object[] uids)
     Copies a set of messages from this folder to a destination folder.

First we copy the message source to the destination folder.

public  booleanisInboxFolder()
    
public  booleanisTrashFolder()
    
protected  voidloadMessageFolderInfo()
    
public  voidremoveFolder()
    
public  voidremoveMessage(Object uid)
    
public  voidsave()
    
protected  voidsetFlags(Object uid, Flags flags)
     Changes the selected message flags and updates the MailFolderInfo accordingly.
public  voidsetNextMessageUid(int next)
    
public  booleansupportsAddFolder(String newFolderType)
    
public  booleansupportsMove()
     Returns true since local folders can be moved.

Field Detail
aktMessage
protected ColumbaMessage aktMessage(Code)
we keep one message in cache in order to not needing to parse it twice times



dataStorage
protected IDataStorage dataStorage(Code)
implement your own mailbox format here



headerList
protected IPersistantHeaderList headerList(Code)



nextMessageUid
protected int nextMessageUid(Code)
the next messag which gets added to this folder receives this unique ID




Constructor Detail
AbstractLocalFolder
public AbstractLocalFolder(FolderItem item, String path)(Code)

Parameters:
  item - FolderItem contains xml configuration of thisfolder



AbstractLocalFolder
public AbstractLocalFolder(String name, String type, String path)(Code)

Parameters:
  name - the name of the folder.
Parameters:
  type - type of folder.




Method Detail
addMessage
public Object addMessage(InputStream in) throws Exception(Code)



addMessage
public Object addMessage(InputStream in, Attributes attributes, Flags flags) throws Exception(Code)



expungeFolder
public void expungeFolder() throws Exception(Code)

See Also:   org.columba.mail.folder.IMailbox.expungeFolder



generateNextMessageUid
protected Object generateNextMessageUid()(Code)
Generate new unique message ID Integer containing UID



getAllHeaderFields
public Header getAllHeaderFields(Object uid) throws Exception(Code)

See Also:   org.columba.mail.folder.IMailbox.getAllHeaderFields(java.lang.Object)



getDataStorageInstance
abstract public IDataStorage getDataStorageInstance()(Code)
Implement a IDataStorage for the mailbox format of your pleasure. instance of IDataStorage



getHeaderFields
public Header getHeaderFields(Object uid, String[] keys) throws Exception(Code)
This method first tries to find the requested header in the header cache. If the headerfield is not cached, the message source is parsed.
See Also:   org.columba.mail.folder.IMailbox.getHeaderFields(java.lang.Objectjava.lang.String[])



getHeaderList
public synchronized IHeaderList getHeaderList() throws Exception(Code)



getMessage
protected ColumbaMessage getMessage(Object uid) throws Exception(Code)

Parameters:
  uid -
throws:
  Exception -



getMessageHeader
protected IColumbaHeader getMessageHeader(Object uid) throws Exception(Code)

See Also:   org.columba.mail.folder.IMailbox.getMessageHeader(java.lang.Object)



getMessageSourceStream
public InputStream getMessageSourceStream(Object uid) throws Exception(Code)



getMimePartBodyStream
public InputStream getMimePartBodyStream(Object uid, Integer[] address) throws Exception(Code)



getMimePartSourceStream
public InputStream getMimePartSourceStream(Object uid, Integer[] address) throws Exception(Code)



getMimePartTree
public MimeTree getMimePartTree(Object uid) throws Exception(Code)

See Also:   org.columba.mail.folder.IMailbox.getMimePartTree(java.lang.Object)



innerCopy
public void innerCopy(IMailbox destFolder, Object[] uids) throws Exception(Code)
Copies a set of messages from this folder to a destination folder.

First we copy the message source to the destination folder. Then we also copy the flags attribute of this message.
See Also:   org.columba.mail.folder.IMailbox.innerCopy(org.columba.mail.folder.IMailboxjava.lang.Object[])




isInboxFolder
public boolean isInboxFolder()(Code)



isTrashFolder
public boolean isTrashFolder()(Code)



loadMessageFolderInfo
protected void loadMessageFolderInfo()(Code)



removeFolder
public void removeFolder() throws Exception(Code)
Remove folder from tree
See Also:   org.columba.mail.folder.FolderTreeNode.removeFolder



removeMessage
public void removeMessage(Object uid) throws Exception(Code)

See Also:   org.columba.mail.folder.IMailbox.remove(java.lang.Object)



save
public void save() throws Exception(Code)

See Also:   org.columba.mail.folder.AbstractMessageFolder.save



setFlags
protected void setFlags(Object uid, Flags flags) throws Exception(Code)
Changes the selected message flags and updates the MailFolderInfo accordingly.

This method is only used for innerCopy().
Parameters:
  uid - selected message UID
Parameters:
  flags - new flags
throws:
  Exception -




setNextMessageUid
public void setNextMessageUid(int next)(Code)
Set next unique message ID
Parameters:
  next - number of next message



supportsAddFolder
public boolean supportsAddFolder(String newFolderType)(Code)



supportsMove
public boolean supportsMove()(Code)
Returns true since local folders can be moved. true.



Fields inherited from org.columba.mail.folder.AbstractMessageFolder
protected boolean changed(Code)(Java Doc)
protected File directoryFile(Code)(Java Doc)
protected FilterList filterList(Code)(Java Doc)
protected Object lastSelection(Code)(Java Doc)
protected IMailboxInfo messageFolderInfo(Code)(Java Doc)
protected IStatusObservable observable(Code)(Java Doc)
protected DefaultSearchEngine searchEngine(Code)(Java Doc)

Methods inherited from org.columba.mail.folder.AbstractMessageFolder
protected InputStream decodeStream(MimeHeader header, InputStream bodyStream)(Code)(Java Doc)
public boolean exists(Object uid) throws Exception(Code)(Java Doc)
public void expungeFolder() throws Exception(Code)(Java Doc)
public void fireMessageAdded(Object uid, Flags flags)(Code)(Java Doc)
public void fireMessageFlagChanged(Object uid, Flags oldFlags, int variant)(Code)(Java Doc)
public void fireMessageRemoved(Object uid, Flags flags)(Code)(Java Doc)
public Object getAttribute(Object uid, String key) throws Exception(Code)(Java Doc)
public Attributes getAttributes(Object uid) throws Exception(Code)(Java Doc)
public File getDirectoryFile()(Code)(Java Doc)
public IFilterList getFilterList()(Code)(Java Doc)
public Flags getFlags(Object uid) throws Exception(Code)(Java Doc)
abstract public IHeaderList getHeaderList() throws Exception(Code)(Java Doc)
public Object getLastSelection()(Code)(Java Doc)
public IMailboxInfo getMessageFolderInfo()(Code)(Java Doc)
public IStatusObservable getObservable()(Code)(Java Doc)
public DefaultSearchEngine getSearchEngine()(Code)(Java Doc)
public Object[] getUids() throws Exception(Code)(Java Doc)
protected boolean hasChanged()(Code)(Java Doc)
public boolean isInboxFolder()(Code)(Java Doc)
public boolean isReadOnly()(Code)(Java Doc)
public boolean isTrashFolder()(Code)(Java Doc)
protected void loadMessageFolderInfo()(Code)(Java Doc)
protected void markMessage(Object uid, int variant) throws Exception(Code)(Java Doc)
public void markMessage(Object[] uids, int variant) throws Exception(Code)(Java Doc)
protected void recreateMessageFolderInfo()(Code)(Java Doc)
public void removeMessage(Object uid) throws Exception(Code)(Java Doc)
public void save() throws Exception(Code)(Java Doc)
protected void saveMessageFolderInfo()(Code)(Java Doc)
public Object[] searchMessages(IFilter filter, Object[] uids) throws Exception(Code)(Java Doc)
public Object[] searchMessages(IFilter filter) throws Exception(Code)(Java Doc)
public void setAttribute(Object uid, String key, Object value) throws Exception(Code)(Java Doc)
public void setChanged(boolean b)(Code)(Java Doc)
public void setLastSelection(Object lastSel)(Code)(Java Doc)
public void setMessageFolderInfo(MailboxInfo i)(Code)(Java Doc)
public void setSearchEngine(DefaultSearchEngine engine)(Code)(Java Doc)
public boolean supportsAddMessage()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
protected void updateMailFolderInfo(Flags flags, int variant) throws Exception(Code)(Java Doc)

Fields inherited from org.columba.mail.folder.AbstractFolder
protected EventListenerList listenerList(Code)(Java Doc)
protected Lock myLock(Code)(Java Doc)
protected IFolderItem node(Code)(Java Doc)

Methods inherited from org.columba.mail.folder.AbstractFolder
public void add(IMailFolder treeNode)(Code)(Java Doc)
public void addFolderListener(IFolderListener l)(Code)(Java Doc)
public void addSubfolder(IMailFolder child) throws Exception(Code)(Java Doc)
public AbstractFolder findChildWithName(String str, boolean recurse)(Code)(Java Doc)
public AbstractFolder findChildWithName(String str, boolean recurse, Class type)(Code)(Java Doc)
public AbstractFolder findChildWithUID(String uid, boolean recurse)(Code)(Java Doc)
public void fireFolderAdded(IMailFolder folder)(Code)(Java Doc)
public void fireFolderPropertyChanged()(Code)(Java Doc)
public void fireFolderRemoved()(Code)(Java Doc)
public IFolderItem getConfiguration()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
protected TreeNode[] getPathToRoot(TreeNode aNode, int depth)(Code)(Java Doc)
public IMailFolder getRootFolder()(Code)(Java Doc)
public TreePath getSelectionTreePath()(Code)(Java Doc)
public String getTreePath()(Code)(Java Doc)
public String getType()(Code)(Java Doc)
public void insert(IMailFolder newFolder, int newIndex)(Code)(Java Doc)
public void moveTo(IMailFolder newParent)(Code)(Java Doc)
public void releaseLock(Object locker)(Code)(Java Doc)
public void removeFolder() throws Exception(Code)(Java Doc)
public void removeFolderListener(IFolderListener l)(Code)(Java Doc)
public void setConfiguration(IFolderItem node)(Code)(Java Doc)
public void setName(String newName) throws Exception(Code)(Java Doc)
public boolean supportsAddFolder(String newFolderType)(Code)(Java Doc)
public boolean supportsAddMessage()(Code)(Java Doc)
public boolean supportsMove()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public boolean tryToGetLock(Object locker)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.