org.apache.lucene.queries.function.valuesource
Class SimpleBoolFunction

java.lang.Object
  extended by org.apache.lucene.queries.function.ValueSource
      extended by org.apache.lucene.queries.function.valuesource.BoolFunction
          extended by org.apache.lucene.queries.function.valuesource.SimpleBoolFunction

public abstract class SimpleBoolFunction
extends BoolFunction

BoolFunction implementation which applies an extendible boolean 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 boolean value of the wrapped ValueSource.


Field Summary
protected  ValueSource source
           
 
Constructor Summary
SimpleBoolFunction(ValueSource source)
           
 
Method Summary
 void createWeight(Map context, IndexSearcher searcher)
          Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.
 String description()
          description of field, used in explain()
 boolean equals(Object o)
           
protected abstract  boolean func(int doc, FunctionValues vals)
           
 BoolDocValues getValues(Map context, AtomicReaderContext readerContext)
          Gets the values for this reader and the context that was previously passed to createWeight()
 int hashCode()
           
protected abstract  String name()
           
 
Methods inherited from class org.apache.lucene.queries.function.ValueSource
getSortField, newContext, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

source

protected final ValueSource source
Constructor Detail

SimpleBoolFunction

public SimpleBoolFunction(ValueSource source)
Method Detail

name

protected abstract String name()

func

protected abstract boolean func(int doc,
                                FunctionValues vals)

getValues

public BoolDocValues getValues(Map context,
                               AtomicReaderContext readerContext)
                        throws IOException
Description copied from class: ValueSource
Gets the values for this reader and the context that was previously passed to createWeight()

Specified by:
getValues in class ValueSource
Throws:
IOException

description

public String description()
Description copied from class: ValueSource
description of field, used in explain()

Specified by:
description in class ValueSource

hashCode

public int hashCode()
Specified by:
hashCode in class ValueSource

equals

public boolean equals(Object o)
Specified by:
equals in class ValueSource

createWeight

public void createWeight(Map context,
                         IndexSearcher searcher)
                  throws IOException
Description copied from class: ValueSource
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.

Overrides:
createWeight in class ValueSource
Throws:
IOException


Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.