|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.facet.index.params.CategoryListParams
public class CategoryListParams
Contains parameters for a category list *
Field Summary | |
---|---|
static org.apache.lucene.index.Term |
DEFAULT_TERM
The default term used to store the facets information. |
Constructor Summary | |
---|---|
CategoryListParams()
Constructs a default category list parameters object, using DEFAULT_TERM . |
|
CategoryListParams(org.apache.lucene.index.Term term)
Constructs a category list parameters object, using the given Term . |
Method Summary | |
---|---|
CategoryListIterator |
createCategoryListIterator(org.apache.lucene.index.IndexReader reader,
int partition)
Create the category list iterator for the specified partition. |
IntEncoder |
createEncoder()
Allows to override how categories are encoded and decoded. |
boolean |
equals(Object o)
Equality is defined by the 'term' that defines this category list. |
org.apache.lucene.index.Term |
getTerm()
A Term who's payload holds the category-list. |
int |
hashCode()
Hashcode is similar to equals(Object) , in that it uses
the term that defines this category list to derive the hashcode. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final org.apache.lucene.index.Term DEFAULT_TERM
Constructor Detail |
---|
public CategoryListParams()
DEFAULT_TERM
.
public CategoryListParams(org.apache.lucene.index.Term term)
Term
.
term
- who's payload hold the category-list.Method Detail |
---|
public final org.apache.lucene.index.Term getTerm()
Term
who's payload holds the category-list.
public IntEncoder createEncoder()
IntDecoder
is provided by the IntEncoder
.
Default implementation creates a new Sorting(Unique(DGap)) encoder. Uniqueness in this regard means when the same category appears twice in a document, only one appearance would be encoded. This has effect on facet counting results.
Some possible considerations when overriding may be:
public boolean equals(Object o)
equals
in class Object
public int hashCode()
equals(Object)
, in that it uses
the term that defines this category list to derive the hashcode.
Subclasses need to ensure that equality/hashcode is correctly defined,
or there could be side-effects in the TotalFacetCounts
caching
mechanism (as the filename for a Total Facet Counts array cache
is dependent on the hashCode, so it should consistently return the same
hash for identity).
hashCode
in class Object
public CategoryListIterator createCategoryListIterator(org.apache.lucene.index.IndexReader reader, int partition) throws IOException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |