org.apache.accumulo.core.data

Enum PartialKey

java.lang.Object

java.lang.Enum<PartialKey>

org.apache.accumulo.core.data.PartialKey

All Implemented Interfaces:

Serializable, Comparable<PartialKey>

public enum PartialKey
extends Enum<PartialKey>

Specifications for part of a Key.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ROW
ROW_COLFAM
ROW_COLFAM_COLQUAL
ROW_COLFAM_COLQUAL_COLVIS
ROW_COLFAM_COLQUAL_COLVIS_TIME
ROW_COLFAM_COLQUAL_COLVIS_TIME_DEL

Method Summary

Modifier and Type	Method and Description
static PartialKey	getByDepth(int depth) Deprecated. since 1.7.0
int	getDepth() Gets the depth of this partial key.
static PartialKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static PartialKey[]	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

ROW

public static final PartialKey ROW

ROW_COLFAM

public static final PartialKey ROW_COLFAM

ROW_COLFAM_COLQUAL

public static final PartialKey ROW_COLFAM_COLQUAL

ROW_COLFAM_COLQUAL_COLVIS

public static final PartialKey ROW_COLFAM_COLQUAL_COLVIS

ROW_COLFAM_COLQUAL_COLVIS_TIME

public static final PartialKey ROW_COLFAM_COLQUAL_COLVIS_TIME

ROW_COLFAM_COLQUAL_COLVIS_TIME_DEL

public static final PartialKey ROW_COLFAM_COLQUAL_COLVIS_TIME_DEL

Method Detail

values

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

Returns:

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

valueOf

public static PartialKey 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

getByDepth

@Deprecated
public static PartialKey getByDepth(int depth)

Deprecated. since 1.7.0

Get a partial key specification by depth of the specification.

Parameters:

depth - depth of scope (i.e., number of fields included)

Returns:

partial key

Throws:

IllegalArgumentException - if no partial key has the given depth

getDepth

public int getDepth()

Gets the depth of this partial key.

Returns:

depth