Package eu.clarin.sru.client

Interface SRUExplainHandler

All Known Subinterfaces:

SRUDefaultHandler

All Known Implementing Classes:

SRUDefaultHandlerAdapter

public interface SRUExplainHandler

Receive notifications to the response of a explain request.

See Also:

SRUExplainRequest, SRU Explain Operation

Method Summary

Modifier and Type	Method	Description
void	onDiagnostics(List<SRUDiagnostic> diagnostics)	Receive notification of diagnostics.
void	onExtraRecordData(String identifier, int position, XMLStreamReader reader)	Receive notification of extra record data.
void	onExtraResponseData(XMLStreamReader reader)	Receive notification of extra response data.
void	onFinishRecords(int nextRecordPosition)	Receive notifications of the end of the enumeration of records in the response.
void	onRecord(String identifier, int position, SRURecordData data)	Receive notification of a record in the result set.
void	onRequestStatistics(int totalBytesTransferred, long millisTotal, long millisNetwork, long millisProcessing)	Receive notification of request statistics.
void	onStartRecords(int numberOfRecords, String resultSetId, int resultSetIdleTime)	Receive notifications of the start of the enumeration of records in the response.

Method Detail

onDiagnostics

void onDiagnostics(List<SRUDiagnostic> diagnostics)
            throws SRUClientException

Receive notification of diagnostics.

Parameters:

diagnostics - a list of SRUDiagnostic

Throws:

SRUClientException - any SRU exception, possibly wrapping another exception

See Also:

SRUDiagnostic

onRequestStatistics

void onRequestStatistics(int totalBytesTransferred,
                         long millisTotal,
                         long millisNetwork,
                         long millisProcessing)

Receive notification of request statistics.

Parameters:

totalBytesTransferred - the total number of bytes transferred while receiving the response

millisTotal - the total time spend processing the request

millisNetwork - the time spend performing network operations

millisProcessing - the time spend processing the response

onExtraResponseData

void onExtraResponseData(XMLStreamReader reader)
                  throws XMLStreamException,
                         SRUClientException

Receive notification of extra response data.

Parameters:

reader - a XMLStreamReader to parse the extra response data

Throws:

XMLStreamException - an error occurred while parsing the response

SRUClientException - any SRU exception, possibly wrapping another exception

See Also:

SRU Extra Data / Extensions

onStartRecords

void onStartRecords(int numberOfRecords,
                    String resultSetId,
                    int resultSetIdleTime)
             throws SRUClientException

Receive notifications of the start of the enumeration of records in the response.

Parameters:

numberOfRecords - the number of records or -1 if not available

resultSetId - the result set id or null if not available

resultSetIdleTime - the result set idle time or -1 if not available

Throws:

SRUClientException - any SRU exception, possibly wrapping another exception

onFinishRecords

void onFinishRecords(int nextRecordPosition)
              throws SRUClientException

Receive notifications of the end of the enumeration of records in the response.

Parameters:

nextRecordPosition - the next record position or -1 if not available

Throws:

SRUClientException - any SRU exception, possibly wrapping another exception

onRecord

void onRecord(String identifier,
              int position,
              SRURecordData data)
       throws SRUClientException

Receive notification of a record in the result set.

Parameters:

identifier - identifier of the record or null if not available

position - position of the record in the result set or -1 if not available

data - the parsed record data

Throws:

SRUClientException - any SRU exception, possibly wrapping another exception

See Also:

SRURecordData, SRURecordDataParser

onExtraRecordData

void onExtraRecordData(String identifier,
                       int position,
                       XMLStreamReader reader)
                throws XMLStreamException,
                       SRUClientException

Receive notification of extra record data.

Parameters:

identifier - identifier of the record or null if not available

position - position of the record in the result set or -1 if not available

reader - a XMLStreamReader to parse the extra term data

Throws:

XMLStreamException - an error occurred while parsing the response

SRUClientException - any SRU exception, possibly wrapping another exception