anl.aida.client
Interface CacheDocumentSet

All Known Implementing Classes:
CacheElement.AllDocs, TempCacheDocSet, WrappedDocSet

public interface CacheDocumentSet


Method Summary
 java.lang.Iterable<anl.aida.core.DocumentID> documents()
          Gets the document ids of all the docs this set contains.
 Clusterer<anl.aida.core.DocumentID> getClusterer()
          Gets the Clusterer that should be used to Cluster this document set.
 int getDocumentCount()
          Gets the number of documents in this CacheDocumentSet.
 DocumentsModel getDocumentsModel()
          Gets a DocumentsModel for the documents in this CacheDocumentSet.
 DocSetID getId()
          Gets the id of this document set.
 anl.aida.core.KeywordGenerator getKeyWordGenerator()
          Gets a keyword generator that can be used to generate keywords for this doc set.
 java.lang.String getLabel()
          Gets a descriptive label for this CacheDocumentSet.
 CacheElement getParent()
          Gets the CacheElement that is the parent of this CacheDocumentSet.
 anl.aida.core.ScoredTermsCollection getSTC()
          Gets the ScoredTermsCollection associated with this CacheDocumentSet.
 int getTermCount()
          Gets the number of terms in this CacheDocumentSet.
 java.lang.String getTimeStampAsString()
          Gets the timestamp of this CacheDocumentSet.
 

Method Detail

getLabel

java.lang.String getLabel()
Gets a descriptive label for this CacheDocumentSet.

Returns:
a descriptive label for this CacheDocumentSet.

getId

DocSetID getId()
Gets the id of this document set.

Returns:
the id of this document set.

getClusterer

Clusterer<anl.aida.core.DocumentID> getClusterer()
Gets the Clusterer that should be used to Cluster this document set.

Returns:
the Clusterer that should be used to Cluster this document set.

getDocumentCount

int getDocumentCount()
Gets the number of documents in this CacheDocumentSet.

Returns:
the number of documents in this CacheDocumentSet.

getTermCount

int getTermCount()
Gets the number of terms in this CacheDocumentSet.

Returns:
the number of terms in this CacheDocumentSet.

getTimeStampAsString

java.lang.String getTimeStampAsString()
Gets the timestamp of this CacheDocumentSet.

Returns:
the timestamp of this CacheDocumentSet.

documents

java.lang.Iterable<anl.aida.core.DocumentID> documents()
Gets the document ids of all the docs this set contains.

Returns:
the document ids of all the docs this set contains.

getKeyWordGenerator

anl.aida.core.KeywordGenerator getKeyWordGenerator()
Gets a keyword generator that can be used to generate keywords for this doc set.

Returns:
a keyword generator that can be used to generate keywords for this doc set.

getSTC

anl.aida.core.ScoredTermsCollection getSTC()
Gets the ScoredTermsCollection associated with this CacheDocumentSet.

Returns:
the ScoredTermsCollection associated with this CacheDocumentSet.

getDocumentsModel

DocumentsModel getDocumentsModel()
Gets a DocumentsModel for the documents in this CacheDocumentSet.

Returns:
a DocumentsModel for the documents in this CacheDocumentSet.

getParent

CacheElement getParent()
Gets the CacheElement that is the parent of this CacheDocumentSet.

Returns:
the CacheElement that is the parent of this CacheDocumentSet.