Package uk.gov.gchq.gaffer.data.generator

Class MapGenerator.Builder

java.lang.Object

uk.gov.gchq.gaffer.data.generator.MapGenerator.Builder

Enclosing class:

MapGenerator

public static class MapGenerator.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MapGenerator	build()	Passes all of the configured information about an Element into a new MapGenerator
MapGenerator.Builder	constant(String key, String value)	Stores any constants specific to a given Element.
MapGenerator.Builder	destination(String mapKey)	Stores the Destination Vertex of an Edge
MapGenerator.Builder	direction(String mapKey)	Stores the Direction flag, indicating whether or not the Edge is directed.
MapGenerator.Builder	group(String mapKey)	Stores the group of an Element.
MapGenerator.Builder	identifier(IdentifierType identifierType, String mapKey)	Allows an IdentifierType of an Element to be stored, such as an Edge's IdentifierType.MATCHED_VERTEX.
MapGenerator.Builder	property(String propertyName, String mapKey)	Stores any additional properties of an Element. For example: property("count", "3"). This would add the "count" property with a value of "3".
MapGenerator.Builder	source(String mapKey)	Stores the Source Vertex of an Edge.
MapGenerator.Builder	vertex(String mapKey)	Stores the Vertex of an Entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

group

public MapGenerator.Builder group(String mapKey)

Stores the group of an Element.

Parameters:

mapKey - the group of the Element

Returns:

a new MapGenerator.Builder

property

public MapGenerator.Builder property(String propertyName,
                                     String mapKey)

Stores any additional properties of an Element.
For example: property("count", "3").
This would add the "count" property with a value of "3".

Parameters:

propertyName - the name of the property

mapKey - the value of the property

Returns:

a new MapGenerator.Builder

vertex

public MapGenerator.Builder vertex(String mapKey)

Stores the Vertex of an Entity.

Parameters:

mapKey - the vertex contained within the Entity

Returns:

a new MapGenerator.Builder

source

public MapGenerator.Builder source(String mapKey)

Stores the Source Vertex of an Edge.

Parameters:

mapKey - the source vertex

Returns:

a new MapGenerator.Builder

destination

public MapGenerator.Builder destination(String mapKey)

Stores the Destination Vertex of an Edge

Parameters:

mapKey - the destination vertex

Returns:

a new MapGenerator.Builder

direction

public MapGenerator.Builder direction(String mapKey)

Stores the Direction flag, indicating whether or not the Edge is directed.

Parameters:

mapKey - true or false for if the Edge is directed or not

Returns:

a new MapGenerator.Builder

identifier

public MapGenerator.Builder identifier(IdentifierType identifierType,
                                       String mapKey)

Allows an IdentifierType of an Element to be stored, such as an Edge's IdentifierType.MATCHED_VERTEX.

Parameters:

identifierType - the IdentifierType of the Element

mapKey - the value for the corresponding field

Returns:

a new MapGenerator.Builder

constant

public MapGenerator.Builder constant(String key,
                                     String value)

Stores any constants specific to a given Element.

Parameters:

key - the name of the constant

value - the value of the constant

Returns:

a new MapGenerator.Builder

build

public MapGenerator build()

Passes all of the configured information about an Element into a new MapGenerator

Returns:

a new MapGenerator, containing all fields and constants