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

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 static org.apache.log4j.Logger	log
protected EdmMongoServer	metainfoMongoServer
protected EdmMongoServer	mongoServer
protected Neo4jServer	neo4jServer

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	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 rdfAbout) Get the children of the node (max 10)
List<Neo4jBean>	getChildren(String rdfAbout, int offset) Get the children of the node (max 10)
List<Neo4jBean>	getChildren(String rdfAbout, int offset, int limit) Get the children of the node (max 10)
long	getChildrenCount(String rdfAbout) Get the number of children this node has
List<Neo4jBean>	getFollowingSiblings(String rdfAbout) Get the node's 10 following siblings
List<Neo4jBean>	getFollowingSiblings(String rdfAbout, int limit) Get the nodes following siblings
Neo4jBean	getHierarchicalBean(String rdfAbout) 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 rdfAbout) Get the nodes preceding siblings (max 10)
List<Neo4jBean>	getPrecedingSiblings(String rdfAbout, int limit) Get the nodes preceeding siblings
boolean	isHierarchy(String rdfAbout)
void	logTime(String type, long time)
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)
void	setSolrServer(org.apache.solr.client.solrj.SolrServer solrServer)
<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) Get the suggestions

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

mongoServer

protected EdmMongoServer mongoServer

idServer

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

neo4jServer

protected Neo4jServer neo4jServer

metainfoMongoServer

protected EdmMongoServer metainfoMongoServer

Constructor Detail

SearchServiceImpl

public SearchServiceImpl()

Method Detail

setNeo4jTimeoutMillis

public void setNeo4jTimeoutMillis(int neo4jTimeoutMillis)

Description copied from interface: SearchService

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

Specified by:

setNeo4jTimeoutMillis in interface SearchService

findById

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

Description copied from interface: SearchService

Retrieve a record by splitted collectionId and recordId

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:

MongoRuntimeException

MongoDBException

Neo4JException

findById

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

Description copied from interface: SearchService

Retrieve a record by id.

Specified by:

findById in interface SearchService

Parameters:

europeanaObjectId - The unique europeana id

similarItems - Whether to retrieve similar items

Returns:

A full europeana record

Throws:

MongoRuntimeException

MongoDBException

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

resolve

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

Description copied from interface: SearchService

Retrieve a record by id.

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

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

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

Description copied from interface: SearchService

Retrieves the moreLikeThis List of BriefBeans

Specified by:

findMoreLikeThis in interface SearchService

Returns:

moreLikeThis List of BriefBeans

Throws:

org.apache.solr.client.solrj.SolrServerException

findMoreLikeThis

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

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:

org.apache.solr.client.solrj.SolrServerException

search

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

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:

SolrTypeException

search

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

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:

SolrTypeException

suggestions

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

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:

List of calculateTag suggestions

Throws:

SolrTypeException

createCollections

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

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:

SolrTypeException

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

sitemap

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

Description copied from interface: SearchService

Create a sitemap

Specified by:

sitemap in interface SearchService

Returns:

Throws:

SolrTypeException

suggestions

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

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

setSolrServer

public void setSolrServer(org.apache.solr.client.solrj.SolrServer solrServer)

getChildren

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

Description copied from interface: SearchService

Get the children of the node (max 10)

Specified by:

getChildren in interface SearchService

Parameters:

rdfAbout - The ID of the record

offset - The offset of the first child

limit - The number of records to retrieve

Returns:

node's children

isHierarchy

public boolean isHierarchy(String rdfAbout)
                    throws Neo4JException

Specified by:

isHierarchy in interface SearchService

Throws:

Neo4JException

getChildren

public List<Neo4jBean> getChildren(String rdfAbout,
                                   int offset)

Description copied from interface: SearchService

Get the children of the node (max 10)

Specified by:

getChildren in interface SearchService

Parameters:

rdfAbout - The ID of the record

offset - The offset of the first child

Returns:

node's children

getChildren

public List<Neo4jBean> getChildren(String rdfAbout)

Description copied from interface: SearchService

Get the children of the node (max 10)

Specified by:

getChildren in interface SearchService

Parameters:

rdfAbout - The ID of the record

Returns:

node's children

getHierarchicalBean

public Neo4jBean getHierarchicalBean(String rdfAbout)
                              throws Neo4JException

Description copied from interface: SearchService

Get a node object

Specified by:

getHierarchicalBean in interface SearchService

Parameters:

rdfAbout - The ID of the record

Returns:

node object

Throws:

Neo4JException

getLastSolrUpdate

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

Specified by:

getLastSolrUpdate in interface SearchService

Returns:

last modification time of Solr index

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

logTime

public void logTime(String type,
                    long time)

getPrecedingSiblings

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

Description copied from interface: SearchService

Get the nodes preceeding siblings

Specified by:

getPrecedingSiblings in interface SearchService

Parameters:

rdfAbout - The ID of the record

limit - How many siblings to retrieve

Returns:

node's preceding siblings

Throws:

Neo4JException

getPrecedingSiblings

public List<Neo4jBean> getPrecedingSiblings(String rdfAbout)
                                     throws Neo4JException

Description copied from interface: SearchService

Get the nodes preceding siblings (max 10)

Specified by:

getPrecedingSiblings in interface SearchService

Parameters:

rdfAbout - The ID of the record

Returns:

node's preceding siblings

Throws:

Neo4JException

getFollowingSiblings

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

Description copied from interface: SearchService

Get the nodes following siblings

Specified by:

getFollowingSiblings in interface SearchService

Parameters:

rdfAbout - The ID of the record

limit - How many siblings to retrieve

Returns:

node's following siblings

Throws:

Neo4JException

getFollowingSiblings

public List<Neo4jBean> getFollowingSiblings(String rdfAbout)
                                     throws Neo4JException

Description copied from interface: SearchService

Get the node's 10 following siblings

Specified by:

getFollowingSiblings in interface SearchService

Parameters:

rdfAbout - The ID of the record

Returns:

node's following siblings

Throws:

Neo4JException

getChildrenCount

public long getChildrenCount(String rdfAbout)
                      throws Neo4JException

Description copied from interface: SearchService

Get the number of children this node has

Specified by:

getChildrenCount in interface SearchService

Returns:

the number of children

Throws:

Neo4JException

getInitialStruct

public Neo4jStructBean getInitialStruct(String nodeId)
                                 throws Neo4JException

Description copied from interface: SearchService

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

Specified by:

getInitialStruct in interface SearchService

Parameters:

nodeId - The ID of the record

Returns:

The hierarchical structure

Throws:

Neo4JException