org.nuxeo.ecm.core.bulk.message

Class BulkCommand.Builder

java.lang.Object

org.nuxeo.ecm.core.bulk.message.BulkCommand.Builder

Enclosing class:

BulkCommand

public static class BulkCommand.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action
protected int	batchSize
protected int	bucketSize
protected Map<String,Serializable>	params
protected String	query
protected String	repository
protected String	username

Constructor Summary

Constructors

Constructor and Description
Builder(String action, String nxqlQuery) BulkCommand builder

Method Summary

Modifier and Type	Method and Description
BulkCommand.Builder	batch(int size) The number of documents processed by action within a transaction
BulkCommand.Builder	bucket(int size) The size of a bucket of documents id that fits into a record
BulkCommand	build()
BulkCommand.Builder	param(String key, Serializable value) Add an action parameter
BulkCommand.Builder	params(Map<String,Serializable> params) Set all action parameters
BulkCommand.Builder	repository(String name) Use a non default document repository
BulkCommand.Builder	user(String name) User running the bulk action

Methods inherited from class java.lang.Object

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

Field Detail

action

protected final String action

query

protected final String query

repository

protected String repository

username

protected String username

bucketSize

protected int bucketSize

batchSize

protected int batchSize

params

protected Map<String,Serializable> params

Constructor Detail

Builder

public Builder(String action,
               String nxqlQuery)

BulkCommand builder

Parameters:

action - the registered bulk action name

nxqlQuery - the query that represent the document set to apply the action

Method Detail

repository

public BulkCommand.Builder repository(String name)

Use a non default document repository

user

public BulkCommand.Builder user(String name)

User running the bulk action

bucket

public BulkCommand.Builder bucket(int size)

The size of a bucket of documents id that fits into a record

batch

public BulkCommand.Builder batch(int size)

The number of documents processed by action within a transaction

param

public BulkCommand.Builder param(String key,
                                 Serializable value)

Add an action parameter

params

public BulkCommand.Builder params(Map<String,Serializable> params)

Set all action parameters

build

public BulkCommand build()