eu.europeana.corelib.search.impl

Class SearchServiceImpl

java.lang.Object

eu.europeana.corelib.search.impl.SearchServiceImpl

All Implemented Interfaces:

SearchService

public class SearchServiceImpl
extends Object
implements SearchService

Lookup record information from Solr or Mongo

Author:

Yorgos.Mamakis@ kb.nl

See Also:

SearchService

Field Summary

Fields

Modifier and Type	Field and Description
protected eu.europeana.corelib.tools.lookuptable.EuropeanaIdMongoServer	idServer
protected EdmMongoServer	mongoServer

Constructor Summary

Constructors

Constructor and Description
SearchServiceImpl()

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()
void	logTime(String type, long time)
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.
void	setSolrClient(org.apache.solr.client.solrj.SolrClient solrClient)
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) Deprecated. as of September 2018

Methods inherited from class java.lang.Object

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

Field Detail

mongoServer

protected EdmMongoServer mongoServer

idServer

protected eu.europeana.corelib.tools.lookuptable.EuropeanaIdMongoServer idServer

Constructor Detail

SearchServiceImpl

public SearchServiceImpl()

Method Detail

findById

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

Description copied from interface: SearchService

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

Specified by:

findById in interface SearchService

Parameters:

collectionId - id of the collection to which this record belongs

similarItems - whether to retrieve similar items

Returns:

A full europeana record

Throws:

EuropeanaException

findById

public FullBean findById(String europeanaObjectId,
                         boolean similarItems)
                  throws EuropeanaException

Description copied from interface: SearchService

Retrieve a record by id and calling processFullBean() afterwards

Specified by:

findById in interface SearchService

Parameters:

europeanaObjectId - The unique europeana id

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

EuropeanaException

fetchFullBean

public FullBean fetchFullBean(String europeanaObjectId)
                       throws EuropeanaException

Description copied from interface: SearchService

Retrieve a record by europeanaObjectId (no further processing)

Specified by:

fetchFullBean in interface SearchService

Parameters:

europeanaObjectId - The unique europeana id

Returns:

A full europeana record

Throws:

EuropeanaException

processFullBean

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

Description copied from interface: SearchService

(optionally) adding similar items to a FullBean, etcetera

Specified by:

processFullBean in interface SearchService

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

resolve

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

Description copied from interface: SearchService

Retrieve a record by splitted collectionId and recordId

Specified by:

resolve in interface SearchService

Parameters:

collectionId - id of the collection to which this record belongs

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

See Also:

SearchService.resolve(String, String, boolean)

resolve

public FullBean resolve(String europeanaObjectId,
                        boolean similarItems)
                 throws SolrTypeException

Description copied from interface: SearchService

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

Specified by:

resolve in interface SearchService

Parameters:

europeanaObjectId - The unique europeana id

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

See Also:

SearchService.resolve(String, boolean)

resolveId

public String resolveId(String europeanaObjectId)
                 throws BadDataException

Description copied from interface: SearchService

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

Specified by:

resolveId in interface SearchService

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

See Also:

SearchService.resolveId(String)

resolveId

public String resolveId(String collectionId,
                        String recordId)
                 throws BadDataException

Description copied from interface: SearchService

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

Specified by:

resolveId in interface SearchService

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

See Also:

SearchService.resolveId(String, String)

findMoreLikeThis

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

Deprecated.

Description copied from interface: SearchService

Retrieves the moreLikeThis List of BriefBeans

Specified by:

findMoreLikeThis in interface SearchService

Returns:

moreLikeThis List of BriefBeans

Throws:

EuropeanaException

findMoreLikeThis

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

Deprecated.

Description copied from interface: SearchService

Returns a specified number of moreLikeThis objects

Specified by:

findMoreLikeThis in interface SearchService

Returns:

a specified number of moreLikeThis objects

Throws:

EuropeanaException

search

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

Description copied from interface: SearchService

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

Specified by:

search in interface SearchService

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

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

Description copied from interface: SearchService

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

Specified by:

search in interface SearchService

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

suggestions

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

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

Description copied from interface: SearchService

returns a list of calculateTag suggestions and frequencies

Specified by:

suggestions in interface SearchService

Parameters:

query - The calculateTag term to find suggestions for

pageSize - Amount of requested suggestions

Returns:

Throws:

SolrTypeException

createCollections

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

Description copied from interface: SearchService

Create collection list for a given query and facet field

Specified by:

createCollections in interface SearchService

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

seeAlso

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

Description copied from interface: SearchService

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.

Specified by:

seeAlso in interface SearchService

Parameters:

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

Returns:

list of see also suggestions

queryFacetSearch

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

Specified by:

queryFacetSearch in interface SearchService

suggestions

@Deprecated
public List<Term> suggestions(String query,
                                          int pageSize,
                                          String field)

Deprecated. as of September 2018

Get the suggestions

Specified by:

suggestions in interface SearchService

Parameters:

query - The calculateTag term to find suggestions for

pageSize - Amount of requested suggestions

Returns:

List of calculateTag suggestions

setSolrClient

public void setSolrClient(org.apache.solr.client.solrj.SolrClient solrClient)

getLastSolrUpdate

public Date getLastSolrUpdate()
                       throws EuropeanaException

Specified by:

getLastSolrUpdate in interface SearchService

Returns:

last modification time of Solr index

Throws:

EuropeanaException

logTime

public void logTime(String type,
                    long time)