Package uk.gov.gchq.gaffer.store.schema

Class SchemaElementDefinition

java.lang.Object

uk.gov.gchq.gaffer.store.schema.SchemaElementDefinition

All Implemented Interfaces:

Cloneable, ElementDefinition

Direct Known Subclasses:

SchemaEdgeDefinition, SchemaEntityDefinition

public abstract class SchemaElementDefinition
extends Object
implements ElementDefinition

A SchemaElementDefinition is the representation of a single group in a Schema. Each element needs identifiers and can optionally have properties, an aggregator and a validator.

Constructor Summary

Constructors

Constructor	Description
SchemaElementDefinition()

Method Summary

Modifier and Type	Method	Description
boolean	containsIdentifier(IdentifierType identifierType)
boolean	containsProperty(String propertyName)
boolean	equals(Object obj)
Class<?>	getClass(String key)
String	getDescription()
abstract SchemaElementDefinition	getExpandedDefinition()
ElementAggregator	getFullAggregator()
Set<String>	getGroupBy()
Class<?>	getIdentifierClass(IdentifierType idType)
Map<IdentifierType,String>	getIdentifierMap()
Collection<IdentifierType>	getIdentifiers()
String	getIdentifierTypeName(IdentifierType idType)
Collection<String>	getIdentifierTypeNames()
ElementAggregator	getIngestAggregator()
List<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,?>>	getOriginalAggregateFunctions()
ElementAggregator	getOriginalAggregator()
uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate[]	getOriginalValidateFunctions()
ElementFilter	getOriginalValidator()
Set<String>	getProperties()
Class<?>	getPropertyClass(String propertyName)
Map<String,String>	getPropertyMap()
TypeDefinition	getPropertyTypeDef(String property)
Iterable<TypeDefinition>	getPropertyTypeDefs()
String	getPropertyTypeName(String propertyName)
Collection<String>	getPropertyTypeNames()
ElementAggregator	getQueryAggregator(Set<String> viewGroupBy, ElementAggregator viewAggregator)
ElementFilter	getValidator()
ElementFilter	getValidator(boolean includeIsA)
int	hashCode()
boolean	hasValidation()
boolean	isAggregate()
void	lock()	Locks the fields so only read access is allowed.
void	setAggregate(boolean aggregate)
String	toString()
uk.gov.gchq.koryphe.ValidationResult	validate()	Uses the element definition validator to validate the element definition.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SchemaElementDefinition

public SchemaElementDefinition()

Method Detail

validate

public uk.gov.gchq.koryphe.ValidationResult validate()

Uses the element definition validator to validate the element definition.

Returns:

true if the element definition is valid, otherwise false.

getProperties

public Set<String> getProperties()

containsProperty

public boolean containsProperty(String propertyName)

getPropertyMap

public Map<String,String> getPropertyMap()

getIdentifiers

public Collection<IdentifierType> getIdentifiers()

getIdentifierMap

public Map<IdentifierType,String> getIdentifierMap()

containsIdentifier

public boolean containsIdentifier(IdentifierType identifierType)

getPropertyTypeName

public String getPropertyTypeName(String propertyName)

getIdentifierTypeName

public String getIdentifierTypeName(IdentifierType idType)

getPropertyTypeNames

public Collection<String> getPropertyTypeNames()

getIdentifierTypeNames

public Collection<String> getIdentifierTypeNames()

getClass

public Class<?> getClass(String key)

getOriginalAggregator

public ElementAggregator getOriginalAggregator()

getOriginalAggregateFunctions

public List<uk.gov.gchq.koryphe.tuple.binaryoperator.TupleAdaptedBinaryOperator<String,?>> getOriginalAggregateFunctions()

getFullAggregator

public ElementAggregator getFullAggregator()

getIngestAggregator

public ElementAggregator getIngestAggregator()

getQueryAggregator

public ElementAggregator getQueryAggregator(Set<String> viewGroupBy,
                                            ElementAggregator viewAggregator)

getValidator

public ElementFilter getValidator()

getOriginalValidator

public ElementFilter getOriginalValidator()

hasValidation

public boolean hasValidation()

getValidator

public ElementFilter getValidator(boolean includeIsA)

getOriginalValidateFunctions

public uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate[] getOriginalValidateFunctions()

getPropertyTypeDefs

public Iterable<TypeDefinition> getPropertyTypeDefs()

getPropertyTypeDef

public TypeDefinition getPropertyTypeDef(String property)

getPropertyClass

public Class<?> getPropertyClass(String propertyName)

getIdentifierClass

public Class<?> getIdentifierClass(IdentifierType idType)

getGroupBy

public Set<String> getGroupBy()

getDescription

public String getDescription()

getExpandedDefinition

public abstract SchemaElementDefinition getExpandedDefinition()

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

isAggregate

public boolean isAggregate()

setAggregate

public void setAggregate(boolean aggregate)