Class LuceneSearchFilteringOperation

Namespace

Examine.Lucene.Search

Assembly

Examine.Lucene.dll

Lucene Search Filter Operation

public class LuceneSearchFilteringOperation : LuceneSearchFilteringOperationBase, IFilter, INestedFilter

Inheritance

object

LuceneSearchFilteringOperationBase

LuceneSearchFilteringOperation

Implements

IFilter

INestedFilter

Inherited Members

LuceneSearchFilteringOperationBase.Occurrence

LuceneSearchFilteringOperationBase.BooleanFilterOperation

LuceneSearchFilteringOperationBase.LuceneFilter(Filter, BooleanOperation?)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LuceneSearchFilteringOperation(LuceneSearchQuery)

Constructor

public LuceneSearchFilteringOperation(LuceneSearchQuery luceneSearchQuery)

Parameters

luceneSearchQuery LuceneSearchQuery

Properties

LuceneSearchQuery

Search Query

public LuceneSearchQuery LuceneSearchQuery { get; }

Property Value

LuceneSearchQuery

Methods

ChainFilters(Action<IFilterChain>)

Chain filters

public override IBooleanFilterOperation ChainFilters(Action<IFilterChain> chain)

Parameters

chain Action<IFilterChain>

Returns

IBooleanFilterOperation

CreateBooleanOp()

Creates a new LuceneFilteringBooleanOperation

protected override LuceneFilteringBooleanOperationBase CreateBooleanOp()

Returns

LuceneFilteringBooleanOperationBase

CreateChainOp()

Creates a new FilterChainOpBase

protected override FilterChainOpBase CreateChainOp()

Returns

FilterChainOpBase

DoubleRangeFilter(string, double?, double?, bool, bool)

Matches items as defined by the IIndexFieldValueType used for the fields specified. If a type is not defined for a field name, or the type does not implement IIndexRangeValueType for the types of min and max, nothing will be added

public override IBooleanFilterOperation DoubleRangeFilter(string field, double? min, double? max, bool minInclusive, bool maxInclusive)

Parameters

field string

min double?

max double?

minInclusive bool

maxInclusive bool

Returns

IBooleanFilterOperation

FieldValueExistsFilter(string)

Document must have value for field

public override IBooleanFilterOperation FieldValueExistsFilter(string field)

Parameters

field string

Returns

IBooleanFilterOperation

FieldValueNotExistsFilter(string)

Document must not have value for field

public override IBooleanFilterOperation FieldValueNotExistsFilter(string field)

Parameters

field string

Returns

IBooleanFilterOperation

FloatRangeFilter(string, float?, float?, bool, bool)

Matches items as defined by the IIndexFieldValueType used for the fields specified. If a type is not defined for a field name, or the type does not implement IIndexRangeValueType for the types of min and max, nothing will be added

public override IBooleanFilterOperation FloatRangeFilter(string field, float? min, float? max, bool minInclusive, bool maxInclusive)

Parameters

field string

min float?

max float?

minInclusive bool

maxInclusive bool

Returns

IBooleanFilterOperation

IntRangeFilter(string, int?, int?, bool, bool)

Matches items as defined by the IIndexFieldValueType used for the fields specified. If a type is not defined for a field name, or the type does not implement IIndexRangeValueType for the types of min and max, nothing will be added

public override IBooleanFilterOperation IntRangeFilter(string field, int? min, int? max, bool minInclusive, bool maxInclusive)

Parameters

field string

min int?

max int?

minInclusive bool

maxInclusive bool

Returns

IBooleanFilterOperation

LongRangeFilter(string, long?, long?, bool, bool)

Matches items as defined by the IIndexFieldValueType used for the fields specified. If a type is not defined for a field name, or the type does not implement IIndexRangeValueType for the types of min and max, nothing will be added

public override IBooleanFilterOperation LongRangeFilter(string field, long? min, long? max, bool minInclusive, bool maxInclusive)

Parameters

field string

min long?

max long?

minInclusive bool

maxInclusive bool

Returns

IBooleanFilterOperation

NestedChainFilters(Action<IFilterChain>)

protected override INestedBooleanFilterOperation NestedChainFilters(Action<IFilterChain> chain)

Parameters

chain Action<IFilterChain>

Returns

INestedBooleanFilterOperation

NestedFieldValueExistsFilter(string)

protected override INestedBooleanFilterOperation NestedFieldValueExistsFilter(string field)

Parameters

field string

Returns

INestedBooleanFilterOperation

NestedFieldValueNotExistsFilter(string)

protected override INestedBooleanFilterOperation NestedFieldValueNotExistsFilter(string field)

Parameters

field string

Returns

INestedBooleanFilterOperation

NestedQueryFilter(Func<INestedQuery, INestedBooleanOperation>, BooleanOperation)

protected override INestedBooleanFilterOperation NestedQueryFilter(Func<INestedQuery, INestedBooleanOperation> inner, BooleanOperation defaultOp)

Parameters

inner Func<INestedQuery, INestedBooleanOperation>

defaultOp BooleanOperation

Returns

INestedBooleanFilterOperation

NestedSpatialOperationFilter(string, ExamineSpatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape>)

protected override INestedBooleanFilterOperation NestedSpatialOperationFilter(string field, ExamineSpatialOperation spatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape> shape)

Parameters

field string

spatialOperation ExamineSpatialOperation

shape Func<IExamineSpatialShapeFactory, IExamineSpatialShape>

Returns

INestedBooleanFilterOperation

NestedTermFilter(FilterTerm)

protected override INestedBooleanFilterOperation NestedTermFilter(FilterTerm term)

Parameters

term FilterTerm

Returns

INestedBooleanFilterOperation

NestedTermPrefixFilter(FilterTerm)

protected override INestedBooleanFilterOperation NestedTermPrefixFilter(FilterTerm term)

Parameters

term FilterTerm

Returns

INestedBooleanFilterOperation

NestedTermsFilter(IEnumerable<FilterTerm>)

protected override INestedBooleanFilterOperation NestedTermsFilter(IEnumerable<FilterTerm> terms)

Parameters

terms IEnumerable<FilterTerm>

Returns

INestedBooleanFilterOperation

QueryFilter(Func<INestedQuery, INestedBooleanOperation>, BooleanOperation)

Must match query

public override IBooleanFilterOperation QueryFilter(Func<INestedQuery, INestedBooleanOperation> inner, BooleanOperation defaultOp = BooleanOperation.And)

Parameters

inner Func<INestedQuery, INestedBooleanOperation>

defaultOp BooleanOperation

Returns

IBooleanFilterOperation

SpatialOperationFilter(string, ExamineSpatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape>)

Executes Spatial operation as a Filter on field and shape

public override IBooleanFilterOperation SpatialOperationFilter(string field, ExamineSpatialOperation spatialOperation, Func<IExamineSpatialShapeFactory, IExamineSpatialShape> shape)

Parameters

field string

Index field name

spatialOperation ExamineSpatialOperation

shape Func<IExamineSpatialShapeFactory, IExamineSpatialShape>

Shape

Returns

IBooleanFilterOperation

TermFilter(FilterTerm)

Term must match

public override IBooleanFilterOperation TermFilter(FilterTerm term)

Parameters

term FilterTerm

Returns

IBooleanFilterOperation

TermPrefixFilter(FilterTerm)

Term must match as prefix

public override IBooleanFilterOperation TermPrefixFilter(FilterTerm term)

Parameters

term FilterTerm

Returns

IBooleanFilterOperation

TermsFilter(IEnumerable<FilterTerm>)

Terms must match

public override IBooleanFilterOperation TermsFilter(IEnumerable<FilterTerm> terms)

Parameters

terms IEnumerable<FilterTerm>

Returns

IBooleanFilterOperation