anl.aida.client.doc
Interface DocumentsModel

All Known Implementing Classes:
AbstractDocumentsModel, DefaultDocumentsModel, SubsetDocumentsModel, WrappedDocumentsModel

public interface DocumentsModel

Interface for classes that encapsulate some set of documents that can be displayed in document view.


Field Summary
static DocSetID NO_ID
           
 
Method Summary
 DocSets createDocumentSets(int setSize)
          Creates a DocSets with each set of the specified size.
 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.
 org.apache.lucene.search.Filter getSearchFilter()
          Gets a lucene filter appropriate for filtering a lucene search.
 void setDescription(java.lang.String description)
          Sets the description of the documents contained by this model.
 

Field Detail

NO_ID

static final DocSetID NO_ID
Method Detail

getID

DocSetID getID()
Gets the DocumentSetID for this model. This will return NO_ID if this model s not associated with a DocumentSet.

Returns:
the DocumentSetID for this model, or NO_ID if this model is not associated with a DocumentSet.

setDescription

void setDescription(java.lang.String description)
Sets the description of the documents contained by this model.

Parameters:
description - the description

getDescription

java.lang.String getDescription()
Gets the description of the documents contained by this model.

Returns:
the description of the documents contained by this model.

getKeywords

java.lang.String[] getKeywords(java.lang.String docPath)
Gets keywords for the document with the specified path.

Parameters:
docPath - the path of the document to get keywords for
Returns:
keywords for the document with the specified path.

createDocumentSets

DocSets createDocumentSets(int setSize)
Creates a DocSets with each set of the specified size.

Parameters:
setSize - the set size.
Returns:
the created DocSets.

getSearchFilter

org.apache.lucene.search.Filter getSearchFilter()
Gets a lucene filter appropriate for filtering a lucene search. If no filtering is required then this should return null.

Returns:
the appropriate filter, or null if no filter is required.