eu.europeana.corelib.definitions.solr.model

Class Query

java.lang.Object

eu.europeana.corelib.definitions.solr.model.Query

All Implemented Interfaces:

Cloneable

public class Query
extends Object
implements Cloneable

Author:

Willem-Jan Boogerd

Constructor Summary

Constructors

Constructor and Description
Query(String query) CONSTRUCTORS

Method Summary

Modifier and Type	Method and Description
Query	addFacetQuery(QueryFacet queryFacet)
Query	addRefinement(String refinement)
Query	addSolrFacets(List<String> solrFacets)
boolean	areFacetsAllowed()
Query	clone()
static String	concatenateQueryTranslations(List<LanguageVersion> languageVersions)
Query	convertAndSetSolrParameters(Map<String,Integer> parameters)
void	divideRefinements()
boolean	doProduceFacetUnion()
String	getCurrentCursorMark()
String	getExecutedQuery()
List<String>	getFacetsUsedInRefinements()
int	getPageSize()
Map<String,String>	getParameterMap()
String	getQuery() GETTERS & SETTERS
String	getQuery(boolean withTranslations)
List<String>	getQueryFacets()
QueryTranslation	getQueryTranslation()
String	getQueryType()
String[]	getRefinements()
String[]	getRefinements(boolean useDividedRefinements)
List<String>	getSolrFacets()
List<QuerySort>	getSorts()
Integer	getStart()
Map<String,Integer>	getTechnicalFacetLimits() Retrieves technical facet limit
Map<String,Integer>	getTechnicalFacetOffsets() Retrieves technical facet offsets
List<String>	getTechnicalFacets()
boolean	hasParameter(String key)
boolean	isApiQuery()
boolean	isDefaultFacetsRequested()
boolean	isSpellcheckAllowed()
void	removeSolrFacet(SolrFacetType facetToRemove)
void	removeSolrFacet(String facetToRemove)
Query	setApiQuery(boolean apiQuery)
Query	setCurrentCursorMark(String currentCursorMark)
Query	setDefaultFacetsRequested(boolean defaultFacetsRequested)
Query	setDefaultSolrFacets()
Query	setDefaultTechnicalFacets()
void	setExecutedQuery(String executedQuery)
Query	setFacetsAllowed(boolean allowFacets) Checks if there are any technical facets requested.
Query	setPageSize(int pageSize)
Query	setParameter(String key, String value) Adds Solr parameterMap to the Query object
Query	setParameters(Map<String,String> parameters) Adds Solr parameterMap to the Query object
Query	setProduceFacetUnion(boolean produceFacetUnion)
Query	setQuery(String query)
Query	setQueryFacets(List<QueryFacet> queryFacets)
Query	setQueryTranslation(QueryTranslation queryTranslation)
void	setQueryType(String queryType)
Query	setRefinements(String... refinementArray)
void	setSolrFacet(String facet)
Query	setSolrFacets(List<String> solrFacets)
Query	setSolrFacets(String... solrFacets)
Query	setSort(String sort) Generate a new list of user-defined sort fields, based on the sort= parameter specified by the user Sort fields may be separated by a plus, comma, or space character
Query	setSpellcheckAllowed(boolean allowSpellcheck)
Query	setStart(int start)
Query	setTechnicalFacetLimits(Map<String,Integer> technicalFacetLimitMap) Adds technical facet limits to the Query object
Query	setTechnicalFacetOffsets(Map<String,Integer> technicalFacetOffsetMap) Adds technical facet offsets to the Query object
Query	setTechnicalFacets(List<String> technicalFacets)
Query	setTechnicalFacets(String... technicalFacets)
Query	setValueReplacements(Map<String,String> valueReplacementMap)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(String query)

CONSTRUCTORS

Method Detail

getQuery

public String getQuery()

GETTERS & SETTERS

getQuery

public String getQuery(boolean withTranslations)

setQuery

public Query setQuery(String query)

getRefinements

public String[] getRefinements()

getRefinements

public String[] getRefinements(boolean useDividedRefinements)

getFacetsUsedInRefinements

public List<String> getFacetsUsedInRefinements()

setRefinements

public Query setRefinements(String... refinementArray)

getCurrentCursorMark

public String getCurrentCursorMark()

setCurrentCursorMark

public Query setCurrentCursorMark(String currentCursorMark)

addRefinement

public Query addRefinement(String refinement)

setValueReplacements

public Query setValueReplacements(Map<String,String> valueReplacementMap)

setQueryTranslation

public Query setQueryTranslation(QueryTranslation queryTranslation)

getQueryTranslation

public QueryTranslation getQueryTranslation()

addFacetQuery

public Query addFacetQuery(QueryFacet queryFacet)

setQueryFacets

public Query setQueryFacets(List<QueryFacet> queryFacets)

getQueryFacets

public List<String> getQueryFacets()

getStart

public Integer getStart()

setStart

public Query setStart(int start)

getSorts

public List<QuerySort> getSorts()

Returns:

list of all user-defined sort fields

setSort

public Query setSort(String sort)

Generate a new list of user-defined sort fields, based on the sort= parameter specified by the user Sort fields may be separated by a plus, comma, or space character

Parameters:

sort - string containing user-defined sorting fields and sort order, if null or empty it will reset the current user sort for this query.

Returns:

this query object

getPageSize

public int getPageSize()

setPageSize

public Query setPageSize(int pageSize)

getSolrFacets

public List<String> getSolrFacets()

setDefaultSolrFacets

public Query setDefaultSolrFacets()

setSolrFacets

public Query setSolrFacets(String... solrFacets)

setSolrFacets

public Query setSolrFacets(List<String> solrFacets)

addSolrFacets

public Query addSolrFacets(List<String> solrFacets)

removeSolrFacet

public void removeSolrFacet(SolrFacetType facetToRemove)

removeSolrFacet

public void removeSolrFacet(String facetToRemove)

setSolrFacet

public void setSolrFacet(String facet)

setDefaultTechnicalFacets

public Query setDefaultTechnicalFacets()

setTechnicalFacets

public Query setTechnicalFacets(String... technicalFacets)

setTechnicalFacets

public Query setTechnicalFacets(List<String> technicalFacets)

getTechnicalFacets

public List<String> getTechnicalFacets()

areFacetsAllowed

public boolean areFacetsAllowed()

setFacetsAllowed

public Query setFacetsAllowed(boolean allowFacets)

Checks if there are any technical facets requested. If so, add FACET_TAGS to the list of Solr Facets, if not already in there, because the technical facet values are contained therein

Parameters:

allowFacets - boolean

Returns:

the Query object

setProduceFacetUnion

public Query setProduceFacetUnion(boolean produceFacetUnion)

isDefaultFacetsRequested

public boolean isDefaultFacetsRequested()

setDefaultFacetsRequested

public Query setDefaultFacetsRequested(boolean defaultFacetsRequested)

isApiQuery

public boolean isApiQuery()

setApiQuery

public Query setApiQuery(boolean apiQuery)

getParameterMap

public Map<String,String> getParameterMap()

hasParameter

public boolean hasParameter(String key)

setParameter

public Query setParameter(String key,
                          String value)

Adds Solr parameterMap to the Query object

Parameters:

key - The parameter name

value - The value of the parameter

Returns:

The Query object

setParameters

public Query setParameters(Map<String,String> parameters)

Adds Solr parameterMap to the Query object

Parameters:

parameters - Map containing parameter key-value pairs to be added

Returns:

The Query object

convertAndSetSolrParameters

public Query convertAndSetSolrParameters(Map<String,Integer> parameters)

setTechnicalFacetOffsets

public Query setTechnicalFacetOffsets(Map<String,Integer> technicalFacetOffsetMap)

Adds technical facet offsets to the Query object

Parameters:

technicalFacetOffsetMap - Map of String, Integer containing technical facet names + offsets

Returns:

The Query object

getTechnicalFacetOffsets

public Map<String,Integer> getTechnicalFacetOffsets()

Retrieves technical facet offsets

Returns:

Map of String, Integer containing technical facet names + offsets

setTechnicalFacetLimits

public Query setTechnicalFacetLimits(Map<String,Integer> technicalFacetLimitMap)

Adds technical facet limits to the Query object

Parameters:

technicalFacetLimitMap - Map of String, Integer containing technical facet names + limits

Returns:

The Query object

getTechnicalFacetLimits

public Map<String,Integer> getTechnicalFacetLimits()

Retrieves technical facet limit

Returns:

Map of String, Integer containing technical facet names + limits

clone

public Query clone()
            throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Overrides:

toString in class Object

getQueryType

public String getQueryType()

setQueryType

public void setQueryType(String queryType)

doProduceFacetUnion

public boolean doProduceFacetUnion()

isSpellcheckAllowed

public boolean isSpellcheckAllowed()

setSpellcheckAllowed

public Query setSpellcheckAllowed(boolean allowSpellcheck)

getExecutedQuery

public String getExecutedQuery()

setExecutedQuery

public void setExecutedQuery(String executedQuery)

divideRefinements

public void divideRefinements()

concatenateQueryTranslations

public static String concatenateQueryTranslations(List<LanguageVersion> languageVersions)