This commit is contained in:
deepakkoni 2011-07-22 16:34:20 +00:00
parent cf26240fc4
commit 96e65e96c3

View file

@ -1,59 +1,59 @@
/* $This file is distributed under the terms of the license in /doc/license.txt$ */
package edu.cornell.mannlib.vitro.webapp.search.beans;
package edu.cornell.mannlib.vitro.webapp.search.beans;
import java.util.List;
import edu.cornell.mannlib.vitro.webapp.beans.Individual;
import edu.cornell.mannlib.vitro.webapp.search.IndexingException;
import edu.cornell.mannlib.vitro.webapp.search.docbuilder.Obj2DocIface;
/**
* IntexerIface is for objects that will be used by the IndexBuilder. The
* IndexBuilder will manage getting lists of object to index and then use
* an object that implements IndexerIface to stuff the backend index.
*
* An example is SolrIndexer which is set up and associated with a
* IndexBuilder in SolrSetup.
*
* @author bdc34
*
*/
public interface IndexerIface {
/**
* Check if indexing is currently running.
*/
public boolean isIndexing();
/**
* Index a document. This should do an update of the
* document in the index of the semantics of the index require it.
*
* @param doc
* @param newDoc - if true, just insert doc, if false attempt to update.
* @throws IndexingException
*/
public void index(Individual ind)throws IndexingException;
/**
* Remove a document from the index.
* @param obj
* @throws IndexingException
*/
public void removeFromIndex(String uri) throws IndexingException;
/**
* IntexerIface is for objects that will be used by the IndexBuilder. The
* IndexBuilder will manage getting lists of object to index and then use
* an object that implements IndexerIface to stuff the backend index.
*
* An example is SolrIndexer which is set up and associated with a
* IndexBuilder in SolrSetup.
*
* @author bdc34
*
*/
public interface IndexerIface {
/**
* Check if indexing is currently running.
*/
public boolean isIndexing();
/**
* Index a document. This should do an update of the
* document in the index of the semantics of the index require it.
*
* @param doc
* @param newDoc - if true, just insert doc, if false attempt to update.
* @throws IndexingException
*/
public void index(Individual ind)throws IndexingException;
/**
* Remove a document from the index.
* @param obj
* @throws IndexingException
*/
public void removeFromIndex(String uri) throws IndexingException;
public void prepareForRebuild() throws IndexingException;
public void startIndexing() throws IndexingException;
public void endIndexing();
public void startIndexing() throws IndexingException;
public void endIndexing();
public long getModified();
/**
* Ends the indexing and removes any temporary files.
* This may be called instead of endIndexing()
*/
public void abortIndexingAndCleanUp();
}
public void abortIndexingAndCleanUp();
}