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

Class View

java.lang.Object

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

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

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

NamedView

public class View
extends ElementDefinitions<ViewElementDefinition,ViewElementDefinition>
implements Cloneable

The View defines the Elements to be returned for an operation. A view should contain Edge and Entity types required and for each group it can optionally contain an ElementFilter and a ElementTransformer. The Predicates within the ElementFilter describe the how the elements should be filtered. The Functions within ElementTransformer allow transient properties to be created from other properties and identifiers. It also contains any transient properties that are created in transform functions.

See Also:

View.Builder, ViewElementDefinition, ElementFilter, ElementTransformer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	View.BaseBuilder<CHILD_CLASS extends View.BaseBuilder<?>>
static class	View.Builder

Constructor Summary

Constructors

Constructor	Description
View()

Method Summary

Modifier and Type	Method	Description
void	addConfig(String key, String value)
boolean	canMerge(View addingView, View srcView)
View	clone()
boolean	equals(Object obj)
void	expandGlobalDefinitions()	Copies all the global element definitions into the individual element definitions.
static View	fromJson(byte[] jsonBytes)
static View	fromJson(InputStream inputStream)
static View	fromJson(Path filePath)
String	getClassName()
Map<String,String>	getConfig()
String	getConfig(String key)
ViewElementDefinition	getElement(String group)	Looks the group up in the entity definitions then if it doesn't find a definition it will look it up in the edge definitions.
Set<String>	getElementGroupBy(String group)
List<GlobalViewElementDefinition>	getGlobalEdges()
List<GlobalViewElementDefinition>	getGlobalElements()
List<GlobalViewElementDefinition>	getGlobalEntities()
boolean	hasEdgeFilters()
boolean	hasEntityFilters()
int	hashCode()
boolean	hasPostAggregationFilters()
boolean	hasPostTransformFilters()
boolean	hasPreAggregationFilters()
boolean	hasTransform()
boolean	isAllEdges()
boolean	isAllEntities()
void	setAllEdges(boolean allEdges)
void	setAllEntities(boolean allEntities)
byte[]	toCompactJson()
String	toString()

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

getEdge, getEdgeGroups, getEdges, getEntities, getEntity, getEntityGroups, getGroups, hasEdges, hasEntities, hasGroups, isEdge, isEntity, toJson

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

View

public View()

Method Detail

fromJson

public static View fromJson(InputStream inputStream)
                     throws SchemaException

Throws:

SchemaException

fromJson

public static View fromJson(Path filePath)
                     throws SchemaException

Throws:

SchemaException

fromJson

public static View fromJson(byte[] jsonBytes)
                     throws SchemaException

Throws:

SchemaException

toCompactJson

public byte[] toCompactJson()
                     throws SchemaException

Throws:

SchemaException

toString

public String toString()

Overrides:

toString in class ElementDefinitions<ViewElementDefinition,ViewElementDefinition>

getElement

public ViewElementDefinition getElement(String group)

Description copied from class: ElementDefinitions

Looks the group up in the entity definitions then if it doesn't find a definition it will look it up in the edge definitions. If you know the type of the element (Entity or Edge) then use getEntity or getEdge.

Overrides:

getElement in class ElementDefinitions<ViewElementDefinition,ViewElementDefinition>

Parameters:

group - an group

Returns:

the ElementDefinition for the given group

getElementGroupBy

public Set<String> getElementGroupBy(String group)

isAllEntities

public boolean isAllEntities()

setAllEntities

public void setAllEntities(boolean allEntities)

isAllEdges

public boolean isAllEdges()

setAllEdges

public void setAllEdges(boolean allEdges)

getGlobalElements

public List<GlobalViewElementDefinition> getGlobalElements()

getGlobalEntities

public List<GlobalViewElementDefinition> getGlobalEntities()

getGlobalEdges

public List<GlobalViewElementDefinition> getGlobalEdges()

hasPreAggregationFilters

public boolean hasPreAggregationFilters()

hasPostAggregationFilters

public boolean hasPostAggregationFilters()

hasPostTransformFilters

public boolean hasPostTransformFilters()

hasTransform

public boolean hasTransform()

hasEntityFilters

public boolean hasEntityFilters()

hasEdgeFilters

public boolean hasEdgeFilters()

clone

public View clone()

expandGlobalDefinitions

public void expandGlobalDefinitions()

Copies all the global element definitions into the individual element definitions. The global element definitions will then be set to null

getConfig

public Map<String,String> getConfig()

addConfig

public void addConfig(String key,
                      String value)

getConfig

public String getConfig(String key)

canMerge

public boolean canMerge(View addingView,
                        View srcView)

equals

public boolean equals(Object obj)

Overrides:

equals in class ElementDefinitions<ViewElementDefinition,ViewElementDefinition>

hashCode

public int hashCode()

Overrides:

hashCode in class ElementDefinitions<ViewElementDefinition,ViewElementDefinition>

getClassName

public String getClassName()