Package org.dspace.discovery

Class DiscoverResult.IndexableObjectHighlightResult

java.lang.Object

org.dspace.discovery.DiscoverResult.IndexableObjectHighlightResult

Enclosing class:

DiscoverResult

public static final class DiscoverResult.IndexableObjectHighlightResult
extends Object

An utility class to represent the highlighting section of a Discovery Search

Constructor Summary

Constructors

Constructor	Description
IndexableObjectHighlightResult(IndexableObject idxObj, Map<String,List<String>> highlightResults)

Method Summary

Modifier and Type	Method	Description
Map<String,List<String>>	getHighlightResults()	All the matching snippets in whatever metadata ignoring any authority value
List<String>	getHighlightResults(String metadataKey)	The matching snippets for a specific metadata ignoring any authority value
IndexableObject	getIndexableObject()	Return the indexable object that the highlighting snippets refer to

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexableObjectHighlightResult

public IndexableObjectHighlightResult(IndexableObject idxObj,
                                      Map<String,List<String>> highlightResults)

Method Detail

getIndexableObject

public IndexableObject getIndexableObject()

Return the indexable object that the highlighting snippets refer to

Returns:

the indexable object

getHighlightResults

public List<String> getHighlightResults(String metadataKey)

The matching snippets for a specific metadata ignoring any authority value

Parameters:

metadataKey - the metadata where the snippets have been found

Returns:

the matching snippets

getHighlightResults

public Map<String,List<String>> getHighlightResults()

All the matching snippets in whatever metadata ignoring any authority value

Returns:

All the matching snippets