Package org.apache.lucene.facet.sortedset

Class SortedSetDocValuesFacetField

java.lang.Object

org.apache.lucene.document.Field

org.apache.lucene.facet.sortedset.SortedSetDocValuesFacetField

All Implemented Interfaces:

IndexableField

public class SortedSetDocValuesFacetField
extends Field

Add an instance of this to your Document for every facet label to be indexed via SortedSetDocValues.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.document.Field

Field.Store

Field Summary

Fields

Modifier and Type	Field	Description
String	dim	Dimension.
String	label	Deprecated. This field will be removed in a future version.
String[]	path	Path.
static FieldType	TYPE	Indexed FieldType.

Fields inherited from class org.apache.lucene.document.Field

fieldsData, name, tokenStream, type

Constructor Summary

Constructors

Constructor	Description
SortedSetDocValuesFacetField(String dim, String... path)	Sole constructor.

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class org.apache.lucene.document.Field

binaryValue, fieldType, getCharSequenceValue, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, stringValue, tokenStream, tokenStreamValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FieldType TYPE

Indexed FieldType.

dim

public final String dim

Dimension.

path

public final String[] path

Path.

label

@Deprecated
public final String label

Deprecated.

This field will be removed in a future version. FacetsConfig.pathToString(String[]) can be applied to path as a replacement if string path is desired.

String form of path.

Constructor Detail

SortedSetDocValuesFacetField

public SortedSetDocValuesFacetField(String dim,
                                    String... path)

Sole constructor.

Method Detail

toString

public String toString()

Overrides:

toString in class Field