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	findById(String europeanaObjectId, boolean similarItems) Retrieve a record by id.
FullBean	findById(String collectionId, String recordId, boolean similarItems) Retrieve a record by splitted collectionId and recordId
List<BriefBean>	findMoreLikeThis(String europeanaObjectId) Retrieves the moreLikeThis List of BriefBeans
List<BriefBean>	findMoreLikeThis(String europeanaObjectId, int count) Returns a specified number of moreLikeThis objects
List<Neo4jBean>	getChildren(String nodeId) Get the children of the node (max 10)
List<Neo4jBean>	getChildren(String nodeId, int offset) Get the children of the node (max 10)
List<Neo4jBean>	getChildren(String nodeId, int offset, int limit) Get the children of the node (max 10)
long	getChildrenCount(String nodeId) Get the number of children this node has
List<Neo4jBean>	getFollowingSiblings(String nodeId) Get the node's 10 following siblings
List<Neo4jBean>	getFollowingSiblings(String nodeId, int limit) Get the nodes following siblings
Neo4jBean	getHierarchicalBean(String nodeId) Get a node object
Neo4jStructBean	getInitialStruct(String nodeId) Get the initial structure, which contains self, the ancestors, preceding and following siblings
Date	getLastSolrUpdate()
List<Neo4jBean>	getPrecedingSiblings(String nodeId) Get the nodes preceding siblings (max 10)
List<Neo4jBean>	getPrecedingSiblings(String nodeId, int limit) Get the nodes preceeding siblings
boolean	isHierarchy(String nodeId)
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	setNeo4jTimeoutMillis(int neo4jTimeoutMillis) overrule the default isHierachy() check timeout value of 4000 millis (4 sec)
<T extends IdBean> ResultSet<T>	sitemap(Class<T> beanInterface, Query query) Create a sitemap
List<Term>	suggestions(String query, int pageSize) returns a list of calculateTag suggestions and frequencies
List<Term>	suggestions(String query, int pageSize, String field) returns a list of calculateTag suggestions and frequencies

Method Detail

setNeo4jTimeoutMillis

void setNeo4jTimeoutMillis(int neo4jTimeoutMillis)

overrule the default isHierachy() check timeout value of 4000 millis (4 sec)

findById

FullBean findById(String collectionId,
                  String recordId,
                  boolean similarItems)
           throws MongoRuntimeException,
                  MongoDBException,
                  Neo4JException

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:

MongoRuntimeException, - SolrTypeException

MongoRuntimeException

MongoDBException

Neo4JException

findById

FullBean findById(String europeanaObjectId,
                  boolean similarItems)
           throws MongoRuntimeException,
                  MongoDBException,
                  Neo4JException

Retrieve a record by id.

Parameters:

europeanaObjectId - The unique europeana id

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

MongoRuntimeException, - MongoDBException

MongoRuntimeException

MongoDBException

Neo4JException

resolve

FullBean resolve(String europeanaObjectId,
                 boolean similarItems)
          throws SolrTypeException

Retrieve a record by id.

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 SolrTypeException

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:

SolrTypeException

search

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

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:

SolrTypeException

sitemap

<T extends IdBean> ResultSet<T> sitemap(Class<T> beanInterface,
                                        Query query)
                                 throws SolrTypeException

Create a sitemap

Parameters:

beanInterface -

query -

Returns:

Throws:

SolrTypeException

createCollections

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

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:

SolrTypeException

suggestions

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

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:

SolrTypeException

suggestions

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

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:

SolrTypeException

findMoreLikeThis

List<BriefBean> findMoreLikeThis(String europeanaObjectId)
                          throws org.apache.solr.client.solrj.SolrServerException

Retrieves the moreLikeThis List of BriefBeans

Parameters:

europeanaObjectId -

Returns:

moreLikeThis List of BriefBeans

Throws:

org.apache.solr.client.solrj.SolrServerException

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

List<BriefBean> findMoreLikeThis(String europeanaObjectId,
                                 int count)
                          throws org.apache.solr.client.solrj.SolrServerException

Returns a specified number of moreLikeThis objects

Parameters:

europeanaObjectId -

count -

Returns:

a specified number of moreLikeThis objects

Throws:

org.apache.solr.client.solrj.SolrServerException

getLastSolrUpdate

Date getLastSolrUpdate()
                throws org.apache.solr.client.solrj.SolrServerException,
                       IOException

Returns:

last modification time of Solr index

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

queryFacetSearch

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

getHierarchicalBean

Neo4jBean getHierarchicalBean(String nodeId)
                       throws Neo4JException

Get a node object

Parameters:

nodeId - The ID of the record

Returns:

node object

Throws:

Neo4JException

getChildren

List<Neo4jBean> getChildren(String nodeId,
                            int offset,
                            int limit)

Get the children of the node (max 10)

Parameters:

nodeId - The ID of the record

offset - The offset of the first child

limit - The number of records to retrieve

Returns:

node's children

getChildren

List<Neo4jBean> getChildren(String nodeId,
                            int offset)

Get the children of the node (max 10)

Parameters:

nodeId - The ID of the record

offset - The offset of the first child

Returns:

node's children

getChildren

List<Neo4jBean> getChildren(String nodeId)

Get the children of the node (max 10)

Parameters:

nodeId - The ID of the record

Returns:

node's children

getPrecedingSiblings

List<Neo4jBean> getPrecedingSiblings(String nodeId,
                                     int limit)
                              throws Neo4JException

Get the nodes preceeding siblings

Parameters:

nodeId - The ID of the record

limit - How many siblings to retrieve

Returns:

node's preceding siblings

Throws:

Neo4JException

getPrecedingSiblings

List<Neo4jBean> getPrecedingSiblings(String nodeId)
                              throws Neo4JException

Get the nodes preceding siblings (max 10)

Parameters:

nodeId - The ID of the record

Returns:

node's preceding siblings

Throws:

Neo4JException

getFollowingSiblings

List<Neo4jBean> getFollowingSiblings(String nodeId,
                                     int limit)
                              throws Neo4JException

Get the nodes following siblings

Parameters:

nodeId - The ID of the record

limit - How many siblings to retrieve

Returns:

node's following siblings

Throws:

Neo4JException

getFollowingSiblings

List<Neo4jBean> getFollowingSiblings(String nodeId)
                              throws Neo4JException

Get the node's 10 following siblings

Parameters:

nodeId - The ID of the record

Returns:

node's following siblings

Throws:

Neo4JException

getChildrenCount

long getChildrenCount(String nodeId)
               throws Neo4JException

Get the number of children this node has

Parameters:

nodeId -

Returns:

the number of children

Throws:

Neo4JException

getInitialStruct

Neo4jStructBean getInitialStruct(String nodeId)
                          throws Neo4JException

Get the initial structure, which contains self, the ancestors, preceding and following siblings

Parameters:

nodeId - The ID of the record

Returns:

The hierarchical structure

Throws:

Neo4JException

isHierarchy

boolean isHierarchy(String nodeId)
             throws Neo4JException

Throws:

Neo4JException