Module datarush.library

Package com.pervasive.datarush.tokens

Enum Class DataRepresentation

java.lang.Object

java.lang.Enum<DataRepresentation>

com.pervasive.datarush.tokens.DataRepresentation

All Implemented Interfaces:

Serializable, Comparable<DataRepresentation>, java.lang.constant.Constable

public enum DataRepresentation
extends Enum<DataRepresentation>

Controls the representation of a dataset. Each data representation has two aspects:

1. The base: this the the default value that is assumed for unspecified values.
2. A flag that indicates whether the data is sparse or dense.

At the moment, sparse data is always "zero based" and dense data is always "null based".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DataRepresentation.Base	The default value that is assumed for unspecified values.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DENSE_BASE_NULL	Data representation is dense; Values not set default to null.
SPARSE_BASE_ZERO	Data representation is sparse; values not set default to zero.

Method Summary

Modifier and Type	Method	Description
DataRepresentation.Base	base()	Returns the base of this representation.
boolean	isSparse()	Returns whether this representation is sparse.
static DataRepresentation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataRepresentation[]	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_BASE_NULL

public static final DataRepresentation DENSE_BASE_NULL

Data representation is dense; Values not set default to null.

SPARSE_BASE_ZERO

public static final DataRepresentation SPARSE_BASE_ZERO

Data representation is sparse; values not set default to zero.

Method Details

values

public static DataRepresentation[] 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 DataRepresentation 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

base

public DataRepresentation.Base base()

Returns the base of this representation.

Returns:

the base of this representation.

isSparse

public boolean isSparse()

Returns whether this representation is sparse.

Returns:

whether this representation is sparse.