edu.cornell.mannlib.vitro.webapp.searchindex.documentBuilding

Interface DocumentModifierList

All Known Implementing Classes:

DocumentModifierListBasic, DocumentModifierListDeveloper

public interface DocumentModifierList

An ordered list of DocumentModifier objects, in a handy package. Implementations should make a protective copy of the list of DocumentModifiers. Implementations must be thread-safe. The life-cycle is:

 startIndexing(),
 0 or more modifyDocument() by multiple threads,
 stopIndexing().
 

Method Summary

Modifier and Type	Method and Description
void	modifyDocument(Individual ind, SearchInputDocument doc) Exercise the list of modifiers, making changes to this document based on this individual.
void	startIndexing() Do any required setup on the individual modifiers.
void	stopIndexing() Do any required teardown on the individual modifiers.

Method Detail

startIndexing

void startIndexing()

Do any required setup on the individual modifiers.

stopIndexing

void stopIndexing()

Do any required teardown on the individual modifiers.

modifyDocument

void modifyDocument(Individual ind,
                    SearchInputDocument doc)

Exercise the list of modifiers, making changes to this document based on this individual.