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

Interface DocumentModifier

All Known Implementing Classes:

FieldBooster, SelectQueryDocumentModifier, SelectQueryI18nDocumentModifier, ThumbnailImageURL

public interface DocumentModifier

An object that can add to a SearchInputDocument. Implementations must be thread-safe.

Method Summary

Modifier and Type	Method	Description
void	modifyDocument(Individual individual, SearchInputDocument doc)	Use the rules contained within this class to modify this search document, according to the characteristics of this individual.
void	shutdown()	Called to inform the DocumentModifier that the system is shutting down.

Method Detail

modifyDocument

void modifyDocument(Individual individual,
                    SearchInputDocument doc)

Use the rules contained within this class to modify this search document, according to the characteristics of this individual.

Parameters:

individual - The individual that is being indexed. Will not be null.

doc - The document as it stands so far. Will not be null.

shutdown

void shutdown()

Called to inform the DocumentModifier that the system is shutting down.