Package org.mariadb.jdbc.message.server

Class ColumnDefinitionPacket

java.lang.Object

org.mariadb.jdbc.message.server.ColumnDefinitionPacket

All Implemented Interfaces:

Column, ServerMessage

Direct Known Subclasses:

BigDecimalColumn, BitColumn, DateColumn, DoubleColumn, FloatColumn, SignedBigIntColumn, SignedIntColumn, SignedMediumIntColumn, SignedSmallIntColumn, SignedTinyIntColumn, StringColumn, TimeColumn, TimestampColumn, UnsignedBigIntColumn, UnsignedIntColumn, UnsignedMediumIntColumn, UnsignedSmallIntColumn, UnsignedTinyIntColumn, UuidColumn

public class ColumnDefinitionPacket
extends java.lang.Object
implements Column, ServerMessage

Column metadata definition

Field Summary

Fields

Modifier and Type	Field	Description
private ReadableByteBuf	buf
protected int	charset	charset
protected long	columnLength	column maximum length
protected DataType	dataType	data type @see Field type
protected byte	decimals	number of decimal
protected java.lang.String	extTypeFormat	extended type format
protected java.lang.String	extTypeName	extended type name
private int	flags
private int[]	stringPos	string offset position in buffer
private boolean	useAliasAsName	configuration: use alias as name

Constructor Summary

Constructors

Modifier	Constructor	Description
	ColumnDefinitionPacket(ReadableByteBuf buf, int charset, long columnLength, DataType dataType, byte decimals, int flags, int[] stringPos, java.lang.String extTypeName, java.lang.String extTypeFormat, boolean useAliasAsName)	Column definition constructor
protected	ColumnDefinitionPacket(ColumnDefinitionPacket prev, boolean useAliasAsName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getCatalog()	get column catalog
java.lang.String	getColumnAlias()	retrieve column alias if any
long	getColumnLength()	column maximum length if known
java.lang.String	getColumnName()	retrieve column name if any
byte	getDecimals()	get number of decimal
int	getDisplaySize()	get display size
java.lang.String	getExtTypeName()	retrieve extended metadata name if any
int	getFlags()	Retrieve metadata flag
java.lang.String	getSchema()	get column schema
java.lang.String	getTable()	retrieve table name if any
java.lang.String	getTableAlias()	retrieve table alias if any
DataType	getType()	server data type
boolean	hasDefault()	Column has a default value
int	hashCode()
boolean	isAutoIncrement()	Column autoincrement
boolean	isBinary()	indicate if column is of binary type.
boolean	isPrimaryKey()	Is column a primary key
boolean	isSigned()	Is column signed (for number only)

Methods inherited from class java.lang.Object

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

Field Detail

charset

protected final int charset

charset

columnLength

protected final long columnLength

column maximum length

dataType

protected final DataType dataType

data type @see Field type

decimals

protected final byte decimals

number of decimal

extTypeName

protected final java.lang.String extTypeName

extended type name

extTypeFormat

protected final java.lang.String extTypeFormat

extended type format

buf

private final ReadableByteBuf buf

flags

private final int flags

See Also:

flags

stringPos

private final int[] stringPos

string offset position in buffer

useAliasAsName

private final boolean useAliasAsName

configuration: use alias as name

Constructor Detail

ColumnDefinitionPacket

public ColumnDefinitionPacket(ReadableByteBuf buf,
                              int charset,
                              long columnLength,
                              DataType dataType,
                              byte decimals,
                              int flags,
                              int[] stringPos,
                              java.lang.String extTypeName,
                              java.lang.String extTypeFormat,
                              boolean useAliasAsName)

Column definition constructor

Parameters:

buf - buffer

charset - charset

columnLength - maxium column length

dataType - data type

decimals - decimal length

flags - flags

stringPos - string position indexes

extTypeName - extended type name

extTypeFormat - extended type format

useAliasAsName - use alias as name

ColumnDefinitionPacket

protected ColumnDefinitionPacket(ColumnDefinitionPacket prev,
                                 boolean useAliasAsName)

Method Detail

getCatalog

public java.lang.String getCatalog()

Description copied from interface: Column

get column catalog

Specified by:

getCatalog in interface Column

Returns:

column catalog

getSchema

public java.lang.String getSchema()

Description copied from interface: Column

get column schema

Specified by:

getSchema in interface Column

Returns:

column schema

getTableAlias

public java.lang.String getTableAlias()

Description copied from interface: Column

retrieve table alias if any

Specified by:

getTableAlias in interface Column

Returns:

table alias

getTable

public java.lang.String getTable()

Description copied from interface: Column

retrieve table name if any

Specified by:

getTable in interface Column

Returns:

table name

getColumnAlias

public java.lang.String getColumnAlias()

Description copied from interface: Column

retrieve column alias if any

Specified by:

getColumnAlias in interface Column

Returns:

column alias

getColumnName

public java.lang.String getColumnName()

Description copied from interface: Column

retrieve column name if any

Specified by:

getColumnName in interface Column

Returns:

column name

getColumnLength

public long getColumnLength()

Description copied from interface: Column

column maximum length if known

Specified by:

getColumnLength in interface Column

Returns:

column maximum length

getType

public DataType getType()

Description copied from interface: Column

server data type

Specified by:

getType in interface Column

Returns:

server data type

getDecimals

public byte getDecimals()

Description copied from interface: Column

get number of decimal

Specified by:

getDecimals in interface Column

Returns:

number of decimal

isSigned

public boolean isSigned()

Description copied from interface: Column

Is column signed (for number only)

Specified by:

isSigned in interface Column

Returns:

is signed

getDisplaySize

public int getDisplaySize()

Description copied from interface: Column

get display size

Specified by:

getDisplaySize in interface Column

Returns:

display sier

isPrimaryKey

public boolean isPrimaryKey()

Description copied from interface: Column

Is column a primary key

Specified by:

isPrimaryKey in interface Column

Returns:

is a primary key

isAutoIncrement

public boolean isAutoIncrement()

Description copied from interface: Column

Column autoincrement

Specified by:

isAutoIncrement in interface Column

Returns:

true if column auto-increment

hasDefault

public boolean hasDefault()

Description copied from interface: Column

Column has a default value

Specified by:

hasDefault in interface Column

Returns:

indicate if has a default value

isBinary

public boolean isBinary()

Description copied from interface: Column

indicate if column is of binary type. doesn't use flag BINARY filter, because char binary and varchar binary are not binary (handle like string), but have binary flag

Specified by:

isBinary in interface Column

Returns:

is column type binary

getFlags

public int getFlags()

Description copied from interface: Column

Retrieve metadata flag

Specified by:

getFlags in interface Column

Returns:

metadata flag

getExtTypeName

public java.lang.String getExtTypeName()

Description copied from interface: Column

retrieve extended metadata name if any

Specified by:

getExtTypeName in interface Column

Returns:

extended metadata name

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object