Package uk.gov.gchq.gaffer.operation.graph

Interface OperationView

All Known Subinterfaces:

GraphFilters, SeededGraphFilters

All Known Implementing Classes:

GetAdjacentIds, GetAllElements, GetDataFrameOfElements, GetElements, GetElementsBetweenSets, GetElementsBetweenSetsPairs, GetElementsInRanges, GetElementsWithinSet, GetGraphFrameOfElements, GetJavaRDDOfAllElements, GetJavaRDDOfElements, GetJavaRDDOfElementsInRanges, GetRDDOfAllElements, GetRDDOfElements, GetRDDOfElementsInRanges, SummariseGroupOverRanges

public interface OperationView

An OperationView operation contains a View and can carry out additional validation based on the view contents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OperationView.Builder<OP extends OperationView,B extends OperationView.Builder<OP,?>>

Method Summary

Modifier and Type	Method	Description
View	getView()
static boolean	hasView(OperationView op)
static boolean	hasView(Operation op)
void	setView(View view)
default void	setViews(List<View> views)	Merges a list of Views, including the current if set, and sets the OperationView to the new merged View.
default boolean	validate(Edge edge)
default boolean	validate(Element element)
default boolean	validate(Entity entity)
default boolean	validatePostAggregationFilter(Element element)	Validates an element against the post aggregation filters contained in the operation View.
default boolean	validatePostTransformFilter(Element element)	Validates an element against the post transform filters contained in the operation View.
default boolean	validatePreAggregationFilter(Element element)	Validates an element against the pre aggregation contained in the operation View.

Method Detail

getView

View getView()

Returns:

the View for the operation.

See Also:

View

setView

void setView(View view)

Parameters:

view - the View for the operation.

See Also:

View

validate

default boolean validate(Element element)

Parameters:

element - the Element to be validated.

Returns:

true if the Element is valid. Otherwise false and a reason should be logged.

If the element class is known then validate(Entity) or validate(Edge) should be called instead to avoid unnecessary use of instanceof.

See Also:

validate(Entity), validate(Edge)

validate

default boolean validate(Edge edge)

Parameters:

edge - the Edge to be validated.

Returns:

true if the Edge is valid. Otherwise false and a reason should be logged.

validate

default boolean validate(Entity entity)

Parameters:

entity - the Entity to be validated.

Returns:

true if the Entity is valid. Otherwise false and a reason should be logged.

validatePreAggregationFilter

default boolean validatePreAggregationFilter(Element element)

Validates an element against the pre aggregation contained in the operation View.

Parameters:

element - the element to validate

Returns:

true if the element is validate

validatePostAggregationFilter

default boolean validatePostAggregationFilter(Element element)

Validates an element against the post aggregation filters contained in the operation View.

Parameters:

element - the element to validate

Returns:

true if the element is validate

validatePostTransformFilter

default boolean validatePostTransformFilter(Element element)

Validates an element against the post transform filters contained in the operation View.

Parameters:

element - the element to validate

Returns:

true if the element is validate

setViews

default void setViews(List<View> views)

Merges a list of Views, including the current if set, and sets the OperationView to the new merged View.

Parameters:

views - the list of views to merge

hasView

static boolean hasView(Operation op)

hasView

static boolean hasView(OperationView op)