Package io.goobi.viewer.model.maps

Class SolrFeatureSet

java.lang.Object

io.goobi.viewer.model.maps.FeatureSet

io.goobi.viewer.model.maps.SolrFeatureSet

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SearchResultFeatureSet

@Entity
public class SolrFeatureSet
extends FeatureSet

A FeatureSet implementation that generates geo map features by executing a configurable Solr query and converting the matching documents into GeoJSON features.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	featuresAsString
protected static final int	MAX_RECORD_HITS

Fields inherited from class io.goobi.viewer.model.maps.FeatureSet

DEFAULT_MARKER_NAME

Constructor Summary

Constructors

Constructor	Description
SolrFeatureSet()
SolrFeatureSet(SolrFeatureSet blueprint)

Method Summary

Modifier and Type	Method	Description
protected Collection<GeoMapFeature>	combineFeatures(Collection<GeoMapFeature> singleFeatures)
FeatureSet	copy()
protected Collection<GeoMapFeature>	createFeatures()
protected Collection<GeoMapFeature>	createFeatures(String query, List<String> facetFilterQueries)
protected String	createFeaturesAsString(boolean escapeJson)
String	getCoordinateSearchQueryTemplate()	getCoordinateSearchQueryTemplate.
String	getFacetQueryEncoded()	Additional, URL-encoded Solr filter query to send along with heatmap requests.
String	getFeaturesAsJsonString()
String	getFeaturesAsString()
GeomapItemFilter	getItemFilter()
String	getItemFilterName()
String	getItemMetadataList()
MarkerGenerationType	getMarkerGeneration()
String	getMarkerMetadataList()
String	getMarkerTitleField()
SolrSearchScope	getSearchScope()
String	getSolrQuery()
String	getSolrQuery(boolean aggregateResults)
String	getSolrQueryEncoded()
String	getSolrQueryForSearch()
String	getSolrQueryForSearch(boolean aggregateResults)
String	getSolrQueryForSearchEncoded()
String	getType()
boolean	hasFeatures()
boolean	hasSolrQuery()
boolean	isAggregateResults()
boolean	isQueryResultSet()
boolean	isUseHeatmap()
void	setFeaturesAsString(String featuresAsString)
void	setItemFilterName(String itemFilterName)
void	setItemMetadataList(String itemMetadataList)
void	setMarkerGeneration(MarkerGenerationType markerGeneration)
void	setMarkerMetadataList(String markerMetadataList)
void	setMarkerTitleField(String markerTitleField)
void	setSearchScope(SolrSearchScope searchScope)
void	setSolrQuery(String solrQuery)
void	setUseHeatmap(boolean useHeatmap)
void	updateFeatures()

Methods inherited from class io.goobi.viewer.model.maps.FeatureSet

getColor, getFillOpacity, getId, getMarker, getMarkerAsJSON, getName, setId, setMarker, setName

Methods inherited from class java.lang.Object

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

Field Details

MAX_RECORD_HITS

protected static final int MAX_RECORD_HITS

See Also:

• Constant Field Values

featuresAsString

protected String featuresAsString

Constructor Details

SolrFeatureSet

public SolrFeatureSet()

SolrFeatureSet

public SolrFeatureSet(SolrFeatureSet blueprint)

Method Details

copy

public FeatureSet copy()

Specified by:

copy in class FeatureSet

getFeaturesAsString

public String getFeaturesAsString()
                           throws PresentationException

Specified by:

getFeaturesAsString in class FeatureSet

Throws:

PresentationException

getFeaturesAsJsonString

public String getFeaturesAsJsonString()
                               throws PresentationException

Specified by:

getFeaturesAsJsonString in class FeatureSet

Throws:

PresentationException

setFeaturesAsString

public void setFeaturesAsString(String featuresAsString)

createFeaturesAsString

protected String createFeaturesAsString(boolean escapeJson)
                                 throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

createFeatures

protected Collection<GeoMapFeature> createFeatures()
                                            throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

createFeatures

protected Collection<GeoMapFeature> createFeatures(String query,
 List<String> facetFilterQueries)
                                            throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

combineFeatures

protected Collection<GeoMapFeature> combineFeatures(Collection<GeoMapFeature> singleFeatures)

getSolrQuery

public String getSolrQuery()

getSolrQuery

public String getSolrQuery(boolean aggregateResults)

getSolrQueryForSearchEncoded

public String getSolrQueryForSearchEncoded()

getSolrQueryForSearch

public String getSolrQueryForSearch()

isAggregateResults

public boolean isAggregateResults()

getSolrQueryForSearch

public String getSolrQueryForSearch(boolean aggregateResults)

getSolrQueryEncoded

public String getSolrQueryEncoded()

getFacetQueryEncoded

public String getFacetQueryEncoded()

Additional, URL-encoded Solr filter query to send along with heatmap requests. Plain SolrFeatureSets have no such additional filter; subclasses deriving their features from a live search (e.g. SearchResultFeatureSet) may override this to restrict heatmap results by the currently active search filters.

Returns:

URL-encoded filter query; empty string if none applies

getCoordinateSearchQueryTemplate

public String getCoordinateSearchQueryTemplate()
                                        throws URISyntaxException

getCoordinateSearchQueryTemplate.

Returns:

String

Throws:

URISyntaxException

setSolrQuery

public void setSolrQuery(String solrQuery)

hasSolrQuery

public boolean hasSolrQuery()

getMarkerTitleField

public String getMarkerTitleField()

setMarkerTitleField

public void setMarkerTitleField(String markerTitleField)

updateFeatures

public void updateFeatures()

Specified by:

updateFeatures in class FeatureSet

hasFeatures

public boolean hasFeatures()

Specified by:

hasFeatures in class FeatureSet

getMarkerMetadataList

public String getMarkerMetadataList()

setMarkerMetadataList

public void setMarkerMetadataList(String markerMetadataList)

getItemMetadataList

public String getItemMetadataList()

setItemMetadataList

public void setItemMetadataList(String itemMetadataList)

isQueryResultSet

public boolean isQueryResultSet()

Specified by:

isQueryResultSet in class FeatureSet

getSearchScope

public SolrSearchScope getSearchScope()

setSearchScope

public void setSearchScope(SolrSearchScope searchScope)

getType

public String getType()

Specified by:

getType in class FeatureSet

getItemFilterName

public String getItemFilterName()

setItemFilterName

public void setItemFilterName(String itemFilterName)

getItemFilter

public GeomapItemFilter getItemFilter()

getMarkerGeneration

public MarkerGenerationType getMarkerGeneration()

setMarkerGeneration

public void setMarkerGeneration(MarkerGenerationType markerGeneration)

isUseHeatmap

public boolean isUseHeatmap()

Specified by:

isUseHeatmap in class FeatureSet

setUseHeatmap

public void setUseHeatmap(boolean useHeatmap)

Specified by:

setUseHeatmap in class FeatureSet