anl.aida.client.doc
Class WrappedDocumentsModel

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

public class WrappedDocumentsModel
extends java.lang.Object
implements DocumentsModel

Delegates DocumentsModel to a wrapped DocumentsModel but replaced the DocSetID.


Field Summary
private  DocSetID id
           
private  DocumentsModel model
           
 
Fields inherited from interface anl.aida.client.doc.DocumentsModel
NO_ID
 
Constructor Summary
WrappedDocumentsModel(DocSetID id, DocumentsModel model)
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

model

private DocumentsModel model

id

private DocSetID id
Constructor Detail

WrappedDocumentsModel

public WrappedDocumentsModel(DocSetID id,
                             DocumentsModel model)
Method Detail

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.

createDocumentSets

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

Specified by:
createDocumentSets in interface DocumentsModel
Parameters:
setSize - the set size.
Returns:
the created DocSets.

getSearchFilter

public 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.

Specified by:
getSearchFilter in interface DocumentsModel
Returns:
the appropriate filter, or null if no filter is required.