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

Class ViewElementDefinition

java.lang.Object

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

All Implemented Interfaces:

Cloneable, ElementDefinition

Direct Known Subclasses:

GlobalViewElementDefinition

public class ViewElementDefinition
extends Object
implements ElementDefinition

A ViewElementDefinition is an ElementDefinition containing transient properties, an ElementTransformer and two ElementFilters.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ViewElementDefinition()

Method Summary

Modifier and Type	Method	Description
ViewElementDefinition	clone()
boolean	containsTransientProperty(String propertyName)
boolean	equals(Object obj)
ElementAggregator	getAggregator()
Set<String>	getExcludeProperties()
Set<String>	getGroupBy()
ElementFilter	getPostAggregationFilter()
List<uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate<String,?>>	getPostAggregationFilterFunctions()
ElementFilter	getPostTransformFilter()
List<uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate<String,?>>	getPostTransformFilterFunctions()
ElementFilter	getPreAggregationFilter()
List<uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate<String,?>>	getPreAggregationFilterFunctions()
Set<String>	getProperties()
ElementTransformer	getTransformer()
List<uk.gov.gchq.koryphe.tuple.function.TupleAdaptedFunction<String,?,?>>	getTransformFunctions()
Set<String>	getTransientProperties()
Class<?>	getTransientPropertyClass(String propertyName)
Collection<Class<?>>	getTransientPropertyClasses()
Map<String,Class<?>>	getTransientPropertyMap()
Map<String,String>	getTransientPropertyMapWithClassNames()
int	hashCode()
boolean	hasPostAggregationFilters()
boolean	hasPostTransformFilters()
boolean	hasPreAggregationFilters()
boolean	hasProperty(String property)
boolean	hasTransform()
boolean	isAllProperties()
boolean	isEmpty()
void	lock()	Locks the fields so only read access is allowed.
void	setGroupBy(LinkedHashSet<String> groupBy)
byte[]	toCompactJson()
byte[]	toJson(boolean prettyPrint, String... fieldsToExclude)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewElementDefinition

public ViewElementDefinition()

Method Detail

isEmpty

public boolean isEmpty()

getGroupBy

public Set<String> getGroupBy()

setGroupBy

public void setGroupBy(LinkedHashSet<String> groupBy)

getProperties

public Set<String> getProperties()

getExcludeProperties

public Set<String> getExcludeProperties()

isAllProperties

public boolean isAllProperties()

hasProperty

public boolean hasProperty(String property)

getTransientPropertyClass

public Class<?> getTransientPropertyClass(String propertyName)

getTransientPropertyClasses

public Collection<Class<?>> getTransientPropertyClasses()

getTransientProperties

public Set<String> getTransientProperties()

containsTransientProperty

public boolean containsTransientProperty(String propertyName)

getTransientPropertyMap

public Map<String,Class<?>> getTransientPropertyMap()

Returns:

the transient property map. LinkedHashMap of transient property name to class name.

getTransientPropertyMapWithClassNames

public Map<String,String> getTransientPropertyMapWithClassNames()

getPreAggregationFilter

public ElementFilter getPreAggregationFilter()

getPreAggregationFilterFunctions

public List<uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate<String,?>> getPreAggregationFilterFunctions()

hasPreAggregationFilters

public boolean hasPreAggregationFilters()

getAggregator

public ElementAggregator getAggregator()

getPostAggregationFilter

public ElementFilter getPostAggregationFilter()

getPostAggregationFilterFunctions

public List<uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate<String,?>> getPostAggregationFilterFunctions()

hasPostAggregationFilters

public boolean hasPostAggregationFilters()

getPostTransformFilter

public ElementFilter getPostTransformFilter()

getPostTransformFilterFunctions

public List<uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate<String,?>> getPostTransformFilterFunctions()

hasPostTransformFilters

public boolean hasPostTransformFilters()

hasTransform

public boolean hasTransform()

getTransformer

public ElementTransformer getTransformer()

getTransformFunctions

public List<uk.gov.gchq.koryphe.tuple.function.TupleAdaptedFunction<String,?,?>> getTransformFunctions()

clone

public ViewElementDefinition clone()

toJson

public byte[] toJson(boolean prettyPrint,
                     String... fieldsToExclude)
              throws SchemaException

Throws:

SchemaException

toCompactJson

public byte[] toCompactJson()
                     throws SchemaException

Throws:

SchemaException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

lock

public void lock()

Description copied from interface: ElementDefinition

Locks the fields so only read access is allowed.

Specified by:

lock in interface ElementDefinition