Package org.dizitart.no2.filters

Class IndexOnlyFilter

java.lang.Object

org.dizitart.no2.filters.NitriteFilter

org.dizitart.no2.filters.FieldBasedFilter

org.dizitart.no2.filters.ComparableFilter

org.dizitart.no2.filters.IndexOnlyFilter

All Implemented Interfaces:

Filter

public abstract class IndexOnlyFilter
extends ComparableFilter

An abstract class representing a filter that can be applied to an index.

NOTE: This filter does not support collection scan.

Since:

4.0

Author:

Anindya Chatterjee

Field Summary

Fields inherited from interface org.dizitart.no2.filters.Filter

ALL

Constructor Summary

Constructors

Constructor	Description
IndexOnlyFilter(String field, Object value)	Instantiates a new IndexOnlyFilter.

Method Summary

Modifier and Type	Method	Description
abstract boolean	canBeGrouped(IndexOnlyFilter other)	Checks if other filter can be grouped together with this filter.
abstract String	supportedIndexType()	Gets the supported index type for this filter.

Methods inherited from class org.dizitart.no2.filters.ComparableFilter

applyOnIndex, getComparable

Methods inherited from class org.dizitart.no2.filters.FieldBasedFilter

equals, getField, getValue, hashCode, setField, setProcessed, setValue, toString

Methods inherited from class org.dizitart.no2.filters.NitriteFilter

and, getCollectionName, getNitriteConfig, getObjectFilter, or, setCollectionName, setNitriteConfig, setObjectFilter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dizitart.no2.filters.Filter

apply, not

Constructor Detail

IndexOnlyFilter

public IndexOnlyFilter(String field,
                       Object value)

Instantiates a new IndexOnlyFilter.

Parameters:

field - the field

value - the value

Method Detail

supportedIndexType

public abstract String supportedIndexType()

Gets the supported index type for this filter.

Returns:

the supported index type

canBeGrouped

public abstract boolean canBeGrouped(IndexOnlyFilter other)

Checks if other filter can be grouped together with this filter.

Parameters:

other - the comparable filter

Returns:

the boolean