Package io.goobi.viewer.modules.interfaces

Interface IndexAugmenter

All Known Subinterfaces:

IModule

All Known Implementing Classes:

AnnotationIndexAugmenter

public interface IndexAugmenter

Author:

Florian Alpers

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 IndexAugmenterException

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

Parameters:

pi - persistent identifier of the record to re-index

dataRepository - data repository name containing the record

namingScheme - naming scheme used for hotfolder file names

Throws:

IndexAugmenterException

augmentReIndexPage

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

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

Parameters:

pi - persistent identifier of the record containing the page

page - page order number within the record

doc - Solr document representing the page

dataRepository - data repository name containing the record

namingScheme - naming scheme used for hotfolder file names

Returns:

true if successful; false otherwise

Throws:

IndexAugmenterException