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

Class CsvGenerator.Builder

java.lang.Object

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

Enclosing class:

CsvGenerator

public static class CsvGenerator.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CsvGenerator	build()	Passes all the configured fields and constants about an Element to a new CsvGenerator, including the comma replacement String, and the flag for whether values should be quoted.
CsvGenerator.Builder	commaReplacement(String commaReplacement)	Stores the String with which any encountered commas will be replaced.
CsvGenerator.Builder	constant(String key, String value)	Stores any constants specific to a given Element.
CsvGenerator.Builder	destination(String columnHeader)	Stores the Destination Vertex of an Entity
CsvGenerator.Builder	direction(String columnHeader)	Stores the Direction flag, indicating whether or not the Edge is directed.
CsvGenerator.Builder	edgeGroup(String columnHeader)	Stores the group of an Edge on a seperate column.
CsvGenerator.Builder	entityGroup(String columnHeader)	Stores the group of an Entity on a seperate column.
CsvGenerator.Builder	group(String columnHeader)	Stores the group of an Element.
CsvGenerator.Builder	identifier(IdentifierType identifierType, String columnHeader)	Allows an IdentifierType of an Element to be stored, such as an Edge's IdentifierType.MATCHED_VERTEX.
CsvGenerator.Builder	property(String propertyName, String columnHeader)	Stores any additional properties of an Element. For example: property("count", "3"). This would add the "count" property with a value of "3"
CsvGenerator.Builder	quoted(boolean quoted)	Stores the flag for whether or not each distinct value should be wrapped in quotation marks.
CsvGenerator.Builder	setAdditionalFieldsFromSchemaProperties(LinkedHashMap<String,Class<?>> schemaProperties)	Saves all properties from the schema which be added to fields.
CsvGenerator.Builder	source(String columnHeader)	Stores the Source Vertex of an Edge.
CsvGenerator.Builder	vertex(String columnHeader)	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 CsvGenerator.Builder group(String columnHeader)

Stores the group of an Element.

Parameters:

columnHeader - the group of the Element

Returns:

a new CsvGenerator.Builder

entityGroup

public CsvGenerator.Builder entityGroup(String columnHeader)

Stores the group of an Entity on a seperate column.

Parameters:

columnHeader - the group of the Entity

Returns:

a new CsvGenerator.Builder

edgeGroup

public CsvGenerator.Builder edgeGroup(String columnHeader)

Stores the group of an Edge on a seperate column.

Parameters:

columnHeader - the group of the Edge

Returns:

a new CsvGenerator.Builder

property

public CsvGenerator.Builder property(String propertyName,
                                     String columnHeader)

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

columnHeader - the value of the property

Returns:

a new CsvGenerator.Builder

vertex

public CsvGenerator.Builder vertex(String columnHeader)

Stores the Vertex of an Entity

Parameters:

columnHeader - the vertex contained within the Entity

Returns:

a new CsvGenerator.Builder

source

public CsvGenerator.Builder source(String columnHeader)

Stores the Source Vertex of an Edge.

Parameters:

columnHeader - the source vertex

Returns:

a new CsvGenerator.Builder

destination

public CsvGenerator.Builder destination(String columnHeader)

Stores the Destination Vertex of an Entity

Parameters:

columnHeader - the destination vertex

Returns:

a new CsvGenerator.Builder

direction

public CsvGenerator.Builder direction(String columnHeader)

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

Parameters:

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

Returns:

a new CsvGenerator.Builder

identifier

public CsvGenerator.Builder identifier(IdentifierType identifierType,
                                       String columnHeader)

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

Parameters:

identifierType - the IdentifierType of the Element

columnHeader - the value for the corresponding field

Returns:

a new CsvGenerator.Builder

constant

public CsvGenerator.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 CsvGenerator.Builder

setAdditionalFieldsFromSchemaProperties

public CsvGenerator.Builder setAdditionalFieldsFromSchemaProperties(LinkedHashMap<String,Class<?>> schemaProperties)

Saves all properties from the schema which be added to fields.

Parameters:

schemaProperties - the Map of property names to type

Returns:

a new CsvGenerator.Builder

commaReplacement

public CsvGenerator.Builder commaReplacement(String commaReplacement)

Stores the String with which any encountered commas will be replaced.

Parameters:

commaReplacement - the replacement String

Returns:

a new CsvGenerator.Builder

quoted

public CsvGenerator.Builder quoted(boolean quoted)

Stores the flag for whether or not each distinct value should be wrapped in quotation marks.

Parameters:

quoted - true or false

Returns:

a new CsvGenerator.Builder

build

public CsvGenerator build()

Passes all the configured fields and constants about an Element to a new CsvGenerator, including the comma replacement String, and the flag for whether values should be quoted.

Returns:

a new CsvGenerator, containing all configured information