SchemaMigration (uk.gov.gchq.gaffer:gaffer2 2.3.1 API)

java.lang.Object
- uk.gov.gchq.gaffer.graph.hook.migrate.SchemaMigration

All Implemented Interfaces:

GraphHook
```
public class SchemaMigration
extends Object
implements GraphHook
```
A SchemaMigration GraphHook allows an admin to set migration mappings that are then applied on any Operation with output and an OperationView.
To make use of this SchemaMigration the implemented Store must have the Transform trait.
NOTE: This is currently experimental and may not function perfectly.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SchemaMigration.MigrationOutputType

Field Summary

Fields
Modifier and Type Field Description

boolean aggregateAfter

static SchemaMigration.MigrationOutputType DEFAULT_OUTPUT_TYPE

static String TRUE

Constructor Summary

Constructors
Constructor Description

SchemaMigration()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<MigrateElement>`	`getEdges()`
`List<MigrateElement>`	`getEntities()`
`SchemaMigration.MigrationOutputType`	`getOutputType()`
`boolean`	`isAggregateAfter()`
`void`	`preExecute(OperationChain<?> opChain, Context context)`	Called from `Graph` before an `OperationChain` is executed.
`void`	`setAggregateAfter(boolean aggregateAfter)`
`void`	`setEdges(List<MigrateElement> edges)`
`void`	`setEntities(List<MigrateElement> entities)`
`void`	`setOutputType(SchemaMigration.MigrationOutputType outputType)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.gov.gchq.gaffer.graph.hook.GraphHook
onFailure, postExecute

Field Detail

DEFAULT_OUTPUT_TYPE

public static final SchemaMigration.MigrationOutputType DEFAULT_OUTPUT_TYPE

TRUE
```
public static final String TRUE
```

aggregateAfter
```
public boolean aggregateAfter
```

Constructor Detail
- SchemaMigration
```
public SchemaMigration()
```

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.

getEntities

public List<MigrateElement> getEntities()

setEntities

public void setEntities(List<MigrateElement> entities)

getEdges

public List<MigrateElement> getEdges()

setEdges

public void setEdges(List<MigrateElement> edges)

getOutputType

public SchemaMigration.MigrationOutputType getOutputType()

setOutputType

public void setOutputType(SchemaMigration.MigrationOutputType outputType)

isAggregateAfter
```
public boolean isAggregateAfter()
```

setAggregateAfter

public void setAggregateAfter(boolean aggregateAfter)