Deep Search (Legacy)

This method is called each time a search is performed from a Primo view that has Deep Search enabled.

This function receives a Lucene query, and is responsible for translating the query to the needed syntax supported by the remote engine you are working against.

At the end, the plugin needs to transform the response received from the remote engine to a Primo response.

The Primo response is described by the following  jaguar XSD.

The following are the parameters this function receives:

For example:
String sessionId = (String)parameters.get("session_id")

Use the following code snippet to check if user is signed in or on campus
(the map sent to the function is the map received in the search function):

public boolean isSearchAllowed(Map<String, String[]> authorization) {
        Object pdsHandle = authorization.get(ThirdNodeConst.PDS_HANDLE);
        boolean signedInUser = (pdsHandle != null && !"".equals(pdsHandle));

        Boolean isOnCampus = (Boolean)authorization.get(ThirdNodeConst.ON_OFF_CAMPUS);

        return signedInUser || isOnCampus;
}

For blended search queries, Primo uses a specific algorithm that determines which facets to show on the results page.

In order to present a count number next to each facet value, Primo has to “ask” each relevant adapter, for the count of each of the facets.

This function receives the query and all the facets to be displayed, and should return the count for each facet.

Usually this will not be possible by most search engines as they might not have this ability.

The meaning of leaving this function unimplemented, is wrong counts for the facets, meaning when clicking on a facet,
the number of results returned will probably not match the count displayed next to the facet.

The following are the parameters this function receives:

The outcome of this function should be something like:

<sear:FACETLIST ACCURATE_COUNTERS="true">
       <sear:FACET NAME="creator" COUNT="19">
         ...
         <sear:FACET_VALUES KEY="Lund, Karen" VALUE="5"/>
         <sear:FACET_VALUES KEY="Webmaster Id" VALUE="1"/>
         <sear:FACET_VALUES KEY="Biro Corneliu" VALUE="4"/>
         <sear:FACET_VALUES KEY="Miller, Matt" VALUE="23"/>
       </sear:FACET>
       <sear:FACET NAME="lang" COUNT="47">
         ...
         <sear:FACET_VALUES KEY="ger" VALUE="303457"/>
         <sear:FACET_VALUES KEY="chi" VALUE="381872"/>
         <sear:FACET_VALUES KEY="dan" VALUE="1787"/>
         <sear:FACET_VALUES KEY="jpn" VALUE="118031"/>
         <sear:FACET_VALUES KEY="baq" VALUE="7"/>
         <sear:FACET_VALUES KEY="cze" VALUE="3352"/>
       </sear:FACET>
      
  </sear:FACETLIST>

YahooThirdNode XML Example
In this example the YahooThirdNode plug-in utilizes the following methods to implement a Yahoo search adaptor for Primo.
#init reads the parameters from the thirdnode-config.xml file and sets the client.
#buildQuery, which is called from the search method, converts the search query in Primo format to Yahoo format.
#map2pnx, which is called from the search method, converts the query results in Yahoo format to Primo PNX format.
#search performs the Yahoo search and returns the results in Primo PNX format.

public class YahooThirdNode extends AbstractDeepSearch {

    SearchClient client = null;

Init: get parameters if needed:

public void init(Map parameters) {

    String id = (String) parameters.get("APPLICATION_ID");

    client = new SearchClient(id);

}

Build Query: Conversion of a query from Primo format to Yahoo format.

private String buildQuery (String query) {

    String yahooQuery = query;

    for (int i = 0; i < SearchFields.SEARCH_FIELDS.length; i++) {

        Matcher matcher = Pattern.compile(SearchFields.SEARCH_FIELDS[i]+":

            \\((.*?)\\)").matcher(metalibQuery);

        if (matcher.find()) {

            // remove field name (title:(test)->(test))

            yahooQuery = matcher.replaceAll("$1");

        }

    }

    return yahooQuery;

}

Map2PNX: Conversion of a query result from Yahoo format to Primo PNX format.

private PrimoNMBibDocument map2pnx(WebSearchResult yResult) throws Exception {

    PrimoNMBibDocument primoRecord =  PrimoNMBibDocument.Factory.newInstance();

    RecordType rt = primoRecord.addNewPrimoNMBib().addNewRecord();

    DisplayType dt = rt.addNewDisplay();

    dt.addType("book");

    dt.addTitle(yResult.getTitle());

    dt.addDescription(yResult.getSummary());

    dt.addType(yResult.getMimeType());

    FacetsType ft = rt.addNewFacets();

    ft.addLanguage("eng");

    ft.addLanguage("fre");


    return primoRecord;

}

Searchfunction complete:

public PrimoResult search(String id, String query, int from, int to,

Map authorization, String sort) throws Exception {

    // Search Start Time

    long start = System.currentTimeMillis();


    // Convert Primo query format to yahoo query Format

    String yahooQuery = buildQuery(query);

    // Run search in Yahoo search engine

    WebSearchRequest request = new WebSearchRequest(yahooQuery);

    request.setStart(BigInteger.valueOf(from))

    WebSearchResults yahooResults = client.webSearch(request);

    // Search End Time

    long end = System.currentTimeMillis();

    // Prepare Primo results structure

    PrimoResult primoResult = PrimoResult.Factory.newInstance();

    SEGMENTSDocument.SEGMENTS returnSegment =

    SEGMENTSDocument.Factory.newInstance().addNewSEGMENTS();

    RESULTDocument.RESULT results =

        returnSegment.addNewJAGROOT().addNewRESULT();

    DOCSETDocument.DOCSET docSet = results.addNewDOCSET();

    // calculates search duration

    docSet.setHITTIME((end-start));

    // Set total hits

    docSet.setTOTALHITS(yahooResults.getTotalResultsAvailable().intValue());

    //set number of first result

    docSet.setFIRSTHIT(new Integer(from).toString());

    //set number of last result

    docSet.setLASTHIT(new Integer(from +

    yahooResults.listResults().length - 1).toString());

    for (int i = 0; i < yahooResults.listResults().length; i++) {

        // Convert Yahoo result to Primo PNX format

        PrimoNMBibDocument pnx = (map2pnx(yahooResults.listResults()[i]));

        DOCDocument.DOC hit = docSet.addNewDOC();

        hit.setPrimoNMBib(pnx.getPrimoNMBib());

        hit.setNO(String.valueOf(from + i));

    }

    primoResult.setSEGMENTS(returnSegment);

    return primoResult;

}

From Primo 4.8 and higher, a new mapping table has been added (User groups with restricted access to PC/DS) which lets you configure groups of restricted users per adapter.

If you want your Deep Search to take this into account, you can add to the code snippet above (“Allow searches only for signed in users”), the following:

public boolean isSearchAllowed(Map<String, Object> authorization) {
        Object pdsHandle = authorization.get(ThirdNodeConst.PDS_HANDLE);
        boolean signedInUser = (pdsHandle != null && !"".equals(pdsHandle));

        boolean isOnCampus = (Boolean)authorization.get(ThirdNodeConst.ON_OFF_CAMPUS);
        
        Boolean isResGroup = (Boolean)authorization.get(ThirdNodeConst.RESTRICTED_USER_GROUP);

        if ( isOnCampus || (signedInUser && !isResGroup) ) {
            return true;
        }

        return false;
}