org.kuali.ole.docstore.discovery.service

Class QueryServiceImpl

java.lang.Object

org.kuali.ole.docstore.discovery.service.QueryServiceImpl

All Implemented Interfaces:

QueryService

public class QueryServiceImpl
extends Object
implements QueryService

User: tirumalesh.b Date: 16/1/12 Time: 12:49 PM

Method Summary

Methods

Modifier and Type	Method and Description
List<WorkBibDocument>	browseCallNumbers(CallNumberBrowseParams callNumberBrowseParams) Used to display closest record based on input fields classification, rows and start index
WorkBibDocument	buildBibDocumentInfo(WorkBibDocument bibDocument)
String	buildCommonQueryForForwardCallNumber(String location, String classificationScheme, String callNumberBrowseText, String docType)
void	buildItemCallNumber(List<WorkItemDocument> itemDocuments) Append 'Enumeration', 'Chronology' and 'Copy Number' to item call number based on their availability.
List<OleDocument>	buildOleDocuments(List<Map<String,Object>> hitsOnPage)
List<OLESerialReceivingRecord>	buildOleSerialReceivingRecords(List<Map<String,Object>> hitsOnPage)
String	buildQuery(SearchParams searchParams)
String	buildQueryForBib(List<WorkItemDocument> workItemDocumentList) Building solr query with list of Item records The solr query is used to get Bib records.
String	buildQueryForBrowseCallNumbers(String location, String classificationScheme, int numRows, int startIndex, String docType) Building solr query for getting Item/Holdings records with call number
String	buildQueryForDoc(OleDocument queryDoc)
String	buildQueryForTotalCallNumberCount(String location, String classificationScheme, String docType) Preparing solr query based on user input fields location and classification scheme.
String	buildQueryForTotalForwardCallNumberCount(String location, String classificationScheme, String callNumberBrowseText, String docType)
String	buildQueryWithFieldListParameters(List<String> fieldsList)
String	buildQueryWithSearchParameters(List<SearchCondition> searchFieldsList)
String	buildQueryWithSortFields(String sortField, String sortOrder)
List<WorkBibDocument>	buildWorkBibDocuments(List<Map<String,Object>> hitsOnPage)
List<WorkHoldingsDocument>	buildWorkHoldingDocuments(List<Map<String,Object>> hitsOnPage)
List<WorkItemDocument>	buildWorkItemDocuments(List<Map<String,Object>> hitsOnPage)
List<String>	getBibDetailsForPurchaseOrderSearch(Map<String,String> searchCriteria)
List<WorkBibDocument>	getBibDocuments(SearchParams searchParams)
Map<String,String>	getBibInformation(String bibIdentifier, Map<String,String> searchCriteria)
List<String>	getBibUuidsForBibMatchPoints(String code, String value)
List	getDocuments(SearchParams searchParams) Get List of records from solr after click next or previous
List<WorkEHoldingsDocument>	getEHoldingsDocuments(SearchParams searchParams)
String	getFieldValue(org.apache.solr.client.solrj.response.QueryResponse response, String fieldName)
List<WorkHoldingsDocument>	getHoldingDocuments(SearchParams searchParams)
static QueryService	getInstance()
Map	getItemDetails(String itemBarcode, String itemUUID) Retrieve instance,item and bib uuid using item barcode or item uuid.
List<WorkItemDocument>	getItemDocuments(SearchParams searchParams)
List<String>	getItemIdsForInstanceIds(List<String> instanceIds)
List<OLESerialReceivingRecord>	getOleSerialReceivingRecords(SearchParams searchParams)
int	getSolrHitsForCallNumberBrowse(String inputQuery)
List<Map<String,Object>>	getSolrHitsForCallNumberBrowse(String inputQuery, int start, int numRows)
List<Map<String,Object>>	getSolrHitsForQuery(String inputQuery)
List<Map<String,Object>>	getSolrHitsForQueryParams(SearchParams searchParams) Gets Solr response for search Params
int	getSolrHitsForQueryParams(String inputQuery) Gets total number of records from solr
Map	getTitleAndAuthorfromBib(String bibUuid) Retrieve title and author from docstore using solr query.
List<String>	getTitleValues(String fieldValue) This method returns the list of titles based on the given search value.
List<String>	getUUIDList(List<String> idList, String identifierType)
List<WorkBibDocument>	getWorkBibDocuments(List<WorkItemDocument> workItemDocuments) Prepares a list of Bib records based on available Item records.
List<WorkBibDocument>	getWorkBibRecords(List<LinkedHashMap<String,String>> uuidsMapList)
protected void	init()
void	initCallNumberBrowse(CallNumberBrowseParams callNumberBrowseParams) Prepares the solr query based on user input values location, classification and call number browse text Calculates totalCallNumberCount and totalForwardCallNumberCount based on solr query results Evaluates matchIndex based on totalCallNumberCount and totalForwardCallNumberCount
boolean	isFieldValueExists(String docType, String field, String value, String id) Verify solr for the field and return true if exists (Ingest) Verify solr for the field other updating record (Update)
List<WorkBibDocument>	mergeBibAndItemDocuments(List<WorkItemDocument> workItemDocumentList, List<WorkBibDocument> workBibDocumentList) Merges the item documents with corresponding Bib document.
String	queryField(SearchParams searchParams, String fieldName)
String	queryForBib(String itemId)
List<String>	queryForBibs(String instancedId) This method returns the Bib ids for the selected bound-with instance.
List<WorkBibDocument>	queryForBibTree(List<WorkBibDocument> workBibDocumentList)
WorkBibDocument	queryForBibTree(WorkBibDocument queryDoc)
List<OleDocument>	queryForDocs(OleDocument queryDoc)
WorkEInstanceDocument	queryForEInstanceTree(WorkEInstanceDocument eInstanceDocument)
List<String>	queryForInstances(String uuid) This method used to get the instances for the selected bibs.
WorkInstanceDocument	queryForInstanceTree(WorkInstanceDocument instanceDocument)
List<String>	queryForItems(String bibId)
WorkItemDocument	queryForItemTree(WorkItemDocument itemDocument)
List	retriveResults(String queryString)
List	retriveResults(String queryString, int rowSize) This method is for item search in deliver
boolean	verifyFieldValue(String uuid, String fieldName, List<String> fieldValueList) Verifies whether the given field for the given document id has a value from the given value list.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static QueryService getInstance()

init

protected void init()

queryForDocs

public List<OleDocument> queryForDocs(OleDocument queryDoc)
                               throws Exception

Specified by:

queryForDocs in interface QueryService

Throws:

Exception

getBibDocuments

public List<WorkBibDocument> getBibDocuments(SearchParams searchParams)
                                      throws Exception

Specified by:

getBibDocuments in interface QueryService

Throws:

Exception

getHoldingDocuments

public List<WorkHoldingsDocument> getHoldingDocuments(SearchParams searchParams)
                                               throws Exception

Specified by:

getHoldingDocuments in interface QueryService

Throws:

Exception

getOleSerialReceivingRecords

public List<OLESerialReceivingRecord> getOleSerialReceivingRecords(SearchParams searchParams)
                                                            throws Exception

Specified by:

getOleSerialReceivingRecords in interface QueryService

Throws:

Exception

getItemDocuments

public List<WorkItemDocument> getItemDocuments(SearchParams searchParams)
                                        throws Exception

Specified by:

getItemDocuments in interface QueryService

Throws:

Exception

getDocuments

public List getDocuments(SearchParams searchParams)

Get List of records from solr after click next or previous

Specified by:

getDocuments in interface QueryService

Parameters:

searchParams -

Returns:

List Of Documents

Throws:

Exception

queryField

public String queryField(SearchParams searchParams,
                String fieldName)
                  throws Exception

Specified by:

queryField in interface QueryService

Throws:

Exception

getFieldValue

public String getFieldValue(org.apache.solr.client.solrj.response.QueryResponse response,
                   String fieldName)

buildOleSerialReceivingRecords

public List<OLESerialReceivingRecord> buildOleSerialReceivingRecords(List<Map<String,Object>> hitsOnPage)
                                                              throws org.apache.solr.client.solrj.SolrServerException

Parameters:

hitsOnPage -

Returns:

List of OleDocuments

Throws:

org.apache.solr.client.solrj.SolrServerException

buildOleDocuments

public List<OleDocument> buildOleDocuments(List<Map<String,Object>> hitsOnPage)

Parameters:

hitsOnPage -

Returns:

List of OleDocuments

buildWorkBibDocuments

public List<WorkBibDocument> buildWorkBibDocuments(List<Map<String,Object>> hitsOnPage)

Parameters:

hitsOnPage -

Returns:

List of workBibDocuments

buildWorkHoldingDocuments

public List<WorkHoldingsDocument> buildWorkHoldingDocuments(List<Map<String,Object>> hitsOnPage)

Parameters:

hitsOnPage -

Returns:

List of workHoldingsDocuments

buildWorkItemDocuments

public List<WorkItemDocument> buildWorkItemDocuments(List<Map<String,Object>> hitsOnPage)

Parameters:

hitsOnPage -

Returns:

List of workItemDocuments

queryForBibTree

public WorkBibDocument queryForBibTree(WorkBibDocument queryDoc)
                                throws Exception

Specified by:

queryForBibTree in interface QueryService

Parameters:

queryDoc -

Returns:

Throws:

Exception

buildBibDocumentInfo

public WorkBibDocument buildBibDocumentInfo(WorkBibDocument bibDocument)
                                     throws org.apache.solr.client.solrj.SolrServerException,
                                            IOException

Specified by:

buildBibDocumentInfo in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

queryForBibTree

public List<WorkBibDocument> queryForBibTree(List<WorkBibDocument> workBibDocumentList)
                                      throws Exception

Specified by:

queryForBibTree in interface QueryService

Parameters:

workBibDocumentList -

Returns:

Throws:

Exception

queryForBibs

public List<String> queryForBibs(String instancedId)
                          throws org.apache.solr.client.solrj.SolrServerException

This method returns the Bib ids for the selected bound-with instance.

Specified by:

queryForBibs in interface QueryService

Parameters:

instancedId -

Returns:

Throws:

org.apache.solr.client.solrj.SolrServerException

queryForItems

public List<String> queryForItems(String bibId)
                           throws org.apache.solr.client.solrj.SolrServerException

Specified by:

queryForItems in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

queryForBib

public String queryForBib(String itemId)
                   throws org.apache.solr.client.solrj.SolrServerException

Specified by:

queryForBib in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

queryForInstances

public List<String> queryForInstances(String uuid)
                               throws org.apache.solr.client.solrj.SolrServerException

This method used to get the instances for the selected bibs.

Specified by:

queryForInstances in interface QueryService

Parameters:

uuid -

Returns:

Throws:

org.apache.solr.client.solrj.SolrServerException

queryForInstanceTree

public WorkInstanceDocument queryForInstanceTree(WorkInstanceDocument instanceDocument)
                                          throws org.apache.solr.client.solrj.SolrServerException

Specified by:

queryForInstanceTree in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

queryForItemTree

public WorkItemDocument queryForItemTree(WorkItemDocument itemDocument)
                                  throws org.apache.solr.client.solrj.SolrServerException

Specified by:

queryForItemTree in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

queryForEInstanceTree

public WorkEInstanceDocument queryForEInstanceTree(WorkEInstanceDocument eInstanceDocument)
                                            throws org.apache.solr.client.solrj.SolrServerException

Specified by:

queryForEInstanceTree in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

buildQueryForDoc

public String buildQueryForDoc(OleDocument queryDoc)

Specified by:

buildQueryForDoc in interface QueryService

Parameters:

queryDoc -

Returns:

query Usage: Builds query string using OleDocument Data

getSolrHitsForQuery

public List<Map<String,Object>> getSolrHitsForQuery(String inputQuery)
                                             throws Exception

Parameters:

inputQuery -

Returns:

hitsOnPage

Throws:

Exception - Usage: Gets Solr response for input query and builds List of Maps holding Solr Doc Data

getSolrHitsForQueryParams

public List<Map<String,Object>> getSolrHitsForQueryParams(SearchParams searchParams)
                                                   throws Exception

Gets Solr response for search Params

Parameters:

searchParams -

Returns:

hitsOnPage

Throws:

Exception

getSolrHitsForQueryParams

public int getSolrHitsForQueryParams(String inputQuery)
                              throws Exception

Gets total number of records from solr

Parameters:

inputQuery -

Returns:

numFound

Throws:

Exception

getUUIDList

public List<String> getUUIDList(List<String> idList,
                       String identifierType)

Specified by:

getUUIDList in interface QueryService

Parameters:

idList -

identifierType -

Returns:

getTitleValues

public List<String> getTitleValues(String fieldValue)

This method returns the list of titles based on the given search value.

Specified by:

getTitleValues in interface QueryService

Parameters:

fieldValue -

Returns:

buildQuery

public String buildQuery(SearchParams searchParams)

Specified by:

buildQuery in interface QueryService

buildQueryWithSearchParameters

public String buildQueryWithSearchParameters(List<SearchCondition> searchFieldsList)

buildQueryWithSortFields

public String buildQueryWithSortFields(String sortField,
                              String sortOrder)

buildQueryWithFieldListParameters

public String buildQueryWithFieldListParameters(List<String> fieldsList)

initCallNumberBrowse

public void initCallNumberBrowse(CallNumberBrowseParams callNumberBrowseParams)
                          throws Exception

Prepares the solr query based on user input values location, classification and call number browse text Calculates totalCallNumberCount and totalForwardCallNumberCount based on solr query results Evaluates matchIndex based on totalCallNumberCount and totalForwardCallNumberCount

Specified by:

initCallNumberBrowse in interface QueryService

Parameters:

callNumberBrowseParams - contains required parameters for call number browse functionality

Throws:

Exception

browseCallNumbers

public List<WorkBibDocument> browseCallNumbers(CallNumberBrowseParams callNumberBrowseParams)
                                        throws Exception

Used to display closest record based on input fields classification, rows and start index

Specified by:

browseCallNumbers in interface QueryService

Parameters:

callNumberBrowseParams - contains required parameters for call number browse functionality

Returns:

Throws:

Exception

mergeBibAndItemDocuments

public List<WorkBibDocument> mergeBibAndItemDocuments(List<WorkItemDocument> workItemDocumentList,
                                             List<WorkBibDocument> workBibDocumentList)

Merges the item documents with corresponding Bib document. The main intention is to make equal count for both Item and Bib documents.

Parameters:

workItemDocumentList - contains list of Item records

workBibDocumentList - contains list of Bib records.

Returns:

getWorkBibDocuments

public List<WorkBibDocument> getWorkBibDocuments(List<WorkItemDocument> workItemDocuments)
                                          throws Exception

Prepares a list of Bib records based on available Item records.

Parameters:

workItemDocuments - contains list of Item documents

Returns:

Throws:

Exception

buildQueryForBib

public String buildQueryForBib(List<WorkItemDocument> workItemDocumentList)

Building solr query with list of Item records The solr query is used to get Bib records.

Parameters:

workItemDocumentList - contains list of Item records

Returns:

the solr query for Bib records

buildQueryForTotalCallNumberCount

public String buildQueryForTotalCallNumberCount(String location,
                                       String classificationScheme,
                                       String docType)

Preparing solr query based on user input fields location and classification scheme.

Parameters:

location - contains user input location

classificationScheme - user input classification

Returns:

solr query for total call number count

buildQueryForBrowseCallNumbers

public String buildQueryForBrowseCallNumbers(String location,
                                    String classificationScheme,
                                    int numRows,
                                    int startIndex,
                                    String docType)

Building solr query for getting Item/Holdings records with call number

Parameters:

location - the Item/Holdings location

classificationScheme - the Item/Holdings classification

numRows - the number of rows for displaying results

startIndex - index used to specify the

Returns:

the solr query for browse call numbers.

buildQueryForTotalForwardCallNumberCount

public String buildQueryForTotalForwardCallNumberCount(String location,
                                              String classificationScheme,
                                              String callNumberBrowseText,
                                              String docType)

Parameters:

location - the Item/Holdings location.

classificationScheme - the Item/Holdings classification.

callNumberBrowseText - the user input field callNumberBrowseText.

Returns:

the solr query for getting forward call number count.

buildCommonQueryForForwardCallNumber

public String buildCommonQueryForForwardCallNumber(String location,
                                          String classificationScheme,
                                          String callNumberBrowseText,
                                          String docType)

Parameters:

location - the Item/Holdings location

classificationScheme - the Item/Holdings classification

callNumberBrowseText - the user input field callNumberBrowseText.

Returns:

solr query

getWorkBibRecords

public List<WorkBibDocument> getWorkBibRecords(List<LinkedHashMap<String,String>> uuidsMapList)
                                        throws Exception

Specified by:

getWorkBibRecords in interface QueryService

Throws:

Exception

getSolrHitsForCallNumberBrowse

public List<Map<String,Object>> getSolrHitsForCallNumberBrowse(String inputQuery,
                                                      int start,
                                                      int numRows)
                                                        throws Exception

Parameters:

inputQuery - input query

start - start index

numRows - the number of rows for displaying results

Returns:

the list of solr hits for call number browse

Throws:

Exception

getSolrHitsForCallNumberBrowse

public int getSolrHitsForCallNumberBrowse(String inputQuery)
                                   throws Exception

Throws:

Exception

isFieldValueExists

public boolean isFieldValueExists(String docType,
                         String field,
                         String value,
                         String id)
                           throws Exception

Verify solr for the field and return true if exists (Ingest) Verify solr for the field other updating record (Update)

Specified by:

isFieldValueExists in interface QueryService

Parameters:

docType -

field -

value -

id -

Returns:

Throws:

Exception

buildItemCallNumber

public void buildItemCallNumber(List<WorkItemDocument> itemDocuments)

Append 'Enumeration', 'Chronology' and 'Copy Number' to item call number based on their availability.

Parameters:

itemDocuments -

retriveResults

public List retriveResults(String queryString)

Specified by:

retriveResults in interface QueryService

getItemDetails

public Map getItemDetails(String itemBarcode,
                 String itemUUID)
                   throws Exception

Retrieve instance,item and bib uuid using item barcode or item uuid.

Specified by:

getItemDetails in interface QueryService

Parameters:

itemBarcode -

Returns:

Map

Throws:

Exception

getTitleAndAuthorfromBib

public Map getTitleAndAuthorfromBib(String bibUuid)
                             throws Exception

Retrieve title and author from docstore using solr query.

Specified by:

getTitleAndAuthorfromBib in interface QueryService

Parameters:

bibUuid -

Returns:

Throws:

Exception

getBibInformation

public Map<String,String> getBibInformation(String bibIdentifier,
                                   Map<String,String> searchCriteria)

Specified by:

getBibInformation in interface QueryService

retriveResults

public List retriveResults(String queryString,
                  int rowSize)

This method is for item search in deliver

Specified by:

retriveResults in interface QueryService

Parameters:

queryString -

rowSize -

Returns:

verifyFieldValue

public boolean verifyFieldValue(String uuid,
                       String fieldName,
                       List<String> fieldValueList)
                         throws org.apache.solr.client.solrj.SolrServerException

Verifies whether the given field for the given document id has a value from the given value list. Returns true if the field has a value.

Specified by:

verifyFieldValue in interface QueryService

Parameters:

uuid -

fieldName -

fieldValueList - - "," separated values

Returns:

Throws:

org.apache.solr.client.solrj.SolrServerException

getItemIdsForInstanceIds

public List<String> getItemIdsForInstanceIds(List<String> instanceIds)
                                      throws org.apache.solr.client.solrj.SolrServerException

Specified by:

getItemIdsForInstanceIds in interface QueryService

Parameters:

instanceIds -

Returns:

Throws:

org.apache.solr.client.solrj.SolrServerException

getEHoldingsDocuments

public List<WorkEHoldingsDocument> getEHoldingsDocuments(SearchParams searchParams)
                                                  throws Exception

Specified by:

getEHoldingsDocuments in interface QueryService

Throws:

Exception

getBibUuidsForBibMatchPoints

public List<String> getBibUuidsForBibMatchPoints(String code,
                                        String value)
                                          throws org.apache.solr.client.solrj.SolrServerException

Specified by:

getBibUuidsForBibMatchPoints in interface QueryService

Throws:

org.apache.solr.client.solrj.SolrServerException

getBibDetailsForPurchaseOrderSearch

public List<String> getBibDetailsForPurchaseOrderSearch(Map<String,String> searchCriteria)

Specified by:

getBibDetailsForPurchaseOrderSearch in interface QueryService