|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.facet.params.CategoryListParams
public class CategoryListParams
Contains parameters for a category list *
Nested Class Summary | |
---|---|
static class |
CategoryListParams.OrdinalPolicy
Defines which category ordinals are encoded for every document. |
Field Summary | |
---|---|
static String |
DEFAULT_FIELD
The default field used to store the facets information. |
static CategoryListParams.OrdinalPolicy |
DEFAULT_ORDINAL_POLICY
The default CategoryListParams.OrdinalPolicy that's used when encoding a document's
category ordinals. |
String |
field
|
Constructor Summary | |
---|---|
CategoryListParams()
Constructs a default category list parameters object, using DEFAULT_FIELD . |
|
CategoryListParams(String field)
Constructs a category list parameters object, using the given field. |
Method Summary | |
---|---|
CategoryListIterator |
createCategoryListIterator(int partition)
Create the CategoryListIterator for the specified partition. |
IntEncoder |
createEncoder()
Allows to override how categories are encoded and decoded. |
boolean |
equals(Object o)
|
CategoryListParams.OrdinalPolicy |
getOrdinalPolicy(String dimension)
Returns the CategoryListParams.OrdinalPolicy to use for the given dimension. |
int |
hashCode()
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_FIELD
public static final CategoryListParams.OrdinalPolicy DEFAULT_ORDINAL_POLICY
CategoryListParams.OrdinalPolicy
that's used when encoding a document's
category ordinals.
public final String field
Constructor Detail |
---|
public CategoryListParams()
DEFAULT_FIELD
.
public CategoryListParams(String field)
Method Detail |
---|
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()
hashCode
in class Object
public CategoryListIterator createCategoryListIterator(int partition) throws IOException
CategoryListIterator
for the specified partition.
IOException
public CategoryListParams.OrdinalPolicy getOrdinalPolicy(String dimension)
CategoryListParams.OrdinalPolicy
to use for the given dimension. This
CategoryListParams
always returns DEFAULT_ORDINAL_POLICY
for all dimensions.
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |