Top Description Fields Constructors Methods

com.mysql.cj.protocol.x

public Class FieldFactory

Class Inheritance

extends Object
implements ProtocolEntityFactory<Field, XMessage>

java.lang.Object
com.mysql.cj.protocol.x.FieldFactory

All Implemented Interfaces

com.mysql.cj.protocol.ProtocolEntityFactory

Imports

java.io.UnsupportedEncodingException, com.mysql.cj.CharsetMapping, .MysqlType, com.mysql.cj.exceptions.WrongArgumentException, com.mysql.cj.protocol.ProtocolEntityFactory, com.mysql.cj.result.Field, com.mysql.cj.util.LazyString, com.mysql.cj.x.protobuf.MysqlxResultset.ColumnMetaData, .MysqlxResultset.ColumnMetaData.FieldType

Factory producing Field from protocol message.

Field Summary

Modifier and Type	Field and Description
pack-priv String	metadataCharacterSet
private static final int	XPROTOCOL_COLUMN_BYTES_CONTENT_TYPE_GEOMETRY Content-type used in type mapping.
private static final int	XPROTOCOL_COLUMN_BYTES_CONTENT_TYPE_JSON
private static final int	XPROTOCOL_COLUMN_FLAGS_AUTO_INCREMENT
private static final int	XPROTOCOL_COLUMN_FLAGS_BYTES_RIGHTPAD
private static final int	XPROTOCOL_COLUMN_FLAGS_DATETIME_TIMESTAMP
private static final int	XPROTOCOL_COLUMN_FLAGS_DECIMAL_UNSIGNED
private static final int	XPROTOCOL_COLUMN_FLAGS_DOUBLE_UNSIGNED
private static final int	XPROTOCOL_COLUMN_FLAGS_FLOAT_UNSIGNED
private static final int	XPROTOCOL_COLUMN_FLAGS_MULTIPLE_KEY
private static final int	XPROTOCOL_COLUMN_FLAGS_NOT_NULL
private static final int	XPROTOCOL_COLUMN_FLAGS_PRIMARY_KEY
private static final int	XPROTOCOL_COLUMN_FLAGS_UINT_ZEROFILL
private static final int	XPROTOCOL_COLUMN_FLAGS_UNIQUE_KEY

Constructor Summary

Access	Constructor and Description
public	FieldFactory(String metadataCharSet)

Method Summary

Modifier and Type	Method and Description
private Field	Returns: `Field` columnMetaDataToField(MysqlxResultset.ColumnMetaData the message from the server col, String the encoding of the strings in the message characterSet) Convert a X Protocol `ColumnMetaData` message to a C/J `Field` object.
public Field	createFromMessage(XMessage `Message` instance message) Overrides default com.mysql.cj.protocol.ProtocolEntityFactory.createFromMessage. Create ProtocolEntity of type `T` from protocol message.
private MysqlType	findMysqlType(MysqlxResultset.ColumnMetaData.FieldType type, int contentType, int flags, int collationIndex)
private int	Returns: A FIELD_TYPE constant from `MysqlType` corresponding to the combination of input parameters. xProtocolTypeToMysqlType(MysqlxResultset.ColumnMetaData.FieldType the type as the ColumnMetaData.FieldType type, int the inner type contentType) Map a X Protocol type code from `ColumnMetaData.FieldType' to a MySQL type constant.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

metadataCharacterSet	back to summary
pack-priv String metadataCharacterSet

XPROTOCOL_COLUMN_BYTES_CONTENT_TYPE_GEOMETRY	back to summary
private static final int XPROTOCOL_COLUMN_BYTES_CONTENT_TYPE_GEOMETRY Content-type used in type mapping. c.f. mysqlx_resultset.proto

XPROTOCOL_COLUMN_BYTES_CONTENT_TYPE_JSON	back to summary
private static final int XPROTOCOL_COLUMN_BYTES_CONTENT_TYPE_JSON

XPROTOCOL_COLUMN_FLAGS_AUTO_INCREMENT	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_AUTO_INCREMENT

XPROTOCOL_COLUMN_FLAGS_BYTES_RIGHTPAD	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_BYTES_RIGHTPAD

XPROTOCOL_COLUMN_FLAGS_DATETIME_TIMESTAMP	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_DATETIME_TIMESTAMP

XPROTOCOL_COLUMN_FLAGS_DECIMAL_UNSIGNED	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_DECIMAL_UNSIGNED

XPROTOCOL_COLUMN_FLAGS_DOUBLE_UNSIGNED	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_DOUBLE_UNSIGNED

XPROTOCOL_COLUMN_FLAGS_FLOAT_UNSIGNED	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_FLOAT_UNSIGNED

XPROTOCOL_COLUMN_FLAGS_MULTIPLE_KEY	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_MULTIPLE_KEY

XPROTOCOL_COLUMN_FLAGS_NOT_NULL	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_NOT_NULL

XPROTOCOL_COLUMN_FLAGS_PRIMARY_KEY	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_PRIMARY_KEY

XPROTOCOL_COLUMN_FLAGS_UINT_ZEROFILL	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_UINT_ZEROFILL

XPROTOCOL_COLUMN_FLAGS_UNIQUE_KEY	back to summary
private static final int XPROTOCOL_COLUMN_FLAGS_UNIQUE_KEY

Constructor Detail

FieldFactory	back to summary
public FieldFactory(String metadataCharSet)

Method Detail

columnMetaDataToField back to summary

private Field columnMetaDataToField(MysqlxResultset.ColumnMetaData col, String characterSet)

Convert a X Protocol ColumnMetaData message to a C/J Field object.

Parameters

col:MysqlxResultset.ColumnMetaData: the message from the server
characterSet:String: the encoding of the strings in the message

Returns:Field

Field

createFromMessage back to summary

createFromMessage	back to summary
public Field createFromMessage(XMessage message) Overrides default com.mysql.cj.protocol.ProtocolEntityFactory.createFromMessage. Doc from com.mysql.cj.protocol.ProtocolEntityFactory.createFromMessage. Create ProtocolEntity of type `T` from protocol message. Parameters message:XMessage `Message` instance Returns:Field T Annotations @Override

public Field createFromMessage(XMessage message)

Overrides default com.mysql.cj.protocol.ProtocolEntityFactory.createFromMessage.

Doc from com.mysql.cj.protocol.ProtocolEntityFactory.createFromMessage.

Create ProtocolEntity of type T from protocol message.

Parameters

message:XMessage: Message instance

Returns:Field

Annotations

@Override

findMysqlType	back to summary
private MysqlType findMysqlType(MysqlxResultset.ColumnMetaData.FieldType type, int contentType, int flags, int collationIndex)

xProtocolTypeToMysqlType back to summary

private int xProtocolTypeToMysqlType(MysqlxResultset.ColumnMetaData.FieldType type, int contentType)

Map a X Protocol type code from `ColumnMetaData.FieldType' to a MySQL type constant. These are the only types that will be present in XProtocolRow results.

Parameters

type:MysqlxResultset.ColumnMetaData.FieldType: the type as the ColumnMetaData.FieldType
contentType:int: the inner type

Returns:int

A FIELD_TYPE constant from MysqlType corresponding to the combination of input parameters.