org.apache.lucene.search.function

Class OrdFieldSource

public class OrdFieldSource extends ValueSource

Expert: obtains the ordinal of the field value from the default Lucene Fieldcache using getStringIndex().

The native lucene index order is used to assign an ordinal value for each field value.

Example:
If there were only three field values: "apple","banana","pear"
then ord("apple")=1, ord("banana")=2, ord("pear")=3

WARNING: ord() depends on the position in an index and can thus change when other documents are inserted or deleted, or if a MultiSearcher is used.

WARNING: The status of the search.function package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

Author: yonik

Field Summary
protected Stringfield
Constructor Summary
OrdFieldSource(String field)
Contructor for a certain field.
Method Summary
Stringdescription()
booleanequals(Object o)
DocValuesgetValues(IndexReader reader)
inthashCode()

Field Detail

field

protected String field

Constructor Detail

OrdFieldSource

public OrdFieldSource(String field)
Contructor for a certain field.

Parameters: field field whose values order is used.

Method Detail

description

public String description()

equals

public boolean equals(Object o)

getValues

public DocValues getValues(IndexReader reader)

hashCode

public int hashCode()
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.