Package org.dspace.app.rest.utils

Class DiscoverQueryBuilder

java.lang.Object

org.dspace.app.rest.utils.DiscoverQueryBuilder

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Component
public class DiscoverQueryBuilder
extends Object
implements org.springframework.beans.factory.InitializingBean

This class builds the queries for the /search and /facet endpoints.

Constructor Summary

Constructors

Constructor	Description
DiscoverQueryBuilder()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
DiscoverQuery	buildFacetQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String prefix, String query, List<SearchFilter> searchFilters, String dsoType, org.springframework.data.domain.Pageable page, String facetName)	Create a discovery facet query.
DiscoverQuery	buildFacetQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String prefix, String query, List<SearchFilter> searchFilters, List<String> dsoTypes, org.springframework.data.domain.Pageable page, String facetName)	Create a discovery facet query.
DiscoverQuery	buildQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String query, List<SearchFilter> searchFilters, String dsoType, org.springframework.data.domain.Pageable page)	Build a discovery query
DiscoverQuery	buildQuery(Context context, IndexableObject scope, DiscoveryConfiguration discoveryConfiguration, String query, List<SearchFilter> searchFilters, List<String> dsoTypes, org.springframework.data.domain.Pageable page)	Build a discovery query
void	setIndexableFactories(List<IndexFactory> indexableFactories)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoverQueryBuilder

public DiscoverQueryBuilder()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

buildQuery

public DiscoverQuery buildQuery(Context context,
                                IndexableObject scope,
                                DiscoveryConfiguration discoveryConfiguration,
                                String query,
                                List<SearchFilter> searchFilters,
                                String dsoType,
                                org.springframework.data.domain.Pageable page)
                         throws DSpaceBadRequestException

Build a discovery query

Parameters:

context - the DSpace context

scope - the scope for this discovery query

discoveryConfiguration - the discovery configuration for this discovery query

query - the query string for this discovery query

searchFilters - the search filters for this discovery query

dsoType - only include search results with this type

page - the pageable for this discovery query

Throws:

DSpaceBadRequestException

buildQuery

public DiscoverQuery buildQuery(Context context,
                                IndexableObject scope,
                                DiscoveryConfiguration discoveryConfiguration,
                                String query,
                                List<SearchFilter> searchFilters,
                                List<String> dsoTypes,
                                org.springframework.data.domain.Pageable page)
                         throws DSpaceBadRequestException

Build a discovery query

Parameters:

context - the DSpace context

scope - the scope for this discovery query

discoveryConfiguration - the discovery configuration for this discovery query

query - the query string for this discovery query

searchFilters - the search filters for this discovery query

dsoTypes - only include search results with one of these types

page - the pageable for this discovery query

Throws:

DSpaceBadRequestException

buildFacetQuery

public DiscoverQuery buildFacetQuery(Context context,
                                     IndexableObject scope,
                                     DiscoveryConfiguration discoveryConfiguration,
                                     String prefix,
                                     String query,
                                     List<SearchFilter> searchFilters,
                                     String dsoType,
                                     org.springframework.data.domain.Pageable page,
                                     String facetName)
                              throws DSpaceBadRequestException

Create a discovery facet query.

Parameters:

context - the DSpace context

scope - the scope for this discovery query

discoveryConfiguration - the discovery configuration for this discovery query

prefix - limit the facets results to those starting with the given prefix.

query - the query string for this discovery query

searchFilters - the search filters for this discovery query

dsoType - only include search results with this type

page - the pageable for this discovery query

facetName - the facet field

Throws:

DSpaceBadRequestException

buildFacetQuery

public DiscoverQuery buildFacetQuery(Context context,
                                     IndexableObject scope,
                                     DiscoveryConfiguration discoveryConfiguration,
                                     String prefix,
                                     String query,
                                     List<SearchFilter> searchFilters,
                                     List<String> dsoTypes,
                                     org.springframework.data.domain.Pageable page,
                                     String facetName)
                              throws DSpaceBadRequestException

Create a discovery facet query.

Parameters:

context - the DSpace context

scope - the scope for this discovery query

discoveryConfiguration - the discovery configuration for this discovery query

prefix - limit the facets results to those starting with the given prefix.

query - the query string for this discovery query

searchFilters - the search filters for this discovery query

dsoTypes - only include search results with one of these types

page - the pageable for this discovery query

facetName - the facet field

Throws:

DSpaceBadRequestException

setIndexableFactories

public void setIndexableFactories(List<IndexFactory> indexableFactories)