org.dspace.discovery

Interface SearchService

All Known Implementing Classes:

SolrServiceImpl

public interface SearchService

Search interface that discovery uses

Author:

Kevin Van de Velde (kevin at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Method Summary

Modifier and Type	Method and Description
String	createLocationQueryForAdministrableItems(Context context) Method to create a Query that includes all communities and collections a user may administrate.
String	escapeQueryChars(String query) Utility method to escape any special characters in a user's query
List<Item>	getRelatedItems(Context context, Item item, DiscoveryMoreLikeThisConfiguration moreLikeThisConfiguration)
DiscoverResult	search(Context context, DiscoverQuery query) Convenient method to call @see #search(Context, DSpaceObject, DiscoverQuery) with a null DSpace Object as scope (i.e.
DiscoverResult	search(Context context, DiscoverQuery query, boolean includeWithdrawn)
DiscoverResult	search(Context context, DSpaceObject dso, DiscoverQuery query) Convenient method to call @see #search(Context, DSpaceObject, DiscoverQuery, boolean) with includeWithdrawn=false
DiscoverResult	search(Context context, DSpaceObject dso, DiscoverQuery query, boolean includeWithdrawn)
List<DSpaceObject>	search(Context context, String query, String orderfield, boolean ascending, int offset, int max, String... filterquery)
InputStream	searchJSON(Context context, DiscoverQuery query, DSpaceObject dso, String jsonIdentifier)
InputStream	searchJSON(Context context, DiscoverQuery query, String jsonIdentifier)
DiscoverFilterQuery	toFilterQuery(Context context, String field, String operator, String value) Transforms the given string field and value into a filter query
String	toSortFieldIndex(String metadataField, String type) Transforms the metadata field of the given sort configuration into the indexed field which we can then use in our solr queries

Method Detail

search

DiscoverResult search(Context context,
                      DiscoverQuery query)
               throws SearchServiceException

Convenient method to call @see #search(Context, DSpaceObject, DiscoverQuery) with a null DSpace Object as scope (i.e. all the repository)

Parameters:

context - DSpace Context object.

query - the discovery query object.

Throws:

SearchServiceException - if search error

search

DiscoverResult search(Context context,
                      DSpaceObject dso,
                      DiscoverQuery query)
               throws SearchServiceException

Convenient method to call @see #search(Context, DSpaceObject, DiscoverQuery, boolean) with includeWithdrawn=false

Parameters:

context - DSpace Context object

dso - a DSpace Object to use as scope of the search (only results within this object)

query - the discovery query object

Throws:

SearchServiceException - if search error

search

DiscoverResult search(Context context,
                      DiscoverQuery query,
                      boolean includeWithdrawn)
               throws SearchServiceException

Parameters:

context - DSpace Context object.

query - the discovery query object.

includeWithdrawn - use true to include in the results also withdrawn items that match the query.

Throws:

SearchServiceException - if search error

search

DiscoverResult search(Context context,
                      DSpaceObject dso,
                      DiscoverQuery query,
                      boolean includeWithdrawn)
               throws SearchServiceException

Parameters:

context - DSpace Context object

dso - a DSpace Object to use as scope of the search (only results within this object)

query - the discovery query object

includeWithdrawn - use true to include in the results also withdrawn items that match the query

Throws:

SearchServiceException - if search error

searchJSON

InputStream searchJSON(Context context,
                       DiscoverQuery query,
                       String jsonIdentifier)
                throws SearchServiceException

Throws:

SearchServiceException

searchJSON

InputStream searchJSON(Context context,
                       DiscoverQuery query,
                       DSpaceObject dso,
                       String jsonIdentifier)
                throws SearchServiceException

Throws:

SearchServiceException

search

List<DSpaceObject> search(Context context,
                          String query,
                          String orderfield,
                          boolean ascending,
                          int offset,
                          int max,
                          String... filterquery)

toFilterQuery

DiscoverFilterQuery toFilterQuery(Context context,
                                  String field,
                                  String operator,
                                  String value)
                           throws SQLException

Transforms the given string field and value into a filter query

Parameters:

context - the DSpace context

field - the field of the filter query

value - the filter query value

Returns:

a filter query

Throws:

SQLException - if database error

getRelatedItems

List<Item> getRelatedItems(Context context,
                           Item item,
                           DiscoveryMoreLikeThisConfiguration moreLikeThisConfiguration)

createLocationQueryForAdministrableItems

String createLocationQueryForAdministrableItems(Context context)
                                         throws SQLException

Method to create a Query that includes all communities and collections a user may administrate. If a user has the appropriate rights to administrate communities and/or collections we want to look up all contents of those communities and/or collections, ignoring the read policies of the items (e.g. to list all private items of communities/collections the user administrates). This method returns a query to filter for items that belong to those communities/collections only.

Parameters:

context -

Returns:

Throws:

SQLException

toSortFieldIndex

String toSortFieldIndex(String metadataField,
                        String type)

Transforms the metadata field of the given sort configuration into the indexed field which we can then use in our solr queries

Parameters:

metadataField - the metadata field

Returns:

the indexed field

escapeQueryChars

String escapeQueryChars(String query)

Utility method to escape any special characters in a user's query

Parameters:

query -

Returns:

query with any special characters escaped