Package io.goobi.viewer.controller

Class IndexerTools

java.lang.Object

io.goobi.viewer.controller.IndexerTools

public final class IndexerTools
extends Object

Utility class for Solr indexer interactions (indexing, deleting, etc.).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUFFIX_ALTO_CROWDSOURCING	Constant SUFFIX_ALTO_CROWDSOURCING="_altocrowd"
static final String	SUFFIX_CMS	Constant SUFFIX_CMS="_cms"
static final String	SUFFIX_FULLTEXT_CROWDSOURCING	Constant SUFFIX_FULLTEXT_CROWDSOURCING="_txtcrowd"
static final String	SUFFIX_USER_GENERATED_CONTENT	Constant SUFFIX_USER_GENERATED_CONTENT="_ugc"

Method Summary

Modifier and Type	Method	Description
static boolean	deleteRecord(String pi, boolean createTraceDocument, Path hotfolderPath)	deleteRecord.
static boolean	reIndexCMSPage(CMSPage page, Collection<? extends IndexAugmenter> augmenters)
static boolean	reIndexPage(String pi, int page)	reIndexPage.
static boolean	reIndexPage(String pi, int page, Collection<? extends IndexAugmenter> augmenters)	reIndexPage.
static boolean	reIndexRecord(String pi)	Writes the record into the hotfolder for re-indexing.
static boolean	reIndexRecord(String pi, Collection<? extends IndexAugmenter> augmenters)	Writes the record into the hotfolder for re-indexing.
static void	triggerReIndexCMSPage(CMSPage page, List<? extends IndexAugmenter> augmenters)
static void	triggerReIndexRecord(String pi)	Re-index in background thread to significantly decrease saving times.
static void	triggerReIndexRecord(String pi, List<? extends IndexAugmenter> augmenters)

Methods inherited from class java.lang.Object

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

Field Details

SUFFIX_FULLTEXT_CROWDSOURCING

public static final String SUFFIX_FULLTEXT_CROWDSOURCING

Constant SUFFIX_FULLTEXT_CROWDSOURCING="_txtcrowd"

See Also:

• Constant Field Values

SUFFIX_ALTO_CROWDSOURCING

public static final String SUFFIX_ALTO_CROWDSOURCING

Constant SUFFIX_ALTO_CROWDSOURCING="_altocrowd"

See Also:

• Constant Field Values

SUFFIX_USER_GENERATED_CONTENT

public static final String SUFFIX_USER_GENERATED_CONTENT

Constant SUFFIX_USER_GENERATED_CONTENT="_ugc"

See Also:

• Constant Field Values

SUFFIX_CMS

public static final String SUFFIX_CMS

Constant SUFFIX_CMS="_cms"

See Also:

• Constant Field Values

Method Details

triggerReIndexRecord

public static void triggerReIndexRecord(String pi)

Re-index in background thread to significantly decrease saving times.

Parameters:

pi - a String object.

triggerReIndexRecord

public static void triggerReIndexRecord(String pi,
 List<? extends IndexAugmenter> augmenters)

triggerReIndexCMSPage

public static void triggerReIndexCMSPage(CMSPage page,
 List<? extends IndexAugmenter> augmenters)

Parameters:

page -

augmenters -

reIndexRecord

public static boolean reIndexRecord(String pi)
                             throws DAOException,
RecordNotFoundException

Writes the record into the hotfolder for re-indexing. Modules can contribute data for re-indexing. Execution of method can take a while, so if performance is of importance, use triggerReIndexRecord instead.

Parameters:

pi - a String object.

Returns:

a boolean.

Throws:

DAOException - if any.

RecordNotFoundException - if any.

reIndexRecord

public static boolean reIndexRecord(String pi,
 Collection<? extends IndexAugmenter> augmenters)
                             throws DAOException,
RecordNotFoundException

Writes the record into the hotfolder for re-indexing. Modules can contribute data for re-indexing. Execution of method can take a while, so if performance is of importance, use triggerReIndexRecord instead.

Parameters:

pi - a String object.

augmenters -

Returns:

true if export for reindexing successful; false otherwise

Throws:

DAOException - if any.

RecordNotFoundException - if any.

reIndexPage

public static boolean reIndexPage(String pi,
 int page)
                           throws DAOException,
PresentationException,
IndexUnreachableException,
IOException

reIndexPage.

Parameters:

pi - a String object.

page - a int.

Returns:

a boolean.

Throws:

DAOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

IOException - if any.

reIndexPage

public static boolean reIndexPage(String pi,
 int page,
 Collection<? extends IndexAugmenter> augmenters)
                           throws PresentationException,
IndexUnreachableException,
IOException

reIndexPage.

Parameters:

pi - a String object.

page - a int.

augmenters -

Returns:

true if export for reindexing successful; false otherwise

Throws:

DAOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

IOException - if any.

deleteRecord

public static boolean deleteRecord(String pi,
 boolean createTraceDocument,
 Path hotfolderPath)
                            throws IOException

deleteRecord.

Parameters:

pi - a String object.

createTraceDocument - a boolean.

hotfolderPath - a Path object.

Returns:

a boolean.

Throws:

IOException - if any.

reIndexCMSPage

public static boolean reIndexCMSPage(CMSPage page,
 Collection<? extends IndexAugmenter> augmenters)

Parameters:

page -

augmenters -

Returns:

true if export for reindexing successful; false otherwise