Package uk.gov.gchq.gaffer.store.operation.handler

Class WhileHandler

java.lang.Object

uk.gov.gchq.gaffer.store.operation.handler.WhileHandler

All Implemented Interfaces:

OperationHandler<While<Object,Object>>, OutputOperationHandler<While<Object,Object>,Object>

Direct Known Subclasses:

FederatedWhileHandler

public class WhileHandler
extends Object
implements OutputOperationHandler<While<Object,Object>,Object>

An operation handler for While operations.

The default handler has a maxRepeats field that can be overridden by system administrators. The default value is set to 1000. To update this value, create an operation declarations JSON file containing the While operation and your configured WhileHandler. E.g:

 {
     "operations": [
         {
             "operation": "uk.gov.gchq.gaffer.operation.impl.While",
             "handler": {
                 "class": "uk.gov.gchq.gaffer.store.operation.handler.WhileHandler",
                 "maxRepeats": 10
             }
         }
     ]
 }
 

and then register a path to the json file in your store properties using the key gaffer.store.operation.declarations.

Constructor Summary

Constructors

Constructor	Description
WhileHandler()

Method Summary

Modifier and Type	Method	Description
Object	doDelegateOperation(Object input, Operation delegate, Context context, Store store)
Object	doOperation(While operation, Context context, Store store)	Execute the given Output operation.
int	getMaxRepeats()
boolean	isSatisfied(Object input, While operation, Context context, Store store)
void	setMaxRepeats(int maxRepeats)
void	validateMaxRepeats(While operation)

Methods inherited from class java.lang.Object

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

Constructor Detail

WhileHandler

public WhileHandler()

Method Detail

doOperation

public Object doOperation(While operation,
                          Context context,
                          Store store)
                   throws OperationException

Description copied from interface: OutputOperationHandler

Execute the given Output operation.

Specified by:

doOperation in interface OperationHandler<While<Object,Object>>

Specified by:

doOperation in interface OutputOperationHandler<While<Object,Object>,Object>

Parameters:

operation - the Output operation to be executed

context - the operation chain context, containing the user who executed the operation

store - the Store the operation should be run on

Returns:

the output for the operation.

Throws:

OperationException - thrown if the operation fails

validateMaxRepeats

public void validateMaxRepeats(While operation)
                        throws OperationException

Throws:

OperationException

doDelegateOperation

public Object doDelegateOperation(Object input,
                                  Operation delegate,
                                  Context context,
                                  Store store)
                           throws OperationException

Throws:

OperationException

isSatisfied

public boolean isSatisfied(Object input,
                           While operation,
                           Context context,
                           Store store)
                    throws OperationException

Throws:

OperationException

getMaxRepeats

public int getMaxRepeats()

setMaxRepeats

public void setMaxRepeats(int maxRepeats)