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 search 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

Methods

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, preceeding and following siblings
Date	getLastSolrUpdate() Return last modification time of Solr index
List<Neo4jBean>	getPreceedingSiblings(String nodeId) Get the nodes preceeding siblings (max 10)
List<Neo4jBean>	getPreceedingSiblings(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) Retrieve the new record Id for the redirect from the old record id
String	resolveId(String collectionId, String recordId) Retrieve the new record Id for the redirect from the old collection id and record id
<T extends IdBean> ResultSet<T>	search(Class<T> beanInterface, Query query) Perform a search 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.
<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 search suggestions and frequencies
List<Term>	suggestions(String query, int pageSize, String field) returns a list of search suggestions and frequencies

Method Detail

findById

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

Retrieve a record by splitted collectionId and recordId

Parameters:

europeanaObjectId - - The unique europeana id * @param similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

MongoDBException

findById

FullBean findById(String europeanaObjectId,
                boolean similarItems)
                  throws MongoDBException

Retrieve a record by id.

Parameters:

europeanaObjectId - - The unique europeana id

similarItems - - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

MongoDBException

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:

europeanaObjectId - - The unique europeana id

similarItems - - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

SolrTypeException

resolveId

String resolveId(String europeanaObjectId)

Retrieve the new record Id for the redirect from the old record id

Parameters:

europeanaObjectId - - The old record id

Returns:

The new record Id

resolveId

String resolveId(String collectionId,
               String recordId)

Retrieve the new record Id for the redirect from the old collection id and record id

Parameters:

collectionId - - The collection Id

recordId - - The record Id

Returns:

The new record id

search

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

Perform a search 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 search specification.

Returns:

The search 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 Facet 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 search suggestions and frequencies

Parameters:

query - The search term to find suggestions for

pageSize - Amount of requested suggestions

Returns:

List of search suggestions

Throws:

SolrTypeException

suggestions

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

returns a list of search suggestions and frequencies

Parameters:

query - The search term to find suggestions for

pageSize - Amount of requested suggestions

Returns:

List of search 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:

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:

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

Returns:

The 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:

Throws:

org.apache.solr.client.solrj.SolrServerException

getLastSolrUpdate

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

Return last modification time of Solr index

Returns:

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)

Get a node object

Parameters:

nodeId - The ID of the record

Returns:

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:

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:

getChildren

List<Neo4jBean> getChildren(String nodeId)

Get the children of the node (max 10)

Parameters:

nodeId - The ID of the record

Returns:

getPreceedingSiblings

List<Neo4jBean> getPreceedingSiblings(String nodeId,
                                    int limit)

Get the nodes preceeding siblings

Parameters:

nodeId - The ID of the record

limit - How many siblings to retrieve

Returns:

getPreceedingSiblings

List<Neo4jBean> getPreceedingSiblings(String nodeId)

Get the nodes preceeding siblings (max 10)

Parameters:

nodeId - The ID of the record

Returns:

getFollowingSiblings

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

Get the nodes following siblings

Parameters:

nodeId - The ID of the record

limit - How many siblings to retrieve

Returns:

getFollowingSiblings

List<Neo4jBean> getFollowingSiblings(String nodeId)

Get the node's 10 following siblings

Parameters:

nodeId -

Returns:

getChildrenCount

long getChildrenCount(String nodeId)

Get the number of children this node has

Parameters:

nodeId -

Returns:

getInitialStruct

Neo4jStructBean getInitialStruct(String nodeId)

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

Parameters:

nodeId - The ID of the record

Returns:

The complex structure

isHierarchy

boolean isHierarchy(String nodeId)