Package org.dspace.app.suggestion

Class SolrSuggestionStorageServiceImpl

java.lang.Object

org.dspace.app.suggestion.SolrSuggestionStorageServiceImpl

All Implemented Interfaces:

SolrSuggestionStorageService

public class SolrSuggestionStorageServiceImpl
extends Object
implements SolrSuggestionStorageService

Service to deal with the local suggestion solr core used by the SolrSuggestionProvider(s)

Author:

Andrea Bollini (andrea.bollini at 4science dot it)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.solr.client.solrj.SolrClient	solrSuggestionClient

Fields inherited from interface org.dspace.app.suggestion.SolrSuggestionStorageService

ABSTRACT, CATEGORY, CONTRIBUTORS, DATE, DISPLAY, EVIDENCES, EXTERNAL_URI, PROCESSED, SCORE, SOURCE, SUGGESTION_FULLID, SUGGESTION_ID, TARGET_ID, TITLE

Constructor Summary

Constructors

Constructor	Description
SolrSuggestionStorageServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addSuggestion(Suggestion suggestion, boolean force, boolean commit)	Add a new suggestion to SOLR
void	commit()	Performs an explicit commit, causing pending documents to be committed for indexing.
long	countAllTargets(Context context, String source)	Count all the targets related to the given source.
long	countUnprocessedSuggestionByTarget(Context context, String source, UUID target)	Count all the unprocessed suggestions related to the given source and target.
void	deleteSuggestion(Suggestion suggestion)	Delete a suggestion from SOLR if any
void	deleteTarget(SuggestionTarget target)	Delete all the suggestions from SOLR if any related to a specific target
boolean	exist(Suggestion suggestion)	Return true if the suggestion is already in SOLR and flagged as processed
List<SuggestionTarget>	findAllTargets(Context context, String source, int pageSize, long offset)	Find all the suggestion targets related to the given source.
List<Suggestion>	findAllUnprocessedSuggestions(Context context, String source, UUID target, int pageSize, long offset, boolean ascending)	Find all the unprocessed suggestions related to the given source and target.
SuggestionTarget	findTarget(Context context, String source, UUID target)	Find a suggestion target by the given source and target.
Suggestion	findUnprocessedSuggestion(Context context, String source, UUID target, String id)	Find an unprocessed suggestion by the given source, target id and suggestion id.
void	flagAllSuggestionAsProcessed(String source, String idPart)	Flag all the suggestion related to the given source and id as processed.
void	flagSuggestionAsProcessed(Suggestion suggestion)	Flag a suggestion as processed in SOLR if any
protected org.apache.solr.client.solrj.SolrClient	getSolr()	Get solr client which use suggestion core

Methods inherited from class java.lang.Object

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

Field Details

solrSuggestionClient

protected org.apache.solr.client.solrj.SolrClient solrSuggestionClient

Constructor Details

SolrSuggestionStorageServiceImpl

public SolrSuggestionStorageServiceImpl()

Method Details

getSolr

protected org.apache.solr.client.solrj.SolrClient getSolr()

Get solr client which use suggestion core

Returns:

solr client

addSuggestion

public void addSuggestion(Suggestion suggestion,
 boolean force,
 boolean commit)
                   throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Add a new suggestion to SOLR

Specified by:

addSuggestion in interface SolrSuggestionStorageService

force - true if the suggestion must be reindexed

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

commit

public void commit()
            throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Performs an explicit commit, causing pending documents to be committed for indexing.

Specified by:

commit in interface SolrSuggestionStorageService

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

exist

public boolean exist(Suggestion suggestion)
              throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Return true if the suggestion is already in SOLR and flagged as processed

Specified by:

exist in interface SolrSuggestionStorageService

Returns:

true if the suggestion is already in SOLR and flagged as processed

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

deleteSuggestion

public void deleteSuggestion(Suggestion suggestion)
                      throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Delete a suggestion from SOLR if any

Specified by:

deleteSuggestion in interface SolrSuggestionStorageService

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

flagSuggestionAsProcessed

public void flagSuggestionAsProcessed(Suggestion suggestion)
                               throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Flag a suggestion as processed in SOLR if any

Specified by:

flagSuggestionAsProcessed in interface SolrSuggestionStorageService

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

flagAllSuggestionAsProcessed

public void flagAllSuggestionAsProcessed(String source,
 String idPart)
                                  throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Flag all the suggestion related to the given source and id as processed.

Specified by:

flagAllSuggestionAsProcessed in interface SolrSuggestionStorageService

Parameters:

source - the source name

idPart - the id's last part

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

deleteTarget

public void deleteTarget(SuggestionTarget target)
                  throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Delete all the suggestions from SOLR if any related to a specific target

Specified by:

deleteTarget in interface SolrSuggestionStorageService

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

countAllTargets

public long countAllTargets(Context context,
 String source)
                     throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Count all the targets related to the given source.

Specified by:

countAllTargets in interface SolrSuggestionStorageService

source - the source name

Returns:

the target's count

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

countUnprocessedSuggestionByTarget

public long countUnprocessedSuggestionByTarget(Context context,
 String source,
 UUID target)
                                        throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Count all the unprocessed suggestions related to the given source and target.

Specified by:

countUnprocessedSuggestionByTarget in interface SolrSuggestionStorageService

Parameters:

context - the DSpace Context

source - the source name

target - the target id

Returns:

the suggestion count

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

findAllUnprocessedSuggestions

public List<Suggestion> findAllUnprocessedSuggestions(Context context,
 String source,
 UUID target,
 int pageSize,
 long offset,
 boolean ascending)
                                               throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Find all the unprocessed suggestions related to the given source and target.

Specified by:

findAllUnprocessedSuggestions in interface SolrSuggestionStorageService

Parameters:

context - the DSpace Context

source - the source name

target - the target id

pageSize - the page size

offset - the page offset

ascending - true to retrieve the suggestions ordered by score ascending

Returns:

the found suggestions

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

findAllTargets

public List<SuggestionTarget> findAllTargets(Context context,
 String source,
 int pageSize,
 long offset)
                                      throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Find all the suggestion targets related to the given source.

Specified by:

findAllTargets in interface SolrSuggestionStorageService

Parameters:

context - the DSpace Context

source - the source name

pageSize - the page size

offset - the page offset

Returns:

the found suggestion targets

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

findUnprocessedSuggestion

public Suggestion findUnprocessedSuggestion(Context context,
 String source,
 UUID target,
 String id)
                                     throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Find an unprocessed suggestion by the given source, target id and suggestion id.

Specified by:

findUnprocessedSuggestion in interface SolrSuggestionStorageService

Parameters:

context - the DSpace Context

source - the source name

target - the target id

id - the suggestion id

Returns:

the suggestion, if any

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

findTarget

public SuggestionTarget findTarget(Context context,
 String source,
 UUID target)
                            throws org.apache.solr.client.solrj.SolrServerException,
IOException

Description copied from interface: SolrSuggestionStorageService

Find a suggestion target by the given source and target.

Specified by:

findTarget in interface SolrSuggestionStorageService

Parameters:

context - the DSpace Context

source - the source name

target - the target id

Returns:

the suggestion target, if any

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException