Package org.dspace.app.suggestion

Class SolrSuggestionProvider

java.lang.Object

org.dspace.app.suggestion.SolrSuggestionProvider

All Implemented Interfaces:

SuggestionProvider

Direct Known Subclasses:

PublicationLoader

public abstract class SolrSuggestionProvider
extends Object
implements SuggestionProvider

Suggestion provider that read the suggestion from the local suggestion solr core

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ItemService	itemService
protected SolrSuggestionStorageService	solrSuggestionStorageService

Constructor Summary

Constructors

Constructor	Description
SolrSuggestionProvider()

Method Summary

Modifier and Type	Method	Description
long	countAllTargets(Context context)	count all suggestion targets
long	countUnprocessedSuggestionByTarget(Context context, UUID target)	find unprocessed suggestions by target UUID
List<SuggestionTarget>	findAllTargets(Context context, int pageSize, long offset)	find all suggestion targets
List<Suggestion>	findAllUnprocessedSuggestions(Context context, UUID target, int pageSize, long offset, boolean ascending)	find unprocessed suggestions (paged) by target UUID
SuggestionTarget	findTarget(Context context, UUID target)	find a suggestion target by UUID
Suggestion	findUnprocessedSuggestion(Context context, UUID target, String id)	find an unprocessed suggestion by target UUID and suggestion id
void	flagRelatedSuggestionsAsProcessed(Context context, ExternalDataObject externalDataObject)	flag a suggestion as processed
String	getSourceName()
abstract void	importRecords(Context context, Item item)	Save a List of ImportRecord into Solr.
protected abstract boolean	isExternalDataObjectPotentiallySuggested(Context context, ExternalDataObject externalDataObject)	check if the externalDataObject may have suggestion
void	rejectSuggestion(Context context, UUID target, String idPart)	reject a specific suggestion by target @param target and by suggestion id @param idPart
void	setItemService(ItemService itemService)
void	setSourceName(String sourceName)

Methods inherited from class java.lang.Object

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

Field Details

itemService

@Autowired
protected ItemService itemService

solrSuggestionStorageService

@Autowired
protected SolrSuggestionStorageService solrSuggestionStorageService

Constructor Details

SolrSuggestionProvider

public SolrSuggestionProvider()

Method Details

getSourceName

public String getSourceName()

setSourceName

public void setSourceName(String sourceName)

setItemService

public void setItemService(ItemService itemService)

countAllTargets

public long countAllTargets(Context context)

Description copied from interface: SuggestionProvider

count all suggestion targets

Specified by:

countAllTargets in interface SuggestionProvider

countUnprocessedSuggestionByTarget

public long countUnprocessedSuggestionByTarget(Context context,
 UUID target)

Description copied from interface: SuggestionProvider

find unprocessed suggestions by target UUID

Specified by:

countUnprocessedSuggestionByTarget in interface SuggestionProvider

findAllUnprocessedSuggestions

public List<Suggestion> findAllUnprocessedSuggestions(Context context,
 UUID target,
 int pageSize,
 long offset,
 boolean ascending)

Description copied from interface: SuggestionProvider

find unprocessed suggestions (paged) by target UUID

Specified by:

findAllUnprocessedSuggestions in interface SuggestionProvider

See Also:

• Suggestion

findAllTargets

public List<SuggestionTarget> findAllTargets(Context context,
 int pageSize,
 long offset)

Description copied from interface: SuggestionProvider

find all suggestion targets

Specified by:

findAllTargets in interface SuggestionProvider

See Also:

• SuggestionTarget

findUnprocessedSuggestion

public Suggestion findUnprocessedSuggestion(Context context,
 UUID target,
 String id)

Description copied from interface: SuggestionProvider

find an unprocessed suggestion by target UUID and suggestion id

Specified by:

findUnprocessedSuggestion in interface SuggestionProvider

findTarget

public SuggestionTarget findTarget(Context context,
 UUID target)

Description copied from interface: SuggestionProvider

find a suggestion target by UUID

Specified by:

findTarget in interface SuggestionProvider

rejectSuggestion

public void rejectSuggestion(Context context,
 UUID target,
 String idPart)

Description copied from interface: SuggestionProvider

reject a specific suggestion by target @param target and by suggestion id @param idPart

Specified by:

rejectSuggestion in interface SuggestionProvider

flagRelatedSuggestionsAsProcessed

public void flagRelatedSuggestionsAsProcessed(Context context,
 ExternalDataObject externalDataObject)

Description copied from interface: SuggestionProvider

flag a suggestion as processed

Specified by:

flagRelatedSuggestionsAsProcessed in interface SuggestionProvider

isExternalDataObjectPotentiallySuggested

protected abstract boolean isExternalDataObjectPotentiallySuggested(Context context,
 ExternalDataObject externalDataObject)

check if the externalDataObject may have suggestion

Parameters:

context -

externalDataObject -

Returns:

true if the externalDataObject could be suggested by this provider (i.e. it comes from a DataProvider used by this suggestor)

importRecords

public abstract void importRecords(Context context,
 Item item)
                            throws Exception

Save a List of ImportRecord into Solr. ImportRecord will be translate into a SolrDocument by the method translateImportRecordToSolrDocument.

Parameters:

context - the DSpace Context

item - a DSpace Item

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

Exception