Package uk.gov.gchq.gaffer.spark.operation.graphframe

Class GetGraphFrameOfElements

java.lang.Object

uk.gov.gchq.gaffer.spark.operation.graphframe.GetGraphFrameOfElements

All Implemented Interfaces:

Closeable, AutoCloseable, GraphFilters, OperationView, Output<org.graphframes.GraphFrame>, Operation

public class GetGraphFrameOfElements
extends Object
implements Output<org.graphframes.GraphFrame>, GraphFilters

An Operation that returns an Apache Spark GraphFrame (i.e. an abstraction over a Dataset of Rows) consisting of the Elementss converted to rows.

This GraphFrame object can be used as the basis for a number of graph processing queries.

See Also:

GetDataFrameOfElements

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetGraphFrameOfElements.Builder

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation

Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>

Constructor Summary

Constructors

Constructor	Description
GetGraphFrameOfElements()

Method Summary

Modifier and Type	Method	Description
List<Converter>	getConverters()
DirectedType	getDirectedType()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<org.graphframes.GraphFrame>	getOutputTypeReference()
View	getView()
void	setConverters(List<Converter> converters)
void	setDirectedType(DirectedType directedType)
void	setOptions(Map<String,String> options)
void	setView(View view)
GetGraphFrameOfElements	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.
uk.gov.gchq.koryphe.ValidationResult	validate()	Validates an operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.operation.graph.GraphFilters

validate, validateFlags

Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation

_getNullOrOptions, addOption, close, containsOption, getOption, getOption, validateRequiredFieldPresent

Methods inherited from interface uk.gov.gchq.gaffer.operation.graph.OperationView

setViews, validate, validate, validatePostAggregationFilter, validatePostTransformFilter, validatePreAggregationFilter

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output

castToOutputType, getOutputClass, getOutputType

Constructor Detail

GetGraphFrameOfElements

public GetGraphFrameOfElements()

Method Detail

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<org.graphframes.GraphFrame> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<org.graphframes.GraphFrame>

getOptions

public Map<String,String> getOptions()

Specified by:

getOptions in interface Operation

Returns:

the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

setOptions

public void setOptions(Map<String,String> options)

Specified by:

setOptions in interface Operation

Parameters:

options - the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

getConverters

public List<Converter> getConverters()

setConverters

public void setConverters(List<Converter> converters)

getView

public View getView()

Specified by:

getView in interface OperationView

Returns:

the View for the operation.

See Also:

View

setView

public void setView(View view)

Specified by:

setView in interface OperationView

Parameters:

view - the View for the operation.

See Also:

View

getDirectedType

public DirectedType getDirectedType()

Specified by:

getDirectedType in interface GraphFilters

setDirectedType

public void setDirectedType(DirectedType directedType)

Specified by:

setDirectedType in interface GraphFilters

validate

public uk.gov.gchq.koryphe.ValidationResult validate()

Description copied from interface: Operation

Validates an operation. This should be used to validate that fields have been be configured correctly. By default no validation is applied. Override this method to implement validation.

Specified by:

validate in interface Operation

Returns:

validation result.

shallowClone

public GetGraphFrameOfElements shallowClone()

Description copied from interface: Operation

Operation implementations should ensure a ShallowClone method is implemented. Performs a shallow clone. Creates a new instance and copies the fields across. It does not clone the fields. If the operation contains nested operations, these must also be cloned.

Specified by:

shallowClone in interface Operation

Returns:

shallow clone