Class SimpleBoolFunction

BoolFunction implementation which applies an extendible bool function to the values of a single wrapped ValueSource.

Functions this can be used for include whether a field has a value or not, or inverting the bool value of the wrapped ValueSource.

Inheritance

object

ValueSource

BoolFunction

SimpleBoolFunction

Inherited Members

ValueSource.ToString()

ValueSource.NewContext(IndexSearcher)

ValueSource.GetSortField(bool)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Queries.Function.ValueSources

Assembly: Lucene.Net.Queries.dll

Syntax

public abstract class SimpleBoolFunction : BoolFunction

Constructors

SimpleBoolFunction(ValueSource)

BoolFunction implementation which applies an extendible bool function to the values of a single wrapped ValueSource.

Functions this can be used for include whether a field has a value or not, or inverting the bool value of the wrapped ValueSource.

Declaration

protected SimpleBoolFunction(ValueSource source)

Parameters

Type	Name	Description
ValueSource	source

Fields

m_source

BoolFunction implementation which applies an extendible bool function to the values of a single wrapped ValueSource.

Functions this can be used for include whether a field has a value or not, or inverting the bool value of the wrapped ValueSource.

Declaration

protected readonly ValueSource m_source

Field Value

Type	Description
ValueSource

Properties

Name

BoolFunction implementation which applies an extendible bool function to the values of a single wrapped ValueSource.

Functions this can be used for include whether a field has a value or not, or inverting the bool value of the wrapped ValueSource.

Declaration

protected abstract string Name { get; }

Property Value

Type	Description
string

Methods

CreateWeight(IDictionary, IndexSearcher)

Implementations should propagate CreateWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to GetValues() where this info can be retrieved.

Declaration

public override void CreateWeight(IDictionary context, IndexSearcher searcher)

Parameters

Type	Name	Description
IDictionary	context
IndexSearcher	searcher

Overrides

ValueSource.CreateWeight(IDictionary, IndexSearcher)

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
object	o

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueSource.Equals(object)

Func(int, FunctionValues)

BoolFunction implementation which applies an extendible bool function to the values of a single wrapped ValueSource.

Functions this can be used for include whether a field has a value or not, or inverting the bool value of the wrapped ValueSource.

Declaration

protected abstract bool Func(int doc, FunctionValues vals)

Parameters

Type	Name	Description
int	doc
FunctionValues	vals

Returns

Type	Description
bool

GetDescription()

description of field, used in Explain()

Declaration

public override string GetDescription()

Returns

Type	Description
string

Overrides

ValueSource.GetDescription()

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

ValueSource.GetHashCode()

GetValues(IDictionary, AtomicReaderContext)

Gets the values for this reader and the context that was previously passed to CreateWeight(IDictionary, IndexSearcher)

Declaration

public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)

Parameters

Type	Name	Description
IDictionary	context
AtomicReaderContext	readerContext

Returns

Type	Description
FunctionValues

Overrides

ValueSource.GetValues(IDictionary, AtomicReaderContext)