litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Browse source
This commit is contained in:
deepakkoni 2011-07-22 16:34:20 +00:00
parent cf26240fc4
commit 96e65e96c3
1 changed files with 45 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
webapp/src/edu/cornell/mannlib/vitro/webapp/search/beans/IndexerIface.java
View file

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