java.lang.Object
- java.lang.Enum<Index.PropertyKeys>
- - it.unimi.di.big.mg4j.index.Index.PropertyKeys

All Implemented Interfaces:

Serializable, Comparable<Index.PropertyKeys>, java.lang.constant.Constable

Enclosing class:

Index
```
public static enum Index.PropertyKeys
extends Enum<Index.PropertyKeys>
```
Symbolic names for properties of a Index.

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
`BATCHES`	The number of batches this index was (or should be) built from.
`CODING`	The specification of a compressiong flag.
`DOCUMENTS`	The number of documents in the collection.
`FIELD`	The name of the field indexed by this index, if any.
`INDEXCLASS`	The name of the `Index` class that should read this index.
`MAXCOUNT`	The maximum count, or -1 is the maximum count is not known.
`MAXDOCSIZE`	The maximum size (in words) of a document, or -1 if the maximum document size is not known.
`OCCURRENCES`	The number of occurrences in the collection, or -1 if the number of occurrences is not known.
`PAYLOADCLASS`	A class for the payloads of this index.
`POSTINGS`	The number of postings (pairs term/document) in the collection.
`SIZE`	The size in bits of the index.
`TERMPROCESSOR`	The `TermProcessor` used to build this index.
`TERMS`	The number of terms in the collection.

Method Summary

Modifier and Type	Method	Description
`static Index.PropertyKeys`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Index.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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DOCUMENTS
```
public static final Index.PropertyKeys DOCUMENTS
```
    The number of documents in the collection.
  - TERMS
```
public static final Index.PropertyKeys TERMS
```
    The number of terms in the collection.
  - OCCURRENCES
```
public static final Index.PropertyKeys OCCURRENCES
```
    The number of occurrences in the collection, or -1 if the number of occurrences is not known.
  - POSTINGS
```
public static final Index.PropertyKeys POSTINGS
```
    The number of postings (pairs term/document) in the collection.
  - BATCHES
```
public static final Index.PropertyKeys BATCHES
```
    The number of batches this index was (or should be) built from.
  - MAXCOUNT
```
public static final Index.PropertyKeys MAXCOUNT
```
    The maximum count, or -1 is the maximum count is not known.
  - MAXDOCSIZE
```
public static final Index.PropertyKeys MAXDOCSIZE
```
    The maximum size (in words) of a document, or -1 if the maximum document size is not known.
  - TERMPROCESSOR
```
public static final Index.PropertyKeys TERMPROCESSOR
```
    The TermProcessor used to build this index.
  - PAYLOADCLASS
```
public static final Index.PropertyKeys PAYLOADCLASS
```
    A class for the payloads of this index.
  - CODING
```
public static final Index.PropertyKeys CODING
```
    The specification of a compressiong flag. This property can be specified as many time as necessary (e.g., FREQUENCIES:GAMMA, POINTERS:GOLOMB, POSITIONS:NONE, etc.). Note that different type of indices have different allowable combinations.
  - INDEXCLASS
```
public static final Index.PropertyKeys INDEXCLASS
```
    The name of the Index class that should read this index.
  - FIELD
```
public static final Index.PropertyKeys FIELD
```
    The name of the field indexed by this index, if any.
  - SIZE
```
public static final Index.PropertyKeys SIZE
```
    The size in bits of the index.
- Method Detail
  - values
```
public static Index.PropertyKeys[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared.
    
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Index.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

Enum Index.PropertyKeys

Nested Class Summary

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

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DOCUMENTS

TERMS

OCCURRENCES

POSTINGS

BATCHES

MAXCOUNT

MAXDOCSIZE

TERMPROCESSOR

PAYLOADCLASS

CODING

INDEXCLASS

FIELD

SIZE

Method Detail

values

valueOf