Package uk.gov.gchq.gaffer.accumulostore.key.core

Class AbstractCoreKeyIteratorSettingsFactory

java.lang.Object

uk.gov.gchq.gaffer.accumulostore.key.core.AbstractCoreKeyIteratorSettingsFactory

All Implemented Interfaces:

IteratorSettingFactory

Direct Known Subclasses:

ByteEntityIteratorSettingsFactory, ClassicIteratorSettingsFactory

public abstract class AbstractCoreKeyIteratorSettingsFactory
extends Object
implements IteratorSettingFactory

Constructor Summary

Constructors

Constructor	Description
AbstractCoreKeyIteratorSettingsFactory()

Method Summary

Modifier and Type	Method	Description
org.apache.accumulo.core.client.IteratorSetting	getAggregatorIteratorSetting(AccumuloStore store)	Returns an Iterator that will aggregate values in the accumulo table, this iterator will be applied to the table on creation
org.apache.accumulo.core.client.IteratorSetting	getBloomFilterIteratorSetting(org.apache.hadoop.util.bloom.BloomFilter filter)	Returns an IteratorSetting that can be used to apply an iterator that will filter elements based on their vertices membership in a given BloomFilter to a Scanner.
org.apache.accumulo.core.client.IteratorSetting	getElementPostAggregationFilterIteratorSetting(View view, AccumuloStore store)	Returns an IteratorSetting that can be used to apply an iterator that will filter elements based on predicates specified in the postAggregation block in the view to a Scanner.
org.apache.accumulo.core.client.IteratorSetting	getElementPreAggregationFilterIteratorSetting(View view, AccumuloStore store)	Returns an IteratorSetting that can be used to apply an iterator that will filter elements based on predicates specified in the preAggregation block in the view to a Scanner.
org.apache.accumulo.core.client.IteratorSetting	getIteratorSetting(AccumuloStore store, String iteratorName)	Returns the iterator settings for a given iterator name.
org.apache.accumulo.core.client.IteratorSetting	getQueryTimeAggregatorIteratorSetting(View view, AccumuloStore store)	Returns an Iterator that will aggregate values at query time.
org.apache.accumulo.core.client.IteratorSetting	getRowIDAggregatorIteratorSetting(AccumuloStore store, String columnFamily)	Returns an Iterator that will aggregate properties across a range of RowID's for a given columnFamily
org.apache.accumulo.core.client.IteratorSetting	getValidatorIteratorSetting(AccumuloStore store)	Returns an Iterator that will validate elements in the accumulo table based on the validator provided in the Schema this iterator will be applied to the table on creation
boolean	queryTimeAggregatorRequired(View view, AccumuloStore store)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.accumulostore.key.IteratorSettingFactory

getEdgeEntityDirectionFilterIteratorSetting, getElementPropertyRangeQueryFilter

Constructor Detail

AbstractCoreKeyIteratorSettingsFactory

public AbstractCoreKeyIteratorSettingsFactory()

Method Detail

getBloomFilterIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getBloomFilterIteratorSetting(org.apache.hadoop.util.bloom.BloomFilter filter)
                                                                              throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns an IteratorSetting that can be used to apply an iterator that will filter elements based on their vertices membership in a given BloomFilter to a Scanner.

Specified by:

getBloomFilterIteratorSetting in interface IteratorSettingFactory

Parameters:

filter - the bloom filter

Returns:

A new IteratorSetting for an Iterator capable of filtering elements based on checking its serialised form for membership in a BloomFilter

Throws:

IteratorSettingException - if an iterator setting could not be created

getElementPreAggregationFilterIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getElementPreAggregationFilterIteratorSetting(View view,
                                                                                                     AccumuloStore store)
                                                                                              throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns an IteratorSetting that can be used to apply an iterator that will filter elements based on predicates specified in the preAggregation block in the view to a Scanner.

Specified by:

getElementPreAggregationFilterIteratorSetting in interface IteratorSettingFactory

Parameters:

view - the operation view

store - the accumulo store

Returns:

A new IteratorSetting for an Iterator capable of filtering Elements based on a View

Throws:

IteratorSettingException - if an iterator setting could not be created

getElementPostAggregationFilterIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getElementPostAggregationFilterIteratorSetting(View view,
                                                                                                      AccumuloStore store)
                                                                                               throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns an IteratorSetting that can be used to apply an iterator that will filter elements based on predicates specified in the postAggregation block in the view to a Scanner.

Specified by:

getElementPostAggregationFilterIteratorSetting in interface IteratorSettingFactory

Parameters:

view - the operation view

store - the accumulo store

Returns:

A new IteratorSetting for an Iterator capable of filtering Elements based on a View

Throws:

IteratorSettingException - if an iterator setting could not be created

getAggregatorIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getAggregatorIteratorSetting(AccumuloStore store)
                                                                             throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns an Iterator that will aggregate values in the accumulo table, this iterator will be applied to the table on creation

Specified by:

getAggregatorIteratorSetting in interface IteratorSettingFactory

Parameters:

store - the accumulo store

Returns:

A new IteratorSetting for an Iterator that will aggregate elements where they have the same key based on the Schema

Throws:

IteratorSettingException - if an iterator setting could not be created

getRowIDAggregatorIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getRowIDAggregatorIteratorSetting(AccumuloStore store,
                                                                                         String columnFamily)
                                                                                  throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns an Iterator that will aggregate properties across a range of RowID's for a given columnFamily

Specified by:

getRowIDAggregatorIteratorSetting in interface IteratorSettingFactory

Parameters:

store - the accumulo store

columnFamily - the columnFamily that will be summarised

Returns:

A new IteratorSetting for an Iterator that will aggregate elements at query time on the Schema

Throws:

IteratorSettingException - if an iterator setting could not be created

getValidatorIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getValidatorIteratorSetting(AccumuloStore store)

Description copied from interface: IteratorSettingFactory

Returns an Iterator that will validate elements in the accumulo table based on the validator provided in the Schema this iterator will be applied to the table on creation

Specified by:

getValidatorIteratorSetting in interface IteratorSettingFactory

Parameters:

store - the accumulo store

Returns:

A new IteratorSetting for an Iterator that will validate elements

getQueryTimeAggregatorIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getQueryTimeAggregatorIteratorSetting(View view,
                                                                                             AccumuloStore store)
                                                                                      throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns an Iterator that will aggregate values at query time. This is to be used for the summarise option on getElement queries.

Specified by:

getQueryTimeAggregatorIteratorSetting in interface IteratorSettingFactory

Parameters:

view - the operation view

store - the accumulo store

Returns:

A new IteratorSetting for an Iterator that will aggregate elements at query time on the Schema

Throws:

IteratorSettingException - if an iterator setting could not be created

queryTimeAggregatorRequired

public boolean queryTimeAggregatorRequired(View view,
                                           AccumuloStore store)

getIteratorSetting

public org.apache.accumulo.core.client.IteratorSetting getIteratorSetting(AccumuloStore store,
                                                                          String iteratorName)
                                                                   throws IteratorSettingException

Description copied from interface: IteratorSettingFactory

Returns the iterator settings for a given iterator name. Allowed iterator names are: Aggregator, Validator and Bloom_Filter.

Specified by:

getIteratorSetting in interface IteratorSettingFactory

Parameters:

store - the accumulo store

iteratorName - the name of the iterator to return the settings for

Returns:

the iterator settings for a given iterator name.

Throws:

IteratorSettingException - if an iterator setting could not be created