anl.aida.client.doc
Class AbstractDocumentsModel
java.lang.Object
anl.aida.client.doc.AbstractDocumentsModel
- All Implemented Interfaces:
- DocumentsModel
- Direct Known Subclasses:
- DefaultDocumentsModel, SubsetDocumentsModel
public abstract class AbstractDocumentsModel
- extends java.lang.Object
- implements DocumentsModel
Abstract base class for a DocumentsModel.
Method Summary |
java.lang.String |
getDescription()
Gets the description of the documents contained by this model. |
DocSetID |
getID()
Gets the DocumentSetID for this model. |
java.lang.String[] |
getKeywords(java.lang.String docPath)
Gets keywords for the document with the specified path. |
void |
setDescription(java.lang.String description)
Sets the description of the documents contained by this model. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
center
protected static final simphony.util.messages.MessageCenter center
element
protected CacheElement element
keyGen
protected anl.aida.core.KeywordGenerator keyGen
keywordCache
private java.util.Map<java.lang.String,java.lang.String[]> keywordCache
description
private java.lang.String description
id
protected DocSetID id
range
protected anl.aida.util.DateRange range
AbstractDocumentsModel
public AbstractDocumentsModel(DocSetID id,
CacheElement element)
getID
public DocSetID getID()
- Gets the DocumentSetID for this model. This will return
NO_ID if this model s not associated with a DocumentSet.
- Specified by:
getID
in interface DocumentsModel
- Returns:
- the DocumentSetID for this model, or NO_ID if this model
is not associated with a DocumentSet.
setDescription
public void setDescription(java.lang.String description)
- Sets the description of the documents contained by this model.
- Specified by:
setDescription
in interface DocumentsModel
- Parameters:
description
- the description
getDescription
public java.lang.String getDescription()
- Gets the description of the documents contained by this model.
- Specified by:
getDescription
in interface DocumentsModel
- Returns:
- the description of the documents contained by this model.
getKeywords
public java.lang.String[] getKeywords(java.lang.String docPath)
- Gets keywords for the document with the specified path.
- Specified by:
getKeywords
in interface DocumentsModel
- Parameters:
docPath
- the path of the document to get keywords for
- Returns:
- keywords for the document with the specified path.