it.unimi.di.mg4j.index.cluster
Enum IndexCluster.PropertyKeys

java.lang.Object
  java.lang.Enum<IndexCluster.PropertyKeys>
      it.unimi.di.mg4j.index.cluster.IndexCluster.PropertyKeys

All Implemented Interfaces:

Serializable, Comparable<IndexCluster.PropertyKeys>

Enclosing class:

IndexCluster

public static enum IndexCluster.PropertyKeys
extends Enum<IndexCluster.PropertyKeys>

Symbolic names for properties of an IndexCluster.

Enum Constant Summary

BLOOM
A Boolean: whether the cluster has Bloom term filters.

FLAT
A Boolean: whether the cluster is flat (i.e., it is documental and all term lists are the same).

LOCALINDEX
A local index (usually used multiple times).

STRATEGY
The clustering strategy, specified as a serialised object.

STRATEGYCLASS
The clustering strategy, specified as a class name (the class must provide the standard constructors described in IndexCluster).

Method Summary

static IndexCluster.PropertyKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexCluster.PropertyKeys[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOCALINDEX

public static final IndexCluster.PropertyKeys LOCALINDEX

A local index (usually used multiple times).

STRATEGY

public static final IndexCluster.PropertyKeys STRATEGY

The clustering strategy, specified as a serialised object.

STRATEGYCLASS

public static final IndexCluster.PropertyKeys STRATEGYCLASS

The clustering strategy, specified as a class name (the class must provide the standard constructors described in IndexCluster).

BLOOM

public static final IndexCluster.PropertyKeys BLOOM

A Boolean: whether the cluster has Bloom term filters.

FLAT

public static final IndexCluster.PropertyKeys FLAT

A Boolean: whether the cluster is flat (i.e., it is documental and all term lists are the same).

Method Detail

values

public static IndexCluster.PropertyKeys[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IndexCluster.PropertyKeys c : IndexCluster.PropertyKeys.values())
    System.out.println(c);

Returns:

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

valueOf

public static IndexCluster.PropertyKeys valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null