Package org.dspace.discovery

Interface IndexingService

All Known Implementing Classes:

SolrServiceImpl

public interface IndexingService

Interface used for indexing IndexableObject into discovery

Author:

Kevin Van de Velde (kevin at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Method Summary

Modifier and Type	Method	Description
void	atomicUpdate(Context context, String uniqueIndexId, String field, Map<String,Object> fieldModifier)	Atomically update the index of a single field for an object
void	buildSpellCheck()
void	cleanIndex()
void	commit()
void	createIndex(Context context)
void	deleteIndex()
void	indexContent(Context context, IndexableObject dso)
void	indexContent(Context context, IndexableObject dso, boolean force)
void	indexContent(Context context, IndexableObject dso, boolean force, boolean commit)
void	indexContent(Context context, IndexableObject dso, boolean force, boolean commit, boolean preDb)	Index a given DSO
void	optimize()
void	reIndexContent(Context context, IndexableObject dso)
void	unIndexContent(Context context, String uniqueSearchID)
void	unIndexContent(Context context, String uniqueSearchID, boolean commit)
void	unIndexContent(Context context, IndexableObject dso)
void	unIndexContent(Context context, IndexableObject dso, boolean commit)
void	updateIndex(Context context)
void	updateIndex(Context context, boolean force)
void	updateIndex(Context context, boolean force, String type)

Method Detail

indexContent

void indexContent(Context context,
                  IndexableObject dso)
           throws SQLException

Throws:

SQLException

indexContent

void indexContent(Context context,
                  IndexableObject dso,
                  boolean force)
           throws SQLException

Throws:

SQLException

indexContent

void indexContent(Context context,
                  IndexableObject dso,
                  boolean force,
                  boolean commit)
           throws SQLException,
                  SearchServiceException

Throws:

SQLException

SearchServiceException

indexContent

void indexContent(Context context,
                  IndexableObject dso,
                  boolean force,
                  boolean commit,
                  boolean preDb)
           throws SQLException,
                  SearchServiceException

Index a given DSO

Parameters:

context - The DSpace Context

dso - The DSpace Object to index

force - Force update even if not stale

commit - Commit the changes

preDb - Add a "preDB" status to the index (only applicable to Items)

Throws:

SQLException

SearchServiceException

unIndexContent

void unIndexContent(Context context,
                    IndexableObject dso)
             throws SQLException,
                    IOException

Throws:

SQLException

IOException

unIndexContent

void unIndexContent(Context context,
                    IndexableObject dso,
                    boolean commit)
             throws SQLException,
                    IOException

Throws:

SQLException

IOException

unIndexContent

void unIndexContent(Context context,
                    String uniqueSearchID)
             throws IOException

Throws:

IOException

unIndexContent

void unIndexContent(Context context,
                    String uniqueSearchID,
                    boolean commit)
             throws IOException

Throws:

IOException

reIndexContent

void reIndexContent(Context context,
                    IndexableObject dso)
             throws SQLException,
                    IOException

Throws:

SQLException

IOException

createIndex

void createIndex(Context context)
          throws SQLException,
                 IOException

Throws:

SQLException

IOException

updateIndex

void updateIndex(Context context)

updateIndex

void updateIndex(Context context,
                 boolean force)

updateIndex

void updateIndex(Context context,
                 boolean force,
                 String type)

cleanIndex

void cleanIndex()
         throws IOException,
                SQLException,
                SearchServiceException

Throws:

IOException

SQLException

SearchServiceException

deleteIndex

void deleteIndex()

commit

void commit()
     throws SearchServiceException

Throws:

SearchServiceException

optimize

void optimize()
       throws SearchServiceException

Throws:

SearchServiceException

buildSpellCheck

void buildSpellCheck()
              throws SearchServiceException,
                     IOException

Throws:

SearchServiceException

IOException

atomicUpdate

void atomicUpdate(Context context,
                  String uniqueIndexId,
                  String field,
                  Map<String,Object> fieldModifier)
           throws org.apache.solr.client.solrj.SolrServerException,
                  IOException

Atomically update the index of a single field for an object

Parameters:

context - The DSpace context

uniqueIndexId - The unqiue index ID of the object to update the index for

field - The field to update

fieldModifier - The modifiers for the field to update. More information on how to atomically update a solr field using a field modifier can be found here: https://yonik.com/solr/atomic-updates/

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException