edu.cornell.mannlib.vitro.webapp.searchindex.documentBuilding.DocumentModifier Maven / Gradle / Ivy
/* $This file is distributed under the terms of the license in LICENSE$ */
package edu.cornell.mannlib.vitro.webapp.searchindex.documentBuilding;
import edu.cornell.mannlib.vitro.webapp.beans.Individual;
import edu.cornell.mannlib.vitro.webapp.modules.searchEngine.SearchInputDocument;
/**
* An object that can add to a SearchInputDocument.
*
* Implementations must be thread-safe.
*/
public interface DocumentModifier {
/**
* Use the rules contained within this class to modify this search document,
* according to the characteristics of this individual.
*
* @param individual
* The individual that is being indexed. Will not be null.
* @param doc
* The document as it stands so far. Will not be null.
*/
public void modifyDocument(Individual individual, SearchInputDocument doc);
/**
* Called to inform the DocumentModifier that the system is shutting down.
*/
public void shutdown();
}