001/* DataTruncation.java -- Warning when data has been truncated.
002   Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010 
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.sql;
039
040/**
041  * This exception is thrown when a piece of data is unexpectedly 
042  * truncated in JDBC.
043  *
044  * @author Aaron M. Renn (arenn@urbanophile.com)
045  */
046public class DataTruncation extends SQLWarning 
047{
048  static final long serialVersionUID = 6464298989504059473L;
049
050  /**
051   * The original size of the data.
052   */
053  private int dataSize;
054
055  /**
056   * The index of the parameter or column whose value was truncated.
057   */
058  private int index;
059
060  /**
061   * Indicates whether or not a parameter value was truncated.
062   */
063  private boolean parameter;
064
065  /**
066   * Indicates whether or not a data column value was truncated.
067   */
068  private boolean read;
069
070  /**
071   * This is the size of the data after truncation.
072   */
073  private int transferSize;
074
075  /**
076   * This method initializes a new instance of <code>DataTruncation</code>
077   * with the specified values.  The descriptive error message for this 
078   * exception will be "Data truncation", the SQL state will be "01004"
079   * and the vendor specific error code will be set to 0.
080   *
081   * @param index The index of the parameter or column that was truncated.
082   * @param parameter <code>true</code> if a parameter was truncated,
083   *        <code>false</code> otherwise.
084   * @param read <code>true</code> if a data column was truncated,
085   *        <code>false</code> otherwise.
086   * @param dataSize The original size of the data.
087   * @param transferSize The size of the data after truncation.
088   */
089  public DataTruncation(int index, boolean parameter, boolean read, int
090    dataSize, int transferSize)
091  {
092    super("Data truncation", "01004");
093
094    this.index = index;
095    this.parameter = parameter;
096    this.read = read;
097    this.dataSize = dataSize;
098    this.transferSize = transferSize;
099  }
100
101  /**
102   * This method returns the index of the column or parameter that was
103   * truncated.
104   *
105   * @return The index of the column or parameter that was truncated.
106   */
107  public int getIndex()
108  {
109    return index;
110  }
111
112  /**
113   * This method determines whether or not it was a parameter that was
114   * truncated.
115   *
116   * @return <code>true</code> if a parameter was truncated, <code>false</code>
117   * otherwise.
118   */
119  public boolean getParameter()
120  {
121    return parameter;
122  }
123
124  /**
125   * This method determines whether or not it was a column that was
126   * truncated.
127   *
128   * @return <code>true</code> if a column was truncated, <code>false</code>
129   * otherwise.
130   */
131  public boolean getRead()
132  {
133    return read;
134  }
135
136  /**
137   * This method returns the original size of the parameter or column that
138   * was truncated.
139   *
140   * @return The original size of the parameter or column that was truncated.
141   */
142  public int getDataSize()
143  {
144    return dataSize;
145  }
146
147  /**
148   * This method returns the size of the parameter or column after it was
149   * truncated.
150   *
151   * @return The size of the parameter or column after it was truncated.
152   */
153  public int getTransferSize()
154  {
155    return transferSize;
156  }
157}