Package uk.gov.gchq.gaffer.data.elementdefinition.view

Class View.BaseBuilder<CHILD_CLASS extends View.BaseBuilder<?>>

java.lang.Object

uk.gov.gchq.gaffer.data.elementdefinition.ElementDefinitions.BaseBuilder<View,ViewElementDefinition,ViewElementDefinition,CHILD_CLASS>

uk.gov.gchq.gaffer.data.elementdefinition.view.View.BaseBuilder<CHILD_CLASS>

Direct Known Subclasses:

NamedView.BaseBuilder, View.Builder

Enclosing class:

View

public abstract static class View.BaseBuilder<CHILD_CLASS extends View.BaseBuilder<?>>
extends ElementDefinitions.BaseBuilder<View,ViewElementDefinition,ViewElementDefinition,CHILD_CLASS>

Constructor Summary

Constructors

Constructor	Description
BaseBuilder()

Method Summary

Modifier and Type	Method	Description
CHILD_CLASS	allEdges(boolean allEdges)
CHILD_CLASS	allEntities(boolean allEntities)
CHILD_CLASS	config(String key, String value)
CHILD_CLASS	config(Map<String,String> config)
CHILD_CLASS	edge(String group)
CHILD_CLASS	edge(String group, ViewElementDefinition edgeDef)	Adds an edge definition for a given edge type.
CHILD_CLASS	edges(Collection<String> groups)
CHILD_CLASS	entities(Collection<String> groups)
CHILD_CLASS	entity(String group)
CHILD_CLASS	entity(String group, ViewElementDefinition entityDef)	Adds an entity definition for a given entity type.
CHILD_CLASS	expandGlobalDefinitions()
CHILD_CLASS	globalEdges(GlobalViewElementDefinition... globalEdges)
CHILD_CLASS	globalElements(GlobalViewElementDefinition... globalElements)
CHILD_CLASS	globalEntities(GlobalViewElementDefinition... globalEntities)
CHILD_CLASS	json(byte[]... jsonBytes)
CHILD_CLASS	json(InputStream... inputStreams)
CHILD_CLASS	json(Path... filePaths)
CHILD_CLASS	merge(View view)

Methods inherited from class uk.gov.gchq.gaffer.data.elementdefinition.ElementDefinitions.BaseBuilder

addEdges, addEntities, build, edges, entities, json, json, json, json, removeEdges, removeEntities

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseBuilder

public BaseBuilder()

Method Detail

entity

public CHILD_CLASS entity(String group)

entity

public CHILD_CLASS entity(String group,
                          ViewElementDefinition entityDef)

Description copied from class: ElementDefinitions.BaseBuilder

Adds an entity definition for a given entity type.

Overrides:

entity in class ElementDefinitions.BaseBuilder<View,ViewElementDefinition,ViewElementDefinition,CHILD_CLASS extends View.BaseBuilder<?>>

Parameters:

group - the entity type

entityDef - the entity definition for the given entity type.

Returns:

this Builder

entities

public CHILD_CLASS entities(Collection<String> groups)

allEntities

public CHILD_CLASS allEntities(boolean allEntities)

edge

public CHILD_CLASS edge(String group)

edge

public CHILD_CLASS edge(String group,
                        ViewElementDefinition edgeDef)

Description copied from class: ElementDefinitions.BaseBuilder

Adds an edge definition for a given edge type.

Overrides:

edge in class ElementDefinitions.BaseBuilder<View,ViewElementDefinition,ViewElementDefinition,CHILD_CLASS extends View.BaseBuilder<?>>

Parameters:

group - the edge type

edgeDef - the edge definition for the given edge type.

Returns:

this Builder

edges

public CHILD_CLASS edges(Collection<String> groups)

allEdges

public CHILD_CLASS allEdges(boolean allEdges)

config

public CHILD_CLASS config(String key,
                          String value)

config

public CHILD_CLASS config(Map<String,String> config)

globalElements

public CHILD_CLASS globalElements(GlobalViewElementDefinition... globalElements)

globalEntities

public CHILD_CLASS globalEntities(GlobalViewElementDefinition... globalEntities)

globalEdges

public CHILD_CLASS globalEdges(GlobalViewElementDefinition... globalEdges)

json

public CHILD_CLASS json(InputStream... inputStreams)
                 throws SchemaException

Throws:

SchemaException

json

public CHILD_CLASS json(Path... filePaths)
                 throws SchemaException

Throws:

SchemaException

json

public CHILD_CLASS json(byte[]... jsonBytes)
                 throws SchemaException

Throws:

SchemaException

merge

public CHILD_CLASS merge(View view)

expandGlobalDefinitions

public CHILD_CLASS expandGlobalDefinitions()