com.marklogic.client.datamovement

Interface Batch<T>

All Known Subinterfaces:

QueryBatch, WriteBatch

public interface Batch<T>

A group of items (generally documents or uris) and context representing a completed action in a datamovement job.

Method Summary

Modifier and Type	Method and Description
DatabaseClient	getClient() The DatabaseClient used to send or retrieve this batch.
T[]	getItems() The documents read by WriteBatcher or the uris retrieved by QueryBatcher.
long	getJobBatchNumber() Within the context of the job, the numeric position of this batch.
JobTicket	getJobTicket() The ticket for this job.
Calendar	getTimestamp() The client-side timestamp when this batch completed writing or reading.

Method Detail

getItems

T[] getItems()

The documents read by WriteBatcher or the uris retrieved by QueryBatcher.

Returns:

the items in this batch

getTimestamp

Calendar getTimestamp()

The client-side timestamp when this batch completed writing or reading.

Returns:

the client timestamp when this batch completed

getJobBatchNumber

long getJobBatchNumber()

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

Returns:

the batch number

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

getClient

DatabaseClient getClient()

The DatabaseClient used to send or retrieve this batch. This is useful for performing additional operations on the same host.

Returns:

the DatabaseClient for this batch