Package org.apache.lucene.document.column

Enum Class Column.Density

java.lang.Object

java.lang.Enum<Column.Density>

org.apache.lucene.document.column.Column.Density

All Implemented Interfaces:

Serializable, Comparable<Column.Density>, Constable

Enclosing class:

Column

public static enum Column.Density
extends Enum<Column.Density>

Whether a column has a value for every document in the batch. This is a contract the column asserts up-front so the indexing chain can pick the right code path without probing the data.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DENSE	The column has a value for every batch-local doc-id in [0, numDocs), in order.
SPARSE	The column may be missing values or have multiple values for some doc-ids.

Method Summary

Modifier and Type	Method	Description
static Column.Density	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Column.Density[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DENSE

public static final Column.Density DENSE

The column has a value for every batch-local doc-id in [0, numDocs), in order.

SPARSE

public static final Column.Density SPARSE

The column may be missing values or have multiple values for some doc-ids.

Method Details

values

public static Column.Density[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Column.Density valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null