Inheritance diagram for com.mysql.clusterj.core.store.Column:

Public Member Functions
String	getName ()
ColumnType	getType ()
boolean	isPrimaryKey ()
boolean	isPartitionKey ()
String	getCharsetName ()
int	getCharsetNumber ()
int	getLength ()
int	getPrefixLength ()
int	getColumnId ()
int	getColumnSpace ()
int	getPrecision ()
int	getScale ()
String	decode (byte[] bytes)
byte[]	encode (String string)
boolean	getNullable ()

Detailed Description

Column metadata for ndb columns.

Definition at line 25 of file Column.java.

Member Function Documentation

String com.mysql.clusterj.core.store.Column.decode ( byte[] bytes )

Decode a byte[] into a String using this column's charset.

Parameters

bytes the byte[] from the database

Returns: the decoded String

byte [] com.mysql.clusterj.core.store.Column.encode ( String string )

Encode a String into a byte[] for storage or comparison.

Parameters

string the String

Returns: the encoded byte[]

String com.mysql.clusterj.core.store.Column.getCharsetName ( )

Get the Charset name of the column. This is the value of the CHARACTER SET parameter in the column definition, or if not specified, the value of the DEFAULT CHARACTER SET parameter in the table definition.

Returns: the Charset name

int com.mysql.clusterj.core.store.Column.getCharsetNumber ( )

The charset number.

Returns: the Charset number

Here is the caller graph for this function:

int com.mysql.clusterj.core.store.Column.getColumnId ( )

The column ID, used for scans to compare column values.

Returns: the column id

int com.mysql.clusterj.core.store.Column.getColumnSpace ( )

The space needed to retrieve the value into memory, including the length byte or bytes at the beginning of the field.

Returns: the space required by the column

Here is the caller graph for this function:

int com.mysql.clusterj.core.store.Column.getLength ( )

For character columns, get the maximum length in bytes that can be stored in the column, excluding the prefix, after conversion via the charset.

String com.mysql.clusterj.core.store.Column.getName ( )

Get the name of the column.

Returns: the name

Here is the caller graph for this function:

boolean com.mysql.clusterj.core.store.Column.getNullable ( )

Is this column nullable?

Returns: true if the column is nullable

int com.mysql.clusterj.core.store.Column.getPrecision ( )

The precision of a decimal column (number of decimal digits before plus after the decimal point).

Returns: the precision

Here is the caller graph for this function:

int com.mysql.clusterj.core.store.Column.getPrefixLength ( )

For variable size columns, get the length of the prefix (one or two bytes) that specifies the length of the column data.

Returns: the prefix length, either one or two bytes for variable sized columns, zero otherwise

Here is the caller graph for this function:

int com.mysql.clusterj.core.store.Column.getScale ( )

The scale of a decimal column (the number of decimal digits after the decimal point).

Returns: the scale

Here is the caller graph for this function:

ColumnType com.mysql.clusterj.core.store.Column.getType ( )

Get the store type of the column.

Returns: the store type

boolean com.mysql.clusterj.core.store.Column.isPartitionKey ( )

Is this column a partition key column?

Returns: true if this column is a partition key column

boolean com.mysql.clusterj.core.store.Column.isPrimaryKey ( )

Is this column a primary key column?

Returns: true if this column is a primary key column

Here is the caller graph for this function:

The documentation for this interface was generated from the following file:

storage/ndb/clusterj/clusterj-core/src/main/java/com/mysql/clusterj/core/store/Column.java

Public Member Functions

Detailed Description

Member Function Documentation