com.indexdata.serviceproxy.plugins.ace

Class Pz2AceRecordSession

java.lang.Object

com.indexdata.serviceproxy.plugins.ace.Pz2RecordSession

com.indexdata.serviceproxy.plugins.ace.Pz2AceRecordSession

public class Pz2AceRecordSession
extends Pz2RecordSession

This class extends the functionality of it's base class by providing methods for executing an ACE search and requesting a record against that search. The base class wraps a Pazpar2 record session, this class wraps a record session on a separate Pazpar2 session (while still using the original record to construct the ACE query).

Author:

Niels Erik Nielsen

Field Summary

Fields inherited from class com.indexdata.serviceproxy.plugins.ace.Pz2RecordSession

baseRecord, dumpRecord, pazpar2Client, recid, recordQuery, serviceUrl, time

Constructor Summary

Constructors

Constructor and Description
Pz2AceRecordSession(ServiceRequest request, Document baseRecord)

Method Summary

Modifier and Type	Method and Description
void	aceDone(boolean done)
boolean	aceImprovedTheRecord() Compares original search record with ACE search record.
boolean	aceReadyForChainUse()
boolean	aceReadyForRecordRequest() Issues a show command on the ACE query, to check if the query is ready for the first record request (it is considered ready when at least 1 hit has been returned, or, if there are no active clients left)
boolean	aceRecordPrefered()
static String	createAceQuery(String pattern, String ti, String au, String filter) Constructs an ACE query string from select record attributes.
com.indexdata.masterkey.pazpar2.client.Pazpar2Client	getAceClient()
long	getAge() Gets the age of the client - to see if the client should be retired.
Document	getRecord()
boolean	hitsFound()
boolean	isAceDone() Determines if ACE has completed, based on 'activeclients' on the record request
boolean	isFiltered()
boolean	isNewClient() Indicates that this client was newly created and not re-entered yet.
Document	makeRecordRequest(int timeout)
void	performAceSearch(int timeout, String ti, String au, String acePattern, String filter)
void	saveAceRecord(Document doc) Save a document.
void	setNewClient(boolean isNewClient) Indicates that this client was newly created and not re-entered yet.

Methods inherited from class com.indexdata.serviceproxy.plugins.ace.Pz2RecordSession

getPazpar2Client, getPz2sessionId, logLocations, makeOffsetRequest, setDumpRecordToConsole

Methods inherited from class java.lang.Object

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

Constructor Detail

Pz2AceRecordSession

public Pz2AceRecordSession(ServiceRequest request,
                           Document baseRecord)
                    throws StandardServiceException

Throws:

StandardServiceException

Method Detail

getAceClient

public com.indexdata.masterkey.pazpar2.client.Pazpar2Client getAceClient()

performAceSearch

public void performAceSearch(int timeout,
                             String ti,
                             String au,
                             String acePattern,
                             String filter)
                      throws ServiceException

Throws:

ServiceException

makeRecordRequest

public Document makeRecordRequest(int timeout)
                           throws ServiceException

Throws:

ServiceException

aceReadyForRecordRequest

public boolean aceReadyForRecordRequest()
                                 throws ServiceException

Issues a show command on the ACE query, to check if the query is ready for the first record request (it is considered ready when at least 1 hit has been returned, or, if there are no active clients left)

Returns:

Throws:

StandardServiceException

ServiceException

hitsFound

public boolean hitsFound()
                  throws ServiceException

Throws:

ServiceException

aceDone

public void aceDone(boolean done)

aceReadyForChainUse

public boolean aceReadyForChainUse()
                            throws ServiceException

Throws:

ServiceException

createAceQuery

public static String createAceQuery(String pattern,
                                    String ti,
                                    String au,
                                    String filter)
                             throws StandardServiceException

Constructs an ACE query string from select record attributes.

Parameters:

record - containing the attribute values to be used for a new query

Returns:

a query

Throws:

StandardServiceException

isFiltered

public boolean isFiltered()

getAge

public long getAge()

Gets the age of the client - to see if the client should be retired.

Returns:

isNewClient

public boolean isNewClient()

Indicates that this client was newly created and not re-entered yet. Can be used to invoke special instructions only to be performed on the first round-trip (first poll).

Returns:

setNewClient

public void setNewClient(boolean isNewClient)

Indicates that this client was newly created and not re-entered yet. Can be used to invoke special instructions only to be performed on the first round-trip (first poll).

isAceDone

public boolean isAceDone()

Determines if ACE has completed, based on 'activeclients' on the record request

Returns:

true if activeclients equals 0

saveAceRecord

public void saveAceRecord(Document doc)

Save a document. Since this client is saved on the session, this enables caching of any document together with the client. It could save round-trips when polling if already completed documents are cached.

Parameters:

key -

doc -

getRecord

public Document getRecord()

Overrides:

getRecord in class Pz2RecordSession

aceRecordPrefered

public boolean aceRecordPrefered()

aceImprovedTheRecord

public boolean aceImprovedTheRecord()

Compares original search record with ACE search record. Can be used for analytical purposes in ACE or by subsequent plug-ins that wants to determine which one one to use - original record or ACE record.

Parameters:

recordDoc -

aceRecordResponse -