Package io.goobi.viewer.model.annotation.serialization

Class AnnotationIndexAugmenter

java.lang.Object

io.goobi.viewer.model.annotation.serialization.AnnotationIndexAugmenter

All Implemented Interfaces:

IndexAugmenter

public class AnnotationIndexAugmenter
extends Object
implements IndexAugmenter

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUFFIX_ANNOTATIONS	Constant SUFFIX_ANNOTATIONS="_annotations".

Constructor Summary

Constructors

Constructor	Description
AnnotationIndexAugmenter()
AnnotationIndexAugmenter(Collection<PersistentAnnotation> annotations)

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).
boolean	equals(Object obj)	Two instances are equal if they contain the same annotations (disregarding order).
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

SUFFIX_ANNOTATIONS

public static final String SUFFIX_ANNOTATIONS

Constant SUFFIX_ANNOTATIONS="_annotations".

See Also:

• Constant Field Values

Constructor Details

AnnotationIndexAugmenter

public AnnotationIndexAugmenter(Collection<PersistentAnnotation> annotations)

AnnotationIndexAugmenter

public AnnotationIndexAugmenter()

Method Details

augmentReIndexRecord

public void augmentReIndexRecord(String pi,
 String dataRepository,
 String namingScheme)
                          throws IndexAugmenterException

Description copied from interface: IndexAugmenter

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

Specified by:

augmentReIndexRecord in interface IndexAugmenter

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

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

Description copied from interface: IndexAugmenter

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

Specified by:

augmentReIndexPage in interface IndexAugmenter

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Two instances are equal if they contain the same annotations (disregarding order).

Overrides:

equals in class Object

Parameters:

obj - the object to compare with

Returns:

true if the given object is equal to this instance, false otherwise