eu.europeana.corelib.search

Interface SearchService

All Known Implementing Classes:

SearchServiceImpl

public interface SearchService

Search service that retrieves BriefBeans or APIBeans in the case of a query calculateTag or a FullBean in the case of a user selection. Currently the implementation uses SOLR for Brief/APIBeans and MongoDB for FullBean retrieval.

Author:

Yorgos.Mamakis@ kb.nl, Willem-Jan Boogerd

Method Summary

Modifier and Type	Method and Description
List<org.apache.solr.client.solrj.response.FacetField.Count>	createCollections(String facetFieldName, String queryString, String... refinements) Create collection list for a given query and facet field
FullBean	fetchFullBean(String europeanaObjectId) Retrieve a record by europeanaObjectId (no further processing)
FullBean	findById(String europeanaObjectId, boolean similarItems) Retrieve a record by id and calling processFullBean() afterwards
FullBean	findById(String collectionId, String recordId, boolean similarItems) Retrieves a record by collectionId and recordId and calling processFullBean() afterwards
List<BriefBean>	findMoreLikeThis(String europeanaObjectId) Deprecated.
List<BriefBean>	findMoreLikeThis(String europeanaObjectId, int count) Deprecated.
Date	getLastSolrUpdate()
FullBean	processFullBean(FullBean fullBean, String europeanaObjectId, boolean similarItems) (optionally) adding similar items to a FullBean, etcetera
Map<String,Integer>	queryFacetSearch(String query, String[] qf, List<String> queries)
FullBean	resolve(String europeanaObjectId, boolean similarItems) Retrieve a record by id.
FullBean	resolve(String collectionId, String recordId, boolean similarItems) Retrieve a record by splitted collectionId and recordId
String	resolveId(String europeanaObjectId) Checks if an europeanaObjectId is old and has a newId.
String	resolveId(String collectionId, String recordId) Uses the provided collectionId and recordId to create an EuropeanaId and checks if that id is old and has a newId.
<T extends IdBean> ResultSet<T>	search(Class<T> beanInterface, Query query) Perform a calculateTag in SOLR based on the given query and return the results in the format of the given class.
<T extends IdBean> ResultSet<T>	search(Class<T> beanInterface, Query query, boolean debug) Perform a calculateTag in SOLR based on the given query and return the results in the format of the given class.
Map<String,Integer>	seeAlso(List<String> queries) Returns a list of "see also" suggestions.
List<Term>	suggestions(String query, int pageSize) Deprecated. as of September 2018 (not working properly and very little usage)
List<Term>	suggestions(String query, int pageSize, String field) returns a list of calculateTag suggestions and frequencies

Method Detail

fetchFullBean

FullBean fetchFullBean(String europeanaObjectId)
                throws EuropeanaException

Retrieve a record by europeanaObjectId (no further processing)

Parameters:

europeanaObjectId - The unique europeana id

Returns:

A full europeana record

Throws:

EuropeanaException

processFullBean

FullBean processFullBean(FullBean fullBean,
                         String europeanaObjectId,
                         boolean similarItems)

(optionally) adding similar items to a FullBean, etcetera

Parameters:

fullBean - The FullBean to be processed (injectWebMetaInfoBatch etc.)

europeanaObjectId - The unique europeana id

similarItems - whether to retrieve similar items

Returns:

processed full europeana record

Throws:

EuropeanaException

findById

FullBean findById(String collectionId,
                  String recordId,
                  boolean similarItems)
           throws EuropeanaException

Retrieves a record by collectionId and recordId and calling processFullBean() afterwards

Parameters:

collectionId - id of the collection to which this record belongs

recordId -

similarItems - whether to retrieve similar items

Returns:

A full europeana record

Throws:

EuropeanaException

findById

FullBean findById(String europeanaObjectId,
                  boolean similarItems)
           throws EuropeanaException

Retrieve a record by id and calling processFullBean() afterwards

Parameters:

europeanaObjectId - The unique europeana id

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

EuropeanaException

resolve

FullBean resolve(String europeanaObjectId,
                 boolean similarItems)
          throws SolrTypeException

Retrieve a record by id. If the record cannot be found, it will retry

Parameters:

europeanaObjectId - The unique europeana id

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

resolve

FullBean resolve(String collectionId,
                 String recordId,
                 boolean similarItems)
          throws SolrTypeException

Retrieve a record by splitted collectionId and recordId

Parameters:

collectionId - id of the collection to which this record belongs

recordId -

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

resolveId

String resolveId(String europeanaObjectId)
          throws BadDataException

Checks if an europeanaObjectId is old and has a newId. Note that this new id may also be old so we check iteratively and return the newest id

Parameters:

europeanaObjectId - the old record id

Returns:

a new record id, null if none was found

Throws:

BadDataException - if a circular id reference is found

resolveId

String resolveId(String collectionId,
                 String recordId)
          throws BadDataException

Uses the provided collectionId and recordId to create an EuropeanaId and checks if that id is old and has a newId. Note that this new id may also be old so we check iteratively and return the newest id

Parameters:

collectionId - the collection Id

recordId - the record Id

Returns:

a new record id, null if none was found

Throws:

BadDataException - if a circular id reference is found

search

<T extends IdBean> ResultSet<T> search(Class<T> beanInterface,
                                       Query query,
                                       boolean debug)
                                throws EuropeanaException

Perform a calculateTag in SOLR based on the given query and return the results in the format of the given class.

Parameters:

beanInterface - The required bean type, should be ApiBean or BriefBean

query - Model class containing the calculateTag specification.

debug - includes the string representing the Solrquery in the ResultSet

Returns:

The calculateTag results, including facets, breadcrumb and original query.

Throws:

EuropeanaException

search

<T extends IdBean> ResultSet<T> search(Class<T> beanInterface,
                                       Query query)
                                throws EuropeanaException

Perform a calculateTag in SOLR based on the given query and return the results in the format of the given class.

Parameters:

beanInterface - The required bean type, should be ApiBean or BriefBean

query - Model class containing the calculateTag specification.

Returns:

The calculateTag results, including facets, breadcrumb and original query.

Throws:

EuropeanaException;

EuropeanaException

createCollections

List<org.apache.solr.client.solrj.response.FacetField.Count> createCollections(String facetFieldName,
                                                                               String queryString,
                                                                               String... refinements)
                                                                        throws EuropeanaException

Create collection list for a given query and facet field

Parameters:

facetFieldName - The SolrFacetType field to create the collection for

queryString - The Query to use for creating the collection

refinements - Optional refinements

Returns:

A List of FacetField.Count objects containing the collection

Throws:

EuropeanaException;

EuropeanaException

suggestions

@Deprecated
List<Term> suggestions(String query,
                                   int pageSize)
                            throws EuropeanaException

Deprecated. as of September 2018 (not working properly and very little usage)

returns a list of calculateTag suggestions and frequencies

Parameters:

query - The calculateTag term to find suggestions for

pageSize - Amount of requested suggestions

Returns:

List of calculateTag suggestions

Throws:

EuropeanaException;

EuropeanaException

suggestions

List<Term> suggestions(String query,
                       int pageSize,
                       String field)
                throws EuropeanaException

returns a list of calculateTag suggestions and frequencies

Parameters:

query - The calculateTag term to find suggestions for

pageSize - Amount of requested suggestions

Returns:

List of calculateTag suggestions

Throws:

EuropeanaException;

EuropeanaException

findMoreLikeThis

@Deprecated
List<BriefBean> findMoreLikeThis(String europeanaObjectId)
                                      throws EuropeanaException

Deprecated.

Retrieves the moreLikeThis List of BriefBeans

Parameters:

europeanaObjectId -

Returns:

moreLikeThis List of BriefBeans

Throws:

EuropeanaException;

EuropeanaException

seeAlso

Map<String,Integer> seeAlso(List<String> queries)

Returns a list of "see also" suggestions. The suggestions are organized by fields (who, what, where, when, and title). Each suggestion contains a field value and the number of documents it matches.

Parameters:

queries - Map of field names, and corresponding field values.

Returns:

list of see also suggestions

findMoreLikeThis

@Deprecated
List<BriefBean> findMoreLikeThis(String europeanaObjectId,
                                             int count)
                                      throws EuropeanaException

Deprecated.

Returns a specified number of moreLikeThis objects

Parameters:

europeanaObjectId -

count -

Returns:

a specified number of moreLikeThis objects

Throws:

EuropeanaException;

EuropeanaException

getLastSolrUpdate

Date getLastSolrUpdate()
                throws EuropeanaException

Returns:

last modification time of Solr index

Throws:

EuropeanaException;

IOException

EuropeanaException

queryFacetSearch

Map<String,Integer> queryFacetSearch(String query,
                                     String[] qf,
                                     List<String> queries)