anl.aida.client
Class TempCacheDocSet

java.lang.Object
  extended by anl.aida.client.TempCacheDocSet
All Implemented Interfaces:
CacheDocumentSet

public class TempCacheDocSet
extends java.lang.Object
implements CacheDocumentSet

A temporary cache document set that represents some subset of documents from a CacheElement. DocSetID.isTemporary() will return true for a TempCachDocSet's id.


Field Summary
private  CacheElement element
           
private  DocSetID id
           
private  DocumentsModel model
           
private  java.util.List<anl.aida.core.DocumentID> selectedItems
           
private static int tempID
           
 
Constructor Summary
TempCacheDocSet(CacheElement element, java.util.List<anl.aida.core.DocumentID> selectedItems)
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tempID

private static int tempID

selectedItems

private java.util.List<anl.aida.core.DocumentID> selectedItems

element

private CacheElement element

id

private DocSetID id

model

private DocumentsModel model
Constructor Detail

TempCacheDocSet

public TempCacheDocSet(CacheElement element,
                       java.util.List<anl.aida.core.DocumentID> selectedItems)
Method Detail

getLabel

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

Specified by:
getLabel in interface CacheDocumentSet
Returns:
a descriptive label for this CacheDocumentSet.

getId

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

Specified by:
getId in interface CacheDocumentSet
Returns:
the id of this document set.

getClusterer

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

Specified by:
getClusterer in interface CacheDocumentSet
Returns:
the Clusterer that should be used to Cluster this document set.

getDocumentCount

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

Specified by:
getDocumentCount in interface CacheDocumentSet
Returns:
the number of documents in this CacheDocumentSet.

getTermCount

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

Specified by:
getTermCount in interface CacheDocumentSet
Returns:
the number of terms in this CacheDocumentSet.

getTimeStampAsString

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

Specified by:
getTimeStampAsString in interface CacheDocumentSet
Returns:
the timestamp of this CacheDocumentSet.

getKeyWordGenerator

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

Specified by:
getKeyWordGenerator in interface CacheDocumentSet
Returns:
a keyword generator that can be used to generate keywords for this doc set.

getSTC

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

Specified by:
getSTC in interface CacheDocumentSet
Returns:
the ScoredTermsCollection associated with this CacheDocumentSet.

documents

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

Specified by:
documents in interface CacheDocumentSet
Returns:
the document ids of all the docs this set contains.

getDocumentsModel

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

Specified by:
getDocumentsModel in interface CacheDocumentSet
Returns:
a DocumentsModel for the documents in this CacheDocumentSet.

getParent

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

Specified by:
getParent in interface CacheDocumentSet
Returns:
the CacheElement that is the parent of this CacheDocumentSet.