uk.gov.gchq.gaffer.store.schema

Class Schema

java.lang.Object

uk.gov.gchq.gaffer.data.elementdefinition.ElementDefinitions<SchemaEntityDefinition,SchemaEdgeDefinition>

uk.gov.gchq.gaffer.store.schema.Schema

All Implemented Interfaces:

Cloneable

public class Schema
extends ElementDefinitions<SchemaEntityDefinition,SchemaEdgeDefinition>
implements Cloneable

Contains the full list of Element types to be stored in the graph.

Each type of element should have the identifier type(s) listed and a map of property names and their corresponding types. Each type can either be a full java class name or a custom type. Using custom types then allows you to specify validation and aggregation for the element components.

This class must be JSON serialisable. A schema should normally be written in JSON and then it will be automatically deserialised at runtime. An example of a JSON schemas can be found in the Example module.

See Also:

Schema.Builder, ElementDefinitions

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Schema()

Method Summary

Modifier and Type	Method and Description
void	addConfig(String key, String value)
Schema	clone()
static Schema	fromJson(byte[]... jsonBytes)
static Schema	fromJson(InputStream... inputStreams)
static Schema	fromJson(Path... filePaths)
List<String>	getAggregatedGroups()
Map<String,String>	getConfig()
String	getConfig(String key)
SchemaElementDefinition	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.
String	getId() Deprecated. the ID should be supplied to the graph library separately
String	getTimestampProperty() Deprecated. use a store property specific to your chosen store instead.
TypeDefinition	getType(String typeName)
Map<String,TypeDefinition>	getTypes()
Serialiser	getVertexSerialiser() Returns the vertex serialiser for this schema.
String	getVertexSerialiserClass() Deprecated.
String	getVisibilityProperty()
boolean	hasValidation()
boolean	isAggregationEnabled() Checks the schema has aggregators.
void	setId(String id) Deprecated. the ID should be supplied to the graph library separately
byte[]	toCompactJson()
String	toString()
uk.gov.gchq.koryphe.ValidationResult	validate() Validates the schema to ensure all element definitions are valid.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Schema

public Schema()

Method Detail

fromJson

public static Schema fromJson(InputStream... inputStreams)
                       throws SchemaException

Throws:

SchemaException

fromJson

public static Schema fromJson(Path... filePaths)
                       throws SchemaException

Throws:

SchemaException

fromJson

public static Schema fromJson(byte[]... jsonBytes)
                       throws SchemaException

Throws:

SchemaException

getId

@Deprecated
public String getId()

Deprecated. the ID should be supplied to the graph library separately

Returns:

schema id

setId

@Deprecated
public void setId(String id)

Deprecated. the ID should be supplied to the graph library separately

Parameters:

id - the schema id

clone

public Schema clone()

Overrides:

clone in class Object

isAggregationEnabled

public boolean isAggregationEnabled()

Checks the schema has aggregators.

Returns:

true if the schema contains aggregators, otherwise false

getAggregatedGroups

public List<String> getAggregatedGroups()

validate

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

Validates the schema to ensure all element definitions are valid. Throws a SchemaException if it is not valid.

Returns:

ValidationResult the validation result

Throws:

SchemaException - if validation fails then a SchemaException is thrown.

hasValidation

public boolean hasValidation()

getTypes

public Map<String,TypeDefinition> getTypes()

getType

public TypeDefinition getType(String typeName)

getVertexSerialiser

public Serialiser getVertexSerialiser()

Returns the vertex serialiser for this schema.

There can be only one vertex serialiser for all elements because in order for searches to work correctly, the byte representation of the search term's (seeds) must match the byte representation stored, i.e you need to know how your results have been serialised which effectively means all vertices must be serialised the same way within a table.

Returns:

An implementation of Serialiser that will be used to serialise all vertices.

getVertexSerialiserClass

@Deprecated
public String getVertexSerialiserClass()

Deprecated.

getElement

public SchemaElementDefinition 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<SchemaEntityDefinition,SchemaEdgeDefinition>

Parameters:

group - an group

Returns:

the ElementDefinition for the given group

getVisibilityProperty

public String getVisibilityProperty()

getTimestampProperty

@Deprecated
public String getTimestampProperty()

Deprecated. use a store property specific to your chosen store instead.

Returns:

the timestamp property

getConfig

public Map<String,String> getConfig()

getConfig

public String getConfig(String key)

addConfig

public void addConfig(String key,
                      String value)

toString

public String toString()

Overrides:

toString in class ElementDefinitions<SchemaEntityDefinition,SchemaEdgeDefinition>

toCompactJson

public byte[] toCompactJson()
                     throws SchemaException

Throws:

SchemaException