java.sql
Class DataTruncation

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjava.sql.SQLException
              extended byjava.sql.SQLWarning
                  extended byjava.sql.DataTruncation
All Implemented Interfaces:
Serializable

public class DataTruncation
extends SQLWarning

An exception that reports a DataTruncation warning (on reads) or throws a DataTruncation exception (on writes) when JDBC unexpectedly truncates a data value.

The SQLstate for a DataTruncation is 01004.

See Also:
Serialized Form

Field Summary
private  int dataSize
           
private  int index
           
private  boolean parameter
           
private  boolean read
           
private  int transferSize
           
 
Fields inherited from class java.sql.SQLException
 
Fields inherited from class java.lang.Exception
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
DataTruncation(int index, boolean parameter, boolean read, int dataSize, int transferSize)
          Creates a DataTruncation object with the SQLState initialized to 01004, the reason set to "Data truncation", the vendorCode set to the SQLException default, and the other fields set to the given values.
 
Method Summary
 int getDataSize()
          Gets the number of bytes of data that should have been transferred.
 int getIndex()
          Retrieves the index of the column or parameter that was truncated.
 boolean getParameter()
          Indicates whether the value truncated was a parameter value or a column value.
 boolean getRead()
          Indicates whether or not the value was truncated on a read.
 int getTransferSize()
          Gets the number of bytes of data actually transferred.
 
Methods inherited from class java.sql.SQLWarning
getNextWarning, setNextWarning
 
Methods inherited from class java.sql.SQLException
getErrorCode, getNextException, getSQLState, setNextException
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

index

private int index

parameter

private boolean parameter

read

private boolean read

dataSize

private int dataSize

transferSize

private int transferSize
Constructor Detail

DataTruncation

public DataTruncation(int index,
                      boolean parameter,
                      boolean read,
                      int dataSize,
                      int transferSize)
Creates a DataTruncation object with the SQLState initialized to 01004, the reason set to "Data truncation", the vendorCode set to the SQLException default, and the other fields set to the given values.

Parameters:
index - The index of the parameter or column value
parameter - true if a parameter value was truncated
read - true if a read was truncated
dataSize - the original size of the data
transferSize - the size after truncation
Method Detail

getIndex

public int getIndex()
Retrieves the index of the column or parameter that was truncated.

This may be -1 if the column or parameter index is unknown, in which case the parameter and read fields should be ignored.

Returns:
the index of the truncated paramter or column value

getParameter

public boolean getParameter()
Indicates whether the value truncated was a parameter value or a column value.

Returns:
true if the value truncated was a parameter; false if it was a column value

getRead

public boolean getRead()
Indicates whether or not the value was truncated on a read.

Returns:
true if the value was truncated when read from the database; false if the data was truncated on a write

getDataSize

public int getDataSize()
Gets the number of bytes of data that should have been transferred. This number may be approximate if data conversions were being performed. The value may be -1 if the size is unknown.

Returns:
the number of bytes of data that should have been transferred

getTransferSize

public int getTransferSize()
Gets the number of bytes of data actually transferred. The value may be -1 if the size is unknown.

Returns:
the number of bytes of data actually transferred