anl.aida.client.doc
Class SubsetDocumentsModel

java.lang.Object
  extended by anl.aida.client.doc.AbstractDocumentsModel
      extended by anl.aida.client.doc.SubsetDocumentsModel
All Implemented Interfaces:
DocumentsModel

public class SubsetDocumentsModel
extends AbstractDocumentsModel

Model class for the DocumentsView that contains some subset of documents.


Nested Class Summary
(package private)  class SubsetDocumentsModel.DocIterator
           
(package private)  class SubsetDocumentsModel.DocSetsImpl
           
 
Field Summary
private  java.util.List<anl.aida.core.DocumentID> docs
           
 
Fields inherited from class anl.aida.client.doc.AbstractDocumentsModel
center, element, id, keyGen, range
 
Fields inherited from interface anl.aida.client.doc.DocumentsModel
NO_ID
 
Constructor Summary
SubsetDocumentsModel(DocSetID id, CacheElement element, java.util.List<anl.aida.core.DocumentID> docs)
           
 
Method Summary
 DocSets createDocumentSets(int setSize)
          Creates a DocSets with each set of the specified size.
 org.apache.lucene.search.Filter getSearchFilter()
          Gets a lucene filter that filters out documents not contained in this subset of documents and docs whose timestamp is greater than this models cache element timestamp.
 
Methods inherited from class anl.aida.client.doc.AbstractDocumentsModel
getDescription, getID, getKeywords, setDescription
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

docs

private java.util.List<anl.aida.core.DocumentID> docs
Constructor Detail

SubsetDocumentsModel

public SubsetDocumentsModel(DocSetID id,
                            CacheElement element,
                            java.util.List<anl.aida.core.DocumentID> docs)
Method Detail

getSearchFilter

public org.apache.lucene.search.Filter getSearchFilter()
Gets a lucene filter that filters out documents not contained in this subset of documents and docs whose timestamp is greater than this models cache element timestamp.

Returns:
a lucene filter that filters out documents not contained in this subset of documents and docs whose timestamp is greater than this models cache element timestamp.

createDocumentSets

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

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