com.marklogic.client.datamovement

Interface QueryEvent

All Known Subinterfaces:

QueryBatch

All Known Implementing Classes:

QueryBatchException

public interface QueryEvent

The context for a QueryBatch passed to QueryBatchListener or an exception passed to QueryFailureListener, indicating the state at the time this event occurred.

Method Summary

Modifier and Type	Method and Description
QueryBatcher	getBatcher() A reference to the batcher–useful for modifying the ForestConfiguration or calling DataMovementManager.stopJob(Batcher) if needed.
DatabaseClient	getClient() The DatabaseClient used to retrieve this batch (if it’s a job based on a QueryDefinition).
Forest	getForest() The forest queried for this event if this job is based on a QueryDefinition.
long	getForestBatchNumber() Within the context of this forest within the job, the numeric position of this batch.
long	getForestResultsSoFar() Within the context of this forest within the job, the number of uris processed including the uris in this event if this is a QueryBatch.
long	getJobBatchNumber() Within the context of the job, the numeric position of this batch.
long	getJobResultsSoFar() Within the context of the job, the number of uris processed including the uris in this event if this is a QueryBatch.
JobTicket	getJobTicket() The ticket for this job.

Method Detail

getBatcher

QueryBatcher getBatcher()

A reference to the batcher–useful for modifying the ForestConfiguration or calling DataMovementManager.stopJob(Batcher) if needed.

getClient

DatabaseClient getClient()

The DatabaseClient used to retrieve this batch (if it’s a job based on a QueryDefinition). This is useful for performing additional operations on the same host. If this job is based on an Iterator this is just the DatabaseClient for the next host in the round-robin rotation.

Returns:

the DatabaseClient for this batch

getJobBatchNumber

long getJobBatchNumber()

Within the context of the job, the numeric position of this batch.

Returns:

the batch number in this job

getJobResultsSoFar

long getJobResultsSoFar()

Within the context of the job, the number of uris processed including the uris in this event if this is a QueryBatch.

Returns:

the number of results in this job up to the point of this event

getForestBatchNumber

long getForestBatchNumber()

Within the context of this forest within the job, the numeric position of this batch.

Returns:

the batch number in this forest

getForestResultsSoFar

long getForestResultsSoFar()

Within the context of this forest within the job, the number of uris processed including the uris in this event if this is a QueryBatch.

Returns:

the number of results in this job in this forest up to the point of this event

getForest

Forest getForest()

The forest queried for this event if this job is based on a QueryDefinition. Returns null if this job is based on an Iterator.

Returns:

the Forest with which this event is associated

getJobTicket

JobTicket getJobTicket()

The ticket for this job. This can be useful for getting a snapshot getJobReport or for calling stopJob if needed.

Returns:

the JobTicket for this job