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
charsetprotected long
columnLength
column maximum lengthprotected DataType
dataType
data type @see Field typeprotected byte
decimals
number of decimalprotected java.lang.String
extTypeFormat
extended type formatprotected java.lang.String
extTypeName
extended type nameprivate int
flags
private int[]
stringPos
string offset position in bufferprivate 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 constructorprotected
ColumnDefinitionPacket(ColumnDefinitionPacket prev, boolean useAliasAsName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.lang.String
getCatalog()
get column catalogjava.lang.String
getColumnAlias()
retrieve column alias if anylong
getColumnLength()
column maximum length if knownjava.lang.String
getColumnName()
retrieve column name if anybyte
getDecimals()
get number of decimalint
getDisplaySize()
get display sizejava.lang.String
getExtTypeName()
retrieve extended metadata name if anyint
getFlags()
Retrieve metadata flagjava.lang.String
getSchema()
get column schemajava.lang.String
getTable()
retrieve table name if anyjava.lang.String
getTableAlias()
retrieve table alias if anyDataType
getType()
server data typeboolean
hasDefault()
Column has a default valueint
hashCode()
boolean
isAutoIncrement()
Column autoincrementboolean
isBinary()
indicate if column is of binary type.boolean
isPrimaryKey()
Is column a primary keyboolean
isSigned()
Is column signed (for number only)
-
-
-
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
- buffercharset
- charsetcolumnLength
- maxium column lengthdataType
- data typedecimals
- decimal lengthflags
- flagsstringPos
- string position indexesextTypeName
- extended type nameextTypeFormat
- extended type formatuseAliasAsName
- 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 interfaceColumn
- Returns:
- column catalog
-
getSchema
public java.lang.String getSchema()
Description copied from interface:Column
get column schema
-
getTableAlias
public java.lang.String getTableAlias()
Description copied from interface:Column
retrieve table alias if any- Specified by:
getTableAlias
in interfaceColumn
- Returns:
- table alias
-
getTable
public java.lang.String getTable()
Description copied from interface:Column
retrieve table name if any
-
getColumnAlias
public java.lang.String getColumnAlias()
Description copied from interface:Column
retrieve column alias if any- Specified by:
getColumnAlias
in interfaceColumn
- Returns:
- column alias
-
getColumnName
public java.lang.String getColumnName()
Description copied from interface:Column
retrieve column name if any- Specified by:
getColumnName
in interfaceColumn
- Returns:
- column name
-
getColumnLength
public long getColumnLength()
Description copied from interface:Column
column maximum length if known- Specified by:
getColumnLength
in interfaceColumn
- Returns:
- column maximum length
-
getDecimals
public byte getDecimals()
Description copied from interface:Column
get number of decimal- Specified by:
getDecimals
in interfaceColumn
- Returns:
- number of decimal
-
isSigned
public boolean isSigned()
Description copied from interface:Column
Is column signed (for number only)
-
getDisplaySize
public int getDisplaySize()
Description copied from interface:Column
get display size- Specified by:
getDisplaySize
in interfaceColumn
- Returns:
- display sier
-
isPrimaryKey
public boolean isPrimaryKey()
Description copied from interface:Column
Is column a primary key- Specified by:
isPrimaryKey
in interfaceColumn
- Returns:
- is a primary key
-
isAutoIncrement
public boolean isAutoIncrement()
Description copied from interface:Column
Column autoincrement- Specified by:
isAutoIncrement
in interfaceColumn
- Returns:
- true if column auto-increment
-
hasDefault
public boolean hasDefault()
Description copied from interface:Column
Column has a default value- Specified by:
hasDefault
in interfaceColumn
- 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
-
getFlags
public int getFlags()
Description copied from interface:Column
Retrieve metadata flag
-
getExtTypeName
public java.lang.String getExtTypeName()
Description copied from interface:Column
retrieve extended metadata name if any- Specified by:
getExtTypeName
in interfaceColumn
- Returns:
- extended metadata name
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-