Package net.solarnetwork.dao

Class BasicBatchOptions

java.lang.Object

net.solarnetwork.dao.BasicBatchOptions

All Implemented Interfaces:

BatchableDao.BatchOptions

public class BasicBatchOptions
extends Object
implements BatchableDao.BatchOptions

Basic implementation of BatchableDao.BatchOptions.

Since:

1.74

Version:

1.0

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BATCH_NAME	A default batch name.
static final int	DEFAULT_BATCH_SIZE	A default batch size.

Constructor Summary

Constructors

Constructor	Description
BasicBatchOptions()	Default constructor.
BasicBatchOptions(String name)	Construct with a name.
BasicBatchOptions(String name, int batchSize, boolean updatable, Map<String,Object> parameters)	Construct with values.

Method Summary

Modifier and Type	Method	Description
int	getBatchSize()	Get a batch size hint.
String	getName()	Get a unique name for this batch operation.
Map<String,Object>	getParameters()	Get optional additional parameters, implementation specific.
boolean	isUpdatable()	If true the batch should be updatable.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BATCH_NAME

public static final String DEFAULT_BATCH_NAME

A default batch name.

See Also:

• Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

A default batch size.

See Also:

• Constant Field Values

Constructor Details

BasicBatchOptions

public BasicBatchOptions()

Default constructor.

BasicBatchOptions

public BasicBatchOptions(String name)

Construct with a name.

Parameters:

name - the name

BasicBatchOptions

public BasicBatchOptions(String name,
 int batchSize,
 boolean updatable,
 Map<String,Object> parameters)

Construct with values.

Parameters:

name - the name

batchSize - the size

updatable - updatable

parameters - the parameters

Method Details

getName

public String getName()

Description copied from interface: BatchableDao.BatchOptions

Get a unique name for this batch operation.

Specified by:

getName in interface BatchableDao.BatchOptions

Returns:

a name

getBatchSize

public int getBatchSize()

Description copied from interface: BatchableDao.BatchOptions

Get a batch size hint.

Specified by:

getBatchSize in interface BatchableDao.BatchOptions

Returns:

a batch size

isUpdatable

public boolean isUpdatable()

Description copied from interface: BatchableDao.BatchOptions

If true the batch should be updatable.

Specified by:

isUpdatable in interface BatchableDao.BatchOptions

Returns:

boolean

getParameters

public Map<String,Object> getParameters()

Description copied from interface: BatchableDao.BatchOptions

Get optional additional parameters, implementation specific.

Specified by:

getParameters in interface BatchableDao.BatchOptions

Returns:

parameters