com.basho.riak.client.core.query.timeseries

Class FullColumnDescription

java.lang.Object

com.basho.riak.client.core.query.timeseries.ColumnDescription

com.basho.riak.client.core.query.timeseries.FullColumnDescription

public class FullColumnDescription
extends ColumnDescription

Holds a complete definition for a Table Column in Time Series Riak. Immutable once created.

Since:

2.0.4

Author:

Alex Moore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FullColumnDescription.KeyOrder

Nested classes/interfaces inherited from class com.basho.riak.client.core.query.timeseries.ColumnDescription

ColumnDescription.ColumnType

Constructor Summary

Constructors

Constructor and Description
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable) Creates a basic FullColumnDescription, for non-key columns.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer keyOrdinal) Creates a FullColumnDescription.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer keyOrdinal, FullColumnDescription.KeyOrder keyOrder) Creates a FullColumnDescription.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer partitionKeyOrdinal, Integer localKeyOrdinal) Creates a FullColumnDescription.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer partitionKeyOrdinal, Integer localKeyOrdinal, FullColumnDescription.KeyOrder keyOrder) Creates a FullColumnDescription.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer partitionKeyOrdinal, Integer localKeyOrdinal, Quantum quantum) Creates a FullColumnDescription.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer partitionKeyOrdinal, Integer localKeyOrdinal, Quantum quantum, FullColumnDescription.KeyOrder keyOrder) Creates a FullColumnDescription.
FullColumnDescription(String name, ColumnDescription.ColumnType type, boolean isNullable, Integer keyOrdinal, Quantum quantum) Creates a FullColumnDescription.

Method Summary

Modifier and Type	Method and Description
FullColumnDescription.KeyOrder	getKeyOrder()
Integer	getLocalKeyOrdinal() Get the ordinal number of where this column appears in the ordered Local Key column set.
Integer	getPartitionKeyOrdinal() Get the ordinal number of where this column appears in the ordered Partition Key column set.
Quantum	getQuantum() Get the quantum setting for this column, if present.
boolean	hasKeyOrder()
boolean	hasQuantum() Returns whether this column has any quantum information.
boolean	isLocalKeyMember() Whether this column is a member of the Local Key column set.
boolean	isNullable() Whether this column's values are nullable.
boolean	isPartitionKeyMember() Whether this column is a member of the Partition Key column set.

Methods inherited from class com.basho.riak.client.core.query.timeseries.ColumnDescription

equals, getName, getType, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable)

Creates a basic FullColumnDescription, for non-key columns.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

Throws:

IllegalArgumentException - if Column Name or Column Type are null or empty.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer keyOrdinal)

Creates a FullColumnDescription. Useful for key columns where the partition and local key oridinals are the same.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

keyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

Throws:

IllegalArgumentException - if Column Name or Column Type are null or empty.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer keyOrdinal,
                             FullColumnDescription.KeyOrder keyOrder)

Creates a FullColumnDescription. Useful for key columns where the partition and local key oridinals are the same.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

keyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

keyOrder - The order in which this key column will be sorted on disk as part of the local key. Default is ASC. Use null if not a key column.

Throws:

IllegalArgumentException - if Column Name or Column Type are null or empty.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer keyOrdinal,
                             Quantum quantum)

Creates a FullColumnDescription. Useful for key columns where the partition and local key oridinals are the same.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

keyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

quantum - The Quantum setting if this column is used in partition key time quantization. Use FullColumnDescription(String, ColumnDescription.ColumnType, boolean, Integer) if the quantum is not needed.

Throws:

IllegalArgumentException - if the Column Name or Column Type are null or empty, or if the quantum is set on a non-Timestamp column, or the quantum is set on a non-partition key column.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer partitionKeyOrdinal,
                             Integer localKeyOrdinal)

Creates a FullColumnDescription. Useful for automating creation of FullColumnDescriptions where the values can vary.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

partitionKeyOrdinal - The ordinal number of where this column appears in the ordered Partition Key column set. Use null if not a key column.

localKeyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

Throws:

IllegalArgumentException - if Column Name or Column Type are null or empty.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer partitionKeyOrdinal,
                             Integer localKeyOrdinal,
                             FullColumnDescription.KeyOrder keyOrder)

Creates a FullColumnDescription. Useful for automating creation of FullColumnDescriptions where the values can vary.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

partitionKeyOrdinal - The ordinal number of where this column appears in the ordered Partition Key column set. Use null if not a key column.

localKeyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

keyOrder - The order in which this key column will be sorted on disk as part of the local key. Default is ASC. Use null if not a key column.

Throws:

IllegalArgumentException - if Column Name or Column Type are null or empty.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer partitionKeyOrdinal,
                             Integer localKeyOrdinal,
                             Quantum quantum)

Creates a FullColumnDescription. Useful for automating creation of FullColumnDescriptions where the values can vary.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

partitionKeyOrdinal - The ordinal number of where this column appears in the ordered Partition Key column set. Use null if not a key column.

localKeyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

quantum - The Quantum setting if this column is used in partition key time quantization. Use FullColumnDescription(String, ColumnDescription.ColumnType, boolean, Integer, Integer) if the quantum is not needed.

Throws:

IllegalArgumentException - if the Column Name or Column Type are null or empty, or if the quantum is set on a non-Timestamp column, or the quantum is set on a non-partition key column.

FullColumnDescription

public FullColumnDescription(String name,
                             ColumnDescription.ColumnType type,
                             boolean isNullable,
                             Integer partitionKeyOrdinal,
                             Integer localKeyOrdinal,
                             Quantum quantum,
                             FullColumnDescription.KeyOrder keyOrder)

Creates a FullColumnDescription. Useful for automating creation of FullColumnDescriptions where the values can vary.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

isNullable - The nullability of the column.

partitionKeyOrdinal - The ordinal number of where this column appears in the ordered Partition Key column set. Use null if not a key column.

localKeyOrdinal - The ordinal number of where this column appears in the ordered Local Key column set. Use null if not a key column.

quantum - The Quantum setting if this column is used in partition key time quantization. Use FullColumnDescription(String, ColumnDescription.ColumnType, boolean, Integer, Integer) if the quantum is not needed.

keyOrder - The order in which this key column will be sorted on disk as part of the local key. Default is ASC. Use null if not a key column.

Throws:

IllegalArgumentException - if the Column Name or Column Type are null or empty, or if the quantum is set on a non-Timestamp column, or the quantum is set on a non-partition key column.

Method Detail

isNullable

public boolean isNullable()

Whether this column's values are nullable.

Returns:

boolean

isPartitionKeyMember

public boolean isPartitionKeyMember()

Whether this column is a member of the Partition Key column set.

Returns:

boolean.

isLocalKeyMember

public boolean isLocalKeyMember()

Whether this column is a member of the Local Key column set.

Returns:

boolean.

getPartitionKeyOrdinal

public Integer getPartitionKeyOrdinal()

Get the ordinal number of where this column appears in the ordered Partition Key column set.

Returns:

Integer if isPartitionKeyMember() is true, null if isPartitionKeyMember() is false.

getLocalKeyOrdinal

public Integer getLocalKeyOrdinal()

Get the ordinal number of where this column appears in the ordered Local Key column set.

Returns:

Integer if isLocalKeyMember() is true, null if isLocalKeyMember() is false.

getQuantum

public Quantum getQuantum()

Get the quantum setting for this column, if present.

Returns:

a Quantum instance if this column is used in partition key time quantization.

hasQuantum

public boolean hasQuantum()

Returns whether this column has any quantum information.

Returns:

true if Quantum information is available, false if not.

getKeyOrder

public FullColumnDescription.KeyOrder getKeyOrder()

hasKeyOrder

public boolean hasKeyOrder()