uk.gov.gchq.gaffer.store

Class ValidatedElements

java.lang.Object

uk.gov.gchq.gaffer.commonutil.iterable.TransformIterable<Element,Element>

uk.gov.gchq.gaffer.store.ValidatedElements

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Element>, CloseableIterable<Element>

public class ValidatedElements
extends TransformIterable<Element,Element>

An ValidatedElements extends TransformIterable and uses an ElementValidator to validate the Elements. It does not transform the element items - just simply returns them if they are valid.

So the resultant Iterable will only contain Elements that have passed the Schema Predicates or View Predicates.

Constructor Summary

Constructors

Constructor and Description
ValidatedElements(Iterable<? extends Element> elements, Schema schema, boolean skipInvalid) Constructs an TransformIterable with the given Iterable of Elements, a Schema containing the Predicates to use to validate the Elements and a skipInvalid flag to determine whether invalid items should be skipped.
ValidatedElements(Iterable<? extends Element> elements, View view, boolean skipInvalid) Constructs an TransformIterable with the given Iterable of Elements, a View containing the Predicates to use to validate the Elements and a skipInvalid flag to determine whether invalid items should be skipped.

Method Summary

Modifier and Type	Method and Description
void	close()

Methods inherited from class uk.gov.gchq.gaffer.commonutil.iterable.TransformIterable

iterator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ValidatedElements

public ValidatedElements(Iterable<? extends Element> elements,
                         Schema schema,
                         boolean skipInvalid)

Constructs an TransformIterable with the given Iterable of Elements, a Schema containing the Predicates to use to validate the Elements and a skipInvalid flag to determine whether invalid items should be skipped.

Parameters:

elements - the input Iterable of Elements

schema - the Schema containing the Predicates to use to validate the Elements.

skipInvalid - if true invalid items should be skipped

ValidatedElements

public ValidatedElements(Iterable<? extends Element> elements,
                         View view,
                         boolean skipInvalid)

Constructs an TransformIterable with the given Iterable of Elements, a View containing the Predicates to use to validate the Elements and a skipInvalid flag to determine whether invalid items should be skipped.

Parameters:

elements - the input Iterable of Elements

view - the View containing the Predicates to use to validate the Elements.

skipInvalid - if true invalid items should be skipped

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableIterable<Element>

Overrides:

close in class TransformIterable<Element,Element>