com.delphix.masking.api.plugin.utils

Class RunnableBatch<T>

java.lang.Object

com.delphix.masking.api.plugin.utils.RunnableBatch<T>

All Implemented Interfaces:

MaskingBatch<T>, java.lang.Runnable

public class RunnableBatch<T>
extends java.lang.Object
implements MaskingBatch<T>, java.lang.Runnable

This class provides a basic implementation of the MaskingBatch interface.

Constructor Summary

Constructors

Constructor and Description
RunnableBatch(MaskingAlgorithm<T> algorithmIn) Create a runnable batch associated with a particular algorithm.
RunnableBatch(MaskingAlgorithm<T> algorithmIn, int batchSize) Create a runnable batch associated with a particular algorithm.

Method Summary

Modifier and Type	Method and Description
void	add(T item) Add new value to be masked to the batch.
void	clear() Reset the batch.
java.util.List<T>	getAllValues() Get the masked value list associated with this batch.
java.lang.Exception	getError(int index) Get the error that occurred when masking a particular item in a batch.
T	getValue(int index) Get the value to be masked at a particular index from the batch.
void	run() Run the batch.
void	setError(int index, MaskingException e) Set the error that occurred when masking a particular item in a batch.
void	setGeneralError(java.lang.Exception e) This method is called when a general failure occurs with the algorithm.
void	setValue(int index, T value) Set the masking result at a particular index in the batch.
int	size() Get the size of the batch.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunnableBatch

public RunnableBatch(MaskingAlgorithm<T> algorithmIn)

Create a runnable batch associated with a particular algorithm.

Parameters:

algorithmIn - The algorithm to use when running the batch.

RunnableBatch

public RunnableBatch(MaskingAlgorithm<T> algorithmIn,
                     int batchSize)

Create a runnable batch associated with a particular algorithm. This method will perform slightly better when the batch size is known in advance. The batch may grow larger than the initial size.

Parameters:

algorithmIn - The algorithm to use when running the batch.

batchSize - The initial size of the batch.

Method Detail

getValue

public T getValue(int index)

Description copied from interface: MaskingBatch

Get the value to be masked at a particular index from the batch.

Specified by:

getValue in interface MaskingBatch<T>

Parameters:

index - The index of the value to get, in the range of 0 to size - 1

Returns:

The value to be masked

getAllValues

public java.util.List<T> getAllValues()

Get the masked value list associated with this batch.

Returns:

The list of values.

setValue

public void setValue(int index,
                     T value)

Description copied from interface: MaskingBatch

Set the masking result at a particular index in the batch.

Specified by:

setValue in interface MaskingBatch<T>

Parameters:

index - The index of the value to set, in the range of 0 to size - 1

value - The masked value

getError

public java.lang.Exception getError(int index)

Get the error that occurred when masking a particular item in a batch.

Parameters:

index - The index of value that was being masked when the error occurred, in the range of 0 to size - 1

Returns:

The error that occurred.

setError

public void setError(int index,
                     @Nonnull
                     MaskingException e)

Description copied from interface: MaskingBatch

Set the error that occurred when masking a particular item in a batch. All value-specific masking errors should be reported using this method rather throwing an exception directly from MaskingAlgorithm.maskBatch(com.delphix.masking.api.plugin.MaskingBatch<T>).

Specified by:

setError in interface MaskingBatch<T>

Parameters:

index - The index of value that was being masked when the error occurred, in the range of 0 to size - 1

e - The error that occurred.

setGeneralError

public void setGeneralError(java.lang.Exception e)

This method is called when a general failure occurs with the algorithm. Every maskable row is marked with this error.

Parameters:

e - The error that occurred

clear

public void clear()

Reset the batch.

size

public int size()

Description copied from interface: MaskingBatch

Get the size of the batch.

Specified by:

size in interface MaskingBatch<T>

Returns:

The size of the batch

add

public void add(T item)

Add new value to be masked to the batch.

Parameters:

item - The value to be masked

run

public void run()

Run the batch.

Specified by:

run in interface java.lang.Runnable