Package org.mariadb.jdbc.client.column

Class StringColumn

java.lang.Object

org.mariadb.jdbc.message.server.ColumnDefinitionPacket

org.mariadb.jdbc.client.column.StringColumn

All Implemented Interfaces:

Column, ColumnDecoder, ServerMessage

Direct Known Subclasses:

BlobColumn, JsonColumn

public class StringColumn
extends ColumnDefinitionPacket
implements ColumnDecoder

Column metadata definition

Field Summary

Fields inherited from class org.mariadb.jdbc.message.server.ColumnDefinitionPacket

charset, columnLength, dataType, decimals, extTypeFormat, extTypeName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringColumn(StringColumn prev)	Recreate new column using alias as name.
	StringColumn(ReadableByteBuf buf, int charset, long length, DataType dataType, byte decimals, int flags, int[] stringPos, java.lang.String extTypeName, java.lang.String extTypeFormat)	VARCHAR/STRING/VARSTRING metadata type decoder

Method Summary

Modifier and Type	Method	Description
boolean	decodeBooleanBinary(ReadableByteBuf buf, MutableInt length)	Parse boolean binary encoded value
boolean	decodeBooleanText(ReadableByteBuf buf, MutableInt length)	Return boolean text encoded value
byte	decodeByteBinary(ReadableByteBuf buf, MutableInt length)	Return byte binary encoded value
byte	decodeByteText(ReadableByteBuf buf, MutableInt length)	Return byte text encoded value
java.sql.Date	decodeDateBinary(ReadableByteBuf buf, MutableInt length, java.util.Calendar cal, Context context)	Return date binary encoded value
java.sql.Date	decodeDateText(ReadableByteBuf buf, MutableInt length, java.util.Calendar cal, Context context)	Return date text encoded value
double	decodeDoubleBinary(ReadableByteBuf buf, MutableInt length)	Parse double binary encoded value
double	decodeDoubleText(ReadableByteBuf buf, MutableInt length)	Parse double text encoded value
float	decodeFloatBinary(ReadableByteBuf buf, MutableInt length)	Parse float binary encoded value
float	decodeFloatText(ReadableByteBuf buf, MutableInt length)	Parse float text encoded value
int	decodeIntBinary(ReadableByteBuf buf, MutableInt length)	Parse int binary encoded value
int	decodeIntText(ReadableByteBuf buf, MutableInt length)	Parse int text encoded value
long	decodeLongBinary(ReadableByteBuf buf, MutableInt length)	Parse long binary encoded value
long	decodeLongText(ReadableByteBuf buf, MutableInt length)	Parse long text encoded value
short	decodeShortBinary(ReadableByteBuf buf, MutableInt length)	Parse short binary encoded value
short	decodeShortText(ReadableByteBuf buf, MutableInt length)	Parse short text encoded value
java.lang.String	decodeStringBinary(ReadableByteBuf buf, MutableInt length, java.util.Calendar cal, Context context)	Return String binary encoded value
java.lang.String	decodeStringText(ReadableByteBuf buf, MutableInt length, java.util.Calendar cal, Context context)	Return String text encoded value
java.sql.Time	decodeTimeBinary(ReadableByteBuf buf, MutableInt length, java.util.Calendar calParam, Context context)	Return time binary encoded value
java.sql.Timestamp	decodeTimestampBinary(ReadableByteBuf buf, MutableInt length, java.util.Calendar calParam, Context context)	Return timestamp binary encoded value
java.sql.Timestamp	decodeTimestampText(ReadableByteBuf buf, MutableInt length, java.util.Calendar calParam, Context context)	Return timestamp text encoded value
java.sql.Time	decodeTimeText(ReadableByteBuf buf, MutableInt length, java.util.Calendar cal, Context context)	Return time text encoded value
java.lang.String	defaultClassname(Configuration conf)	Returns default class name depending on server column datatype
int	getColumnType(Configuration conf)	Returns default java.sql.Types depending on server column datatype
java.lang.String	getColumnTypeName(Configuration conf)	Returns server column datatype
java.lang.Object	getDefaultBinary(ReadableByteBuf buf, MutableInt length, Context context)	Return default Object binary encoded
java.lang.Object	getDefaultText(ReadableByteBuf buf, MutableInt length, Context context)	Return default Object text encoded
int	getDisplaySize()	get display size
int	getPrecision()	Return decimal precision.
StringColumn	useAliasAsName()

Methods inherited from class org.mariadb.jdbc.message.server.ColumnDefinitionPacket

equals, getCatalog, getColumnAlias, getColumnLength, getColumnName, getDecimals, getExtTypeName, getFlags, getSchema, getTable, getTableAlias, getType, hasDefault, hashCode, isAutoIncrement, isBinary, isPrimaryKey, isSigned

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mariadb.jdbc.client.Column

getCatalog, getColumnAlias, getColumnLength, getColumnName, getDecimals, getExtTypeName, getFlags, getSchema, getTable, getTableAlias, getType, hasDefault, isAutoIncrement, isBinary, isPrimaryKey, isSigned

Constructor Detail

StringColumn

public StringColumn(ReadableByteBuf buf,
                    int charset,
                    long length,
                    DataType dataType,
                    byte decimals,
                    int flags,
                    int[] stringPos,
                    java.lang.String extTypeName,
                    java.lang.String extTypeFormat)

VARCHAR/STRING/VARSTRING metadata type decoder

Parameters:

buf - buffer

charset - charset

length - maximum data length

dataType - data type. see https://mariadb.com/kb/en/result-set-packets/#field-types

decimals - decimal length

flags - flags. see https://mariadb.com/kb/en/result-set-packets/#field-details-flag

stringPos - string offset position in buffer

extTypeName - extended type name

extTypeFormat - extended type format

StringColumn

protected StringColumn(StringColumn prev)

Recreate new column using alias as name.

Parameters:

prev - current column

Method Detail

getDisplaySize

public int getDisplaySize()

Description copied from interface: Column

get display size

Specified by:

getDisplaySize in interface Column

Overrides:

getDisplaySize in class ColumnDefinitionPacket

Returns:

display sier

useAliasAsName

public StringColumn useAliasAsName()

Specified by:

useAliasAsName in interface ColumnDecoder

defaultClassname

public java.lang.String defaultClassname(Configuration conf)

Description copied from interface: ColumnDecoder

Returns default class name depending on server column datatype

Specified by:

defaultClassname in interface ColumnDecoder

Parameters:

conf - configuration

Returns:

default class name

getColumnType

public int getColumnType(Configuration conf)

Description copied from interface: ColumnDecoder

Returns default java.sql.Types depending on server column datatype

Specified by:

getColumnType in interface ColumnDecoder

Parameters:

conf - configuration

Returns:

default java.sql.Types

getColumnTypeName

public java.lang.String getColumnTypeName(Configuration conf)

Description copied from interface: ColumnDecoder

Returns server column datatype

Specified by:

getColumnTypeName in interface ColumnDecoder

Parameters:

conf - configuration

Returns:

default server column datatype

getPrecision

public int getPrecision()

Description copied from interface: ColumnDecoder

Return decimal precision.

Specified by:

getPrecision in interface ColumnDecoder

Returns:

decimal precision

getDefaultText

public java.lang.Object getDefaultText(ReadableByteBuf buf,
                                       MutableInt length,
                                       Context context)
                                throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return default Object text encoded

Specified by:

getDefaultText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

context - connection context

Returns:

default Object

Throws:

java.sql.SQLDataException - if any decoding error occurs

getDefaultBinary

public java.lang.Object getDefaultBinary(ReadableByteBuf buf,
                                         MutableInt length,
                                         Context context)
                                  throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return default Object binary encoded

Specified by:

getDefaultBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

context - connection context

Returns:

default Object

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeBooleanText

public boolean decodeBooleanText(ReadableByteBuf buf,
                                 MutableInt length)
                          throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return boolean text encoded value

Specified by:

decodeBooleanText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

boolean value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeBooleanBinary

public boolean decodeBooleanBinary(ReadableByteBuf buf,
                                   MutableInt length)
                            throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse boolean binary encoded value

Specified by:

decodeBooleanBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

boolean value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeByteText

public byte decodeByteText(ReadableByteBuf buf,
                           MutableInt length)
                    throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return byte text encoded value

Specified by:

decodeByteText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

byte value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeByteBinary

public byte decodeByteBinary(ReadableByteBuf buf,
                             MutableInt length)
                      throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return byte binary encoded value

Specified by:

decodeByteBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

byte value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeStringText

public java.lang.String decodeStringText(ReadableByteBuf buf,
                                         MutableInt length,
                                         java.util.Calendar cal,
                                         Context context)
                                  throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return String text encoded value

Specified by:

decodeStringText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

cal - calendar

context - connection context

Returns:

String value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeStringBinary

public java.lang.String decodeStringBinary(ReadableByteBuf buf,
                                           MutableInt length,
                                           java.util.Calendar cal,
                                           Context context)
                                    throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return String binary encoded value

Specified by:

decodeStringBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

cal - calendar

context - current context

Returns:

String value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeShortText

public short decodeShortText(ReadableByteBuf buf,
                             MutableInt length)
                      throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse short text encoded value

Specified by:

decodeShortText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

short value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeShortBinary

public short decodeShortBinary(ReadableByteBuf buf,
                               MutableInt length)
                        throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse short binary encoded value

Specified by:

decodeShortBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

short value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeIntText

public int decodeIntText(ReadableByteBuf buf,
                         MutableInt length)
                  throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse int text encoded value

Specified by:

decodeIntText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

int value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeIntBinary

public int decodeIntBinary(ReadableByteBuf buf,
                           MutableInt length)
                    throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse int binary encoded value

Specified by:

decodeIntBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

int value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeLongText

public long decodeLongText(ReadableByteBuf buf,
                           MutableInt length)
                    throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse long text encoded value

Specified by:

decodeLongText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

long value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeLongBinary

public long decodeLongBinary(ReadableByteBuf buf,
                             MutableInt length)
                      throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse long binary encoded value

Specified by:

decodeLongBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

long value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeFloatText

public float decodeFloatText(ReadableByteBuf buf,
                             MutableInt length)
                      throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse float text encoded value

Specified by:

decodeFloatText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

float value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeFloatBinary

public float decodeFloatBinary(ReadableByteBuf buf,
                               MutableInt length)
                        throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse float binary encoded value

Specified by:

decodeFloatBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

float value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeDoubleText

public double decodeDoubleText(ReadableByteBuf buf,
                               MutableInt length)
                        throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse double text encoded value

Specified by:

decodeDoubleText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

double value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeDoubleBinary

public double decodeDoubleBinary(ReadableByteBuf buf,
                                 MutableInt length)
                          throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Parse double binary encoded value

Specified by:

decodeDoubleBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

Returns:

double value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeDateText

public java.sql.Date decodeDateText(ReadableByteBuf buf,
                                    MutableInt length,
                                    java.util.Calendar cal,
                                    Context context)
                             throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return date text encoded value

Specified by:

decodeDateText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

cal - calendar

context - connection Context

Returns:

date value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeDateBinary

public java.sql.Date decodeDateBinary(ReadableByteBuf buf,
                                      MutableInt length,
                                      java.util.Calendar cal,
                                      Context context)
                               throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return date binary encoded value

Specified by:

decodeDateBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

cal - calendar

context - connection Context

Returns:

date value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeTimeText

public java.sql.Time decodeTimeText(ReadableByteBuf buf,
                                    MutableInt length,
                                    java.util.Calendar cal,
                                    Context context)
                             throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return time text encoded value

Specified by:

decodeTimeText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

cal - calendar

context - connection context

Returns:

time value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeTimeBinary

public java.sql.Time decodeTimeBinary(ReadableByteBuf buf,
                                      MutableInt length,
                                      java.util.Calendar calParam,
                                      Context context)
                               throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return time binary encoded value

Specified by:

decodeTimeBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

calParam - calendar

context - connection context

Returns:

time value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeTimestampText

public java.sql.Timestamp decodeTimestampText(ReadableByteBuf buf,
                                              MutableInt length,
                                              java.util.Calendar calParam,
                                              Context context)
                                       throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return timestamp text encoded value

Specified by:

decodeTimestampText in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

calParam - calendar

context - connection context

Returns:

timestamp value

Throws:

java.sql.SQLDataException - if any decoding error occurs

decodeTimestampBinary

public java.sql.Timestamp decodeTimestampBinary(ReadableByteBuf buf,
                                                MutableInt length,
                                                java.util.Calendar calParam,
                                                Context context)
                                         throws java.sql.SQLDataException

Description copied from interface: ColumnDecoder

Return timestamp binary encoded value

Specified by:

decodeTimestampBinary in interface ColumnDecoder

Parameters:

buf - row buffer

length - data length

calParam - calendar

context - connection context

Returns:

timestamp value

Throws:

java.sql.SQLDataException - if any decoding error occurs