Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.mysql.jdbc
Class Field  view Field download Field.java

java.lang.Object
  extended bycom.mysql.jdbc.Field

public class Field
extends java.lang.Object

Field is a class used to describe fields in a ResultSet

Version:
$Id: Field.java,v 1.15.2.15 2004/10/21 19:31:03 mmatthew Exp $

Field Summary
private static int AUTO_INCREMENT_FLAG
           
private  byte[] buffer
           
private  int charsetIndex
           
private  java.lang.String charsetName
           
private  int colDecimals
           
private  short colFlag
           
private  Connection connection
           
private  java.lang.String databaseName
           
private  int databaseNameLength
           
private  int databaseNameStart
           
private  java.lang.String defaultValue
           
private  int defaultValueLength
           
private  int defaultValueStart
           
private  java.lang.String fullName
           
private  java.lang.String fullNameWithDatabase
           
private  java.lang.String fullOriginalName
           
private  java.lang.String fullOriginalNameWithDatabase
           
private  long length
           
private  int mysqlType
           
private  java.lang.String name
           
private  int nameLength
           
private  int nameStart
           
private  java.lang.String originalColumnName
           
private  int originalColumnNameLength
           
private  int originalColumnNameStart
           
private  java.lang.String originalTableName
           
private  int originalTableNameLength
           
private  int originalTableNameStart
           
private  int precisionAdjustFactor
           
private  int sqlType
           
private  java.lang.String tableName
           
private  int tableNameLength
           
private  int tableNameStart
           
 
Constructor Summary
(package private) Field(Connection conn, byte[] buffer, int databaseNameStart, int databaseNameLength, int tableNameStart, int tableNameLength, int originalTableNameStart, int originalTableNameLength, int nameStart, int nameLength, int originalColumnNameStart, int originalColumnNameLength, long length, int mysqlType, short colFlag, int colDecimals, int defaultValueStart, int defaultValueLength, int charsetIndex)
          Constructor used when communicating with 4.1 and newer servers
(package private) Field(Connection conn, byte[] buffer, int nameStart, int nameLength, int tableNameStart, int tableNameLength, long length, int mysqlType, short colFlag, int colDecimals)
          Constructor used when communicating with pre 4.1 servers
(package private) Field(java.lang.String tableName, java.lang.String columnName, int jdbcType, long length)
          Constructor used by DatabaseMetaData methods.
 
Method Summary
 java.lang.String getCharacterSet()
          Returns the character set (if known) for this field.
 java.lang.String getDatabaseName()
          DOCUMENT ME!
(package private)  int getDecimals()
           
 java.lang.String getFullName()
          DOCUMENT ME!
 java.lang.String getFullOriginalName()
          DOCUMENT ME!
 long getLength()
          DOCUMENT ME!
 int getMysqlType()
          DOCUMENT ME!
 java.lang.String getName()
          DOCUMENT ME!
 java.lang.String getOriginalName()
          DOCUMENT ME!
 java.lang.String getOriginalTableName()
          DOCUMENT ME!
 int getPrecisionAdjustFactor()
          Returns amount of correction that should be applied to the precision value.
 int getSQLType()
          DOCUMENT ME!
private  java.lang.String getStringFromBytes(int stringStart, int stringLength)
          Create a string with the correct charset encoding from the byte-buffer that contains the data for this field
 java.lang.String getTable()
          DOCUMENT ME!
 java.lang.String getTableName()
          DOCUMENT ME!
 boolean isAutoIncrement()
          DOCUMENT ME!
 boolean isBinary()
          DOCUMENT ME!
 boolean isBlob()
          DOCUMENT ME!
 boolean isMultipleKey()
          DOCUMENT ME!
(package private)  boolean isNotNull()
           
 boolean isPrimaryKey()
          DOCUMENT ME!
(package private)  boolean isReadOnly()
          Is this field _definitely_ not writable?
 boolean isUniqueKey()
          DOCUMENT ME!
 boolean isUnsigned()
          DOCUMENT ME!
 boolean isZeroFill()
          DOCUMENT ME!
private  void setBlobTypeBasedOnLength()
           
 void setConnection(Connection conn)
          DOCUMENT ME!
 java.lang.String toString()
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

AUTO_INCREMENT_FLAG

private static final int AUTO_INCREMENT_FLAG
See Also:
Constant Field Values

connection

private Connection connection

charsetName

private java.lang.String charsetName

databaseName

private java.lang.String databaseName

defaultValue

private java.lang.String defaultValue

fullName

private java.lang.String fullName

fullNameWithDatabase

private java.lang.String fullNameWithDatabase

fullOriginalName

private java.lang.String fullOriginalName

fullOriginalNameWithDatabase

private java.lang.String fullOriginalNameWithDatabase

name

private java.lang.String name

originalColumnName

private java.lang.String originalColumnName

originalTableName

private java.lang.String originalTableName

tableName

private java.lang.String tableName

buffer

private byte[] buffer

charsetIndex

private int charsetIndex

colDecimals

private int colDecimals

databaseNameLength

private int databaseNameLength

databaseNameStart

private int databaseNameStart

defaultValueLength

private int defaultValueLength

defaultValueStart

private int defaultValueStart

length

private long length

mysqlType

private int mysqlType

nameLength

private int nameLength

nameStart

private int nameStart

originalColumnNameLength

private int originalColumnNameLength

originalColumnNameStart

private int originalColumnNameStart

originalTableNameLength

private int originalTableNameLength

originalTableNameStart

private int originalTableNameStart

precisionAdjustFactor

private int precisionAdjustFactor

sqlType

private int sqlType

tableNameLength

private int tableNameLength

tableNameStart

private int tableNameStart

colFlag

private short colFlag
Constructor Detail

Field

Field(java.lang.String tableName,
      java.lang.String columnName,
      int jdbcType,
      long length)
Constructor used by DatabaseMetaData methods.


Field

Field(Connection conn,
      byte[] buffer,
      int nameStart,
      int nameLength,
      int tableNameStart,
      int tableNameLength,
      long length,
      int mysqlType,
      short colFlag,
      int colDecimals)
throws java.sql.SQLException
Constructor used when communicating with pre 4.1 servers


Field

Field(Connection conn,
      byte[] buffer,
      int databaseNameStart,
      int databaseNameLength,
      int tableNameStart,
      int tableNameLength,
      int originalTableNameStart,
      int originalTableNameLength,
      int nameStart,
      int nameLength,
      int originalColumnNameStart,
      int originalColumnNameLength,
      long length,
      int mysqlType,
      short colFlag,
      int colDecimals,
      int defaultValueStart,
      int defaultValueLength,
      int charsetIndex)
throws java.sql.SQLException
Constructor used when communicating with 4.1 and newer servers

Method Detail

isAutoIncrement

public boolean isAutoIncrement()
DOCUMENT ME!


isBinary

public boolean isBinary()
DOCUMENT ME!


isBlob

public boolean isBlob()
DOCUMENT ME!


getCharacterSet

public java.lang.String getCharacterSet()
Returns the character set (if known) for this field.


setConnection

public void setConnection(Connection conn)
DOCUMENT ME!


getDatabaseName

public java.lang.String getDatabaseName()
DOCUMENT ME!


getFullName

public java.lang.String getFullName()
DOCUMENT ME!


getFullOriginalName

public java.lang.String getFullOriginalName()
DOCUMENT ME!


getLength

public long getLength()
DOCUMENT ME!


isMultipleKey

public boolean isMultipleKey()
DOCUMENT ME!


getMysqlType

public int getMysqlType()
DOCUMENT ME!


getName

public java.lang.String getName()
DOCUMENT ME!


getOriginalName

public java.lang.String getOriginalName()
DOCUMENT ME!


getOriginalTableName

public java.lang.String getOriginalTableName()
DOCUMENT ME!


getPrecisionAdjustFactor

public int getPrecisionAdjustFactor()
Returns amount of correction that should be applied to the precision value. Different versions of MySQL report different precision values.


isPrimaryKey

public boolean isPrimaryKey()
DOCUMENT ME!


getSQLType

public int getSQLType()
DOCUMENT ME!


getTable

public java.lang.String getTable()
DOCUMENT ME!


getTableName

public java.lang.String getTableName()
DOCUMENT ME!


isUniqueKey

public boolean isUniqueKey()
DOCUMENT ME!


isUnsigned

public boolean isUnsigned()
DOCUMENT ME!


isZeroFill

public boolean isZeroFill()
DOCUMENT ME!


toString

public java.lang.String toString()
DOCUMENT ME!


getDecimals

int getDecimals()

isNotNull

boolean isNotNull()

isReadOnly

boolean isReadOnly()
             throws java.sql.SQLException
Is this field _definitely_ not writable?


getStringFromBytes

private java.lang.String getStringFromBytes(int stringStart,
                                            int stringLength)
Create a string with the correct charset encoding from the byte-buffer that contains the data for this field


setBlobTypeBasedOnLength

private void setBlobTypeBasedOnLength()