Package uk.gov.gchq.gaffer.graph.hook

Class GraphHookPath

java.lang.Object

uk.gov.gchq.gaffer.graph.hook.GraphHookPath

All Implemented Interfaces:

GraphHook

public class GraphHookPath
extends Object
implements GraphHook

A GraphHookPath allows GraphHooks to be defined as paths to other graph hooks. This should never actually be added to a Graph and should never be executed.

Constructor Summary

Constructors

Constructor	Description
GraphHookPath()

Method Summary

Modifier and Type	Method	Description
String	getPath()
<T> T	onFailure(T result, OperationChain<?> opChain, Context context, Exception e)	Called from Graph if an error occurs whilst executing the OperationChain.
<T> T	postExecute(T result, OperationChain<?> opChain, Context context)	Called from Graph after an OperationChain is executed.
void	preExecute(OperationChain<?> opChain, Context context)	Called from Graph before an OperationChain is executed.
void	setPath(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphHookPath

public GraphHookPath()

Method Detail

preExecute

public void preExecute(OperationChain<?> opChain,
                       Context context)

Description copied from interface: GraphHook

Called from Graph before an OperationChain is executed.

Specified by:

preExecute in interface GraphHook

Parameters:

opChain - the OperationChain being executed. This can be modified/optimised in any GraphHook.

context - the Context in which the operation chain was executed. The context also holds a reference to the original operation chain.

postExecute

public <T> T postExecute(T result,
                         OperationChain<?> opChain,
                         Context context)

Description copied from interface: GraphHook

Called from Graph after an OperationChain is executed.

Specified by:

postExecute in interface GraphHook

Type Parameters:

T - the result type

Parameters:

result - the result from the operation chain

opChain - the OperationChain that was executed. This can be modified/optimised in any GraphHook.

context - the Context in which the operation chain was executed. The context also holds a reference to the original operation chain.

Returns:

result object

onFailure

public <T> T onFailure(T result,
                       OperationChain<?> opChain,
                       Context context,
                       Exception e)

Description copied from interface: GraphHook

Called from Graph if an error occurs whilst executing the OperationChain.

Specified by:

onFailure in interface GraphHook

Type Parameters:

T - the result type

Parameters:

result - the result from the operation chain - likely to be null.

opChain - the OperationChain that was executed. This can be modified/optimised in any GraphHook.

context - the Context in which the operation chain was executed. The context also holds a reference to the original operation chain.

e - the exception

Returns:

result object

getPath

public String getPath()

setPath

public void setPath(String path)