it.unimi.di.mg4j.index
Enum Index.UriKeys

java.lang.Object
  java.lang.Enum<Index.UriKeys>
      it.unimi.di.mg4j.index.Index.UriKeys

All Implemented Interfaces:

Serializable, Comparable<Index.UriKeys>

Enclosing class:

Index

public static enum Index.UriKeys
extends Enum<Index.UriKeys>

Keys to be used (downcased) in specifiying additional parameters to a MG4J URI.

Enum Constant Summary

INMEMORY
When set, forces loading a local index into core memory.

MAPPED
When set, forces to map a local index into core memory.

OFFSETSTEP
The step used for creating the offset SemiExternalOffsetList.

SIZES
The name of a sizes file that will be loaded in case of an IndexCluster.

SUCCINCTSIZES
When set, sizes are loaded in a succinct format (more precisely, using an Elias–Fano compressed list.

Method Summary

static Index.UriKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static Index.UriKeys[]	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

INMEMORY

public static final Index.UriKeys INMEMORY

When set, forces loading a local index into core memory.

MAPPED

public static final Index.UriKeys MAPPED

When set, forces to map a local index into core memory.

OFFSETSTEP

public static final Index.UriKeys OFFSETSTEP

The step used for creating the offset SemiExternalOffsetList. If set to zero, the offset list will be entirely loaded into core memory. If negative, the list will be memory-mapped, and the absolute value will be used as step.

SUCCINCTSIZES

public static final Index.UriKeys SUCCINCTSIZES

When set, sizes are loaded in a succinct format (more precisely, using an Elias–Fano compressed list.

SIZES

public static final Index.UriKeys SIZES

The name of a sizes file that will be loaded in case of an IndexCluster.

Method Detail

values

public static Index.UriKeys[] 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 (Index.UriKeys c : Index.UriKeys.values())
    System.out.println(c);

Returns:

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

valueOf

public static Index.UriKeys 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