Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

com.arcle.rmt.superwaba.model.DocumentManager Class Reference

The DocumentManager singleton provides means to access documents in the device. More...

Inheritance diagram for com.arcle.rmt.superwaba.model.DocumentManager:

com.arcle.rmt.superwaba.model.DocumentFactory com.arcle.rmt.superwaba.model.imp.DocumentManagerImpl List of all members.

Public Member Functions

abstract Document loadDocument (String name)
 Loads a document.

abstract void saveDocument (String name, Document doc)
 Saves a document.

abstract String[] listDocuments ()
 Returns the names of all available documents in the device.

abstract boolean deleteDocument (String name)
 Deletes a document.


Static Public Member Functions

final DocumentManager getInstance ()
 Returns an implementor instance.


Static Public Attributes

final String DOCUMENT_TYPE = "SRSD"
 The PalmOS document type for catalogs managed by this class.

final String CREATOR_ID = "RaMT"
 The default PalmOS creatorID for catalogs managed by this class.


Protected Member Functions

 DocumentManager ()
 This is a singleton class, don't construct the object directly, use getInstance() instead.


Static Private Attributes

DocumentManager _instance = null
 The singleton instance.


Detailed Description

The DocumentManager singleton provides means to access documents in the device.

Author:
Sasmito Adibowo
Since:
10-04-03 18:47
Version:
Id
DocumentManager.java,v 1.9 2003/05/15 19:43:58 adib Exp

Definition at line 82 of file DocumentManager.java.


Constructor & Destructor Documentation

com.arcle.rmt.superwaba.model.DocumentManager.DocumentManager  )  [protected]
 

This is a singleton class, don't construct the object directly, use getInstance() instead.

Definition at line 98 of file DocumentManager.java.


Member Function Documentation

abstract boolean com.arcle.rmt.superwaba.model.DocumentManager.deleteDocument String  name  )  [pure virtual]
 

Deletes a document.

Parameters:
name the document's catalog name.

Implemented in com.arcle.rmt.superwaba.model.imp.DocumentManagerImpl.

final DocumentManager com.arcle.rmt.superwaba.model.DocumentManager.getInstance  )  [static]
 

Returns an implementor instance.

Definition at line 87 of file DocumentManager.java.

References com.arcle.rmt.superwaba.model.DocumentManager._instance.

abstract String [] com.arcle.rmt.superwaba.model.DocumentManager.listDocuments  )  [pure virtual]
 

Returns the names of all available documents in the device.

Implemented in com.arcle.rmt.superwaba.model.imp.DocumentManagerImpl.

Referenced by com.arcle.rmt.superwaba.vc.DocumentList.modelUpdated().

abstract Document com.arcle.rmt.superwaba.model.DocumentManager.loadDocument String  name  )  [pure virtual]
 

Loads a document.

Parameters:
name the name of the document to load.
Returns:
the loaded document.
See also:
listDocuments()

Implemented in com.arcle.rmt.superwaba.model.imp.DocumentManagerImpl.

Referenced by com.arcle.rmt.j2se.bridge.BridgeFacade.openSuperwabaDocument().

abstract void com.arcle.rmt.superwaba.model.DocumentManager.saveDocument String  name,
Document  doc
[pure virtual]
 

Saves a document.

Parameters:
name the name given to the document.
doc the document to save.
See also:
listDocuments()

Implemented in com.arcle.rmt.superwaba.model.imp.DocumentManagerImpl.


Member Data Documentation

DocumentManager com.arcle.rmt.superwaba.model.DocumentManager._instance = null [static, private]
 

The singleton instance.

Definition at line 132 of file DocumentManager.java.

Referenced by com.arcle.rmt.superwaba.model.DocumentManager.getInstance().

final String com.arcle.rmt.superwaba.model.DocumentManager.CREATOR_ID = "RaMT" [static]
 

The default PalmOS creatorID for catalogs managed by this class.

Definition at line 143 of file DocumentManager.java.

final String com.arcle.rmt.superwaba.model.DocumentManager.DOCUMENT_TYPE = "SRSD" [static]
 

The PalmOS document type for catalogs managed by this class.

Must be a four-character string.

Definition at line 138 of file DocumentManager.java.


The documentation for this class was generated from the following file:
Generated on Fri Jun 18 19:55:02 2004 for Arcle Rambutan by doxygen 1.3.5