com.gpudb

Class Type.Column

java.lang.Object

com.gpudb.Type.Column

All Implemented Interfaces:

Serializable

Enclosing class:

Type

public static final class Type.Column
extends Object
implements Serializable

Immutable collection of metadata about a column that is part of a GPUdb type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Type.Column.ColumnBaseType An enumeration of base types for column (excluding any property-related subtypes).
static class	Type.Column.ColumnType An enumeration of all the Kinetica column types (including sub-types that are determined by the properties used).

Constructor Summary

Constructors

Constructor and Description
Column(String name, Class<?> type, List<String> properties) Creates a Type.Column object with the specified metadata.
Column(String name, Class<?> type, String... properties) Creates a Type.Column object with the specified metadata.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Type.Column.ColumnBaseType	getColumnBaseType() Gets the enumeration of the *base* type of the column.
Type.Column.ColumnType	getColumnType() Gets the enumeration of the type of the column.
String	getName() Gets the name of the column.
List<String>	getProperties() Gets the list of properties that apply to the column.
Class<?>	getType() Gets the Java data type of the column.
int	hashCode()
boolean	hasProperty(String property) Checks if the given property applies to the column.
boolean	isNullable() Gets whether the column is nullable.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column(String name,
              Class<?> type,
              String... properties)

Creates a Type.Column object with the specified metadata.

Parameters:

name - the name of the column

type - the Java data type of the column

properties - the list of properties that apply to the column; defaults to none

Throws:

IllegalArgumentException - if name or any properties are invalid, or if type is not one of the following: ByteBuffer, Double, Float, Integer, Long, or String

See Also:

ColumnProperty

Column

public Column(String name,
              Class<?> type,
              List<String> properties)

Creates a Type.Column object with the specified metadata.

Parameters:

name - the name of the column

type - the Java data type of the column

properties - the list of properties that apply to the column; defaults to none

Throws:

IllegalArgumentException - if name or any properties are invalid, or if type is not one of the following: ByteBuffer, Double, Float, Integer, Long, or String

See Also:

ColumnProperty

Method Detail

getName

public String getName()

Gets the name of the column.

Returns:

the name of the column

getType

public Class<?> getType()

Gets the Java data type of the column.

Returns:

the Java data type of the column

getColumnBaseType

public Type.Column.ColumnBaseType getColumnBaseType()

Gets the enumeration of the *base* type of the column. This is far more efficient than using getType() and then comparing it to various Java classes, e.g. Integer.class. With this enumeration, switch statements can be used to do different things for different column types. This enumeration is preferred when the same thing needs to be done for all sub-types of a given base type. For example, string has a lot of sub-types; rather than having to group multiple case statements (and ensuring that no applicable enumeration is missed) for Type.Column.ColumnType, this enumeration can be used to cover all string cases.

Returns:

the enumeration representing the *base* type of the column

getColumnType

public Type.Column.ColumnType getColumnType()

Gets the enumeration of the type of the column. This is far more efficient than using hasProperty(String) to check for given column properties. With this enumeration, switch statements can be used to do different things for different column types.

Returns:

the enumeration representing the type of the column

isNullable

public boolean isNullable()

Gets whether the column is nullable.

Returns:

whether the column is nullable

getProperties

public List<String> getProperties()

Gets the list of properties that apply to the column.

Returns:

the list of properties that apply to the column

See Also:

ColumnProperty

hasProperty

public boolean hasProperty(String property)

Checks if the given property applies to the column.

Returns:

boolean indicating whether the given property exists in the column's properties.

See Also:

ColumnProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object