Package uk.gov.gchq.gaffer.store

Enum StoreTrait

java.lang.Object

java.lang.Enum<StoreTrait>

uk.gov.gchq.gaffer.store.StoreTrait

All Implemented Interfaces:

Serializable, Comparable<StoreTrait>

public enum StoreTrait
extends Enum<StoreTrait>

A StoreTrait defines functionality for Store implementations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INGEST_AGGREGATION	Similar Elements are aggregated/merged together based on the groupBy logic in the schema at ingest.
MATCHED_VERTEX	Stores with this trait will set the matchedVertex field on Edges for GetElements operations.
ORDERED	Ordered stores keep their elements ordered to optimise lookups.
POST_AGGREGATION_FILTERING	Most stores should have this trait if they deal with Aggregation as if you use Operation.validatePostFilter(Element) in you handlers, it will deal with the filtering for you.
POST_TRANSFORMATION_FILTERING	Most stores should have this trait if they support Transformations as if you use Operation.validatePostTransformationFilter(Element) in you handlers, it will deal with the filtering for you.
PRE_AGGREGATION_FILTERING	Most stores should have this trait if they deal with Aggregation as if you use Operation.validatePreAggregationFilter(Element) in you handlers, it will deal with the filtering for you.
QUERY_AGGREGATION	Similar Elements are aggregated/merged together based on the groupBy logic in the view.
STORE_VALIDATION	Elements will be validated continuously and removed if they are found to be invalid based on Predicates defined in the Schema.
TRANSFORMATION	Element Properties are transformed using Functions defined in a View.
VISIBILITY	Stores with this trait support user-defined visibility settings to prevent authorised access to records which a user does not have permissions to see.

Field Summary

Fields

Modifier and Type	Field	Description
static Set<StoreTrait>	ALL_TRAITS

Method Summary

Modifier and Type	Method	Description
static StoreTrait	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StoreTrait[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INGEST_AGGREGATION

public static final StoreTrait INGEST_AGGREGATION

Similar Elements are aggregated/merged together based on the groupBy logic in the schema at ingest.

QUERY_AGGREGATION

public static final StoreTrait QUERY_AGGREGATION

Similar Elements are aggregated/merged together based on the groupBy logic in the view.

PRE_AGGREGATION_FILTERING

public static final StoreTrait PRE_AGGREGATION_FILTERING

Most stores should have this trait if they deal with Aggregation as if you use Operation.validatePreAggregationFilter(Element) in you handlers, it will deal with the filtering for you. Elements are filtered using Predicates defined in a View.

POST_AGGREGATION_FILTERING

public static final StoreTrait POST_AGGREGATION_FILTERING

Most stores should have this trait if they deal with Aggregation as if you use Operation.validatePostFilter(Element) in you handlers, it will deal with the filtering for you. Elements are filtered using Predicates defined in a View.

POST_TRANSFORMATION_FILTERING

public static final StoreTrait POST_TRANSFORMATION_FILTERING

Most stores should have this trait if they support Transformations as if you use Operation.validatePostTransformationFilter(Element) in you handlers, it will deal with the filtering for you. Elements are filtered using Predicates defined in a View.

TRANSFORMATION

public static final StoreTrait TRANSFORMATION

Element Properties are transformed using Functions defined in a View.

STORE_VALIDATION

public static final StoreTrait STORE_VALIDATION

Elements will be validated continuously and removed if they are found to be invalid based on Predicates defined in the Schema.

ORDERED

public static final StoreTrait ORDERED

Ordered stores keep their elements ordered to optimise lookups. An example of an ordered store is Accumulo, which orders the element keys. Stores that are ordered have special characteristics such as requiring serialisers that preserve ordering of the keyed properties.

VISIBILITY

public static final StoreTrait VISIBILITY

Stores with this trait support user-defined visibility settings to prevent authorised access to records which a user does not have permissions to see.

MATCHED_VERTEX

public static final StoreTrait MATCHED_VERTEX

Stores with this trait will set the matchedVertex field on Edges for GetElements operations.

Field Detail

ALL_TRAITS

public static final Set<StoreTrait> ALL_TRAITS

Method Detail

values

public static StoreTrait[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StoreTrait c : StoreTrait.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StoreTrait valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null