Package io.goobi.viewer.modules.interfaces

Interface IndexAugmenter

All Known Subinterfaces:

IModule

All Known Implementing Classes:

AnnotationIndexAugmenter

public interface IndexAugmenter

Author:

florian

Method Summary

Modifier and Type	Method	Description
boolean	augmentReIndexPage(String pi, int page, org.apache.solr.common.SolrDocument doc, String dataRepository, String namingScheme)	Any additional tasks this module needs to perform when re-indexing a page (e.g. putting additional files into the hotfolder).
void	augmentReIndexRecord(String pi, String dataRepository, String namingScheme)	Any additional tasks this module needs to perform when re-indexing a record (e.g. putting additional files into the hotfolder).

Method Details

augmentReIndexRecord

void augmentReIndexRecord(String pi,
 String dataRepository,
 String namingScheme)
                   throws Exception

Any additional tasks this module needs to perform when re-indexing a record (e.g. putting additional files into the hotfolder).

Parameters:

pi - a String object.

dataRepository - a String object.

namingScheme - a String object.

Throws:

Exception - if any.

augmentReIndexPage

boolean augmentReIndexPage(String pi,
 int page,
 org.apache.solr.common.SolrDocument doc,
 String dataRepository,
 String namingScheme)
                    throws Exception

Any additional tasks this module needs to perform when re-indexing a page (e.g. putting additional files into the hotfolder).

Parameters:

pi - a String object.

page - a int.

doc - a SolrDocument object.

dataRepository - a String object.

namingScheme - a String object.

Returns:

true if successful; false otherwise

Throws:

Exception - if any.