com.marklogic.client.datamovement

Class QueryBatchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.marklogic.client.datamovement.QueryBatchException

All Implemented Interfaces:

QueryEvent, java.io.Serializable

public class QueryBatchException
extends java.lang.Exception
implements QueryEvent

An exception which occurred when attempting to retrieve a batch of matches to a query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryBatchException(QueryEvent queryEvent, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
QueryBatcher	getBatcher() The QueryBatcher assocated with this event--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.
java.lang.String	getLastUriForForest() Within the context of this forest within the job, the last uri processed including the uris in this event if this is a QueryBatch.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBatchException

public QueryBatchException(QueryEvent queryEvent,
                           java.lang.Throwable cause)

Method Detail

getBatcher

public QueryBatcher getBatcher()

The QueryBatcher assocated with this event--useful for modifying the ForestConfiguration or calling DataMovementManager.stopJob(Batcher) if needed.

Specified by:

getBatcher in interface QueryEvent

Returns:

the QueryBatcher that created this event

getClient

public 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.

Specified by:

getClient in interface QueryEvent

Returns:

the DatabaseClient for this batch

getJobBatchNumber

public long getJobBatchNumber()

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

Specified by:

getJobBatchNumber in interface QueryEvent

Returns:

the batch number in this job

getJobResultsSoFar

public long getJobResultsSoFar()

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

Specified by:

getJobResultsSoFar in interface QueryEvent

Returns:

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

getForestBatchNumber

public long getForestBatchNumber()

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

Specified by:

getForestBatchNumber in interface QueryEvent

Returns:

the batch number in this forest

getForestResultsSoFar

public 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.

Specified by:

getForestResultsSoFar in interface QueryEvent

Returns:

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

getLastUriForForest

public java.lang.String getLastUriForForest()

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

Specified by:

getLastUriForForest in interface QueryEvent

Returns:

the last uri in this job in this forest up to the point of this event

getForest

public 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.

Specified by:

getForest in interface QueryEvent

Returns:

the Forest with which this event is associated

getJobTicket

public JobTicket getJobTicket()

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

Specified by:

getJobTicket in interface QueryEvent

Returns:

the JobTicket for this job