org.afcs.warts.handlers
Class TimestampHandler

java.lang.Object
  org.afcs.warts.handlers.DataHandlerSupport
      org.afcs.warts.handlers.TimestampHandler

All Implemented Interfaces:

DataHandler

public final class TimestampHandler

extends DataHandlerSupport

implements DataHandler

The TimestampHandler class handles the reading and writing of date (or timestamp) data.

The object returned by loadValue(java.sql.ResultSet, int), and expected by bindValue() and printValue() is a java.sql.Timestamp instance.

LICENSE: This code is released to the public domain and may be used for any purpose whatsoever without permission or acknowledgment.

Version:

Last Modified 20 August 2003

Author:

Warren Hedley ( whedley at sdsc dot edu )

Constructor Summary

TimestampHandler(TableDescription tableDescription, ColumnDescription columnDescription)
Constructs a new instance on behalf of subclasses that will handle data values for the specified column in the specified table.

Method Summary

void	bindNonNullValue(java.sql.PreparedStatement statement, int variableIndex, java.lang.Object value) This method binds the specified non-null value (which should be a java.sql.Timestamp instance) to the specified index in the specified statement.
java.lang.Object	loadValue(java.sql.ResultSet resultSet, int columnIndex) Returns a java.sql.Timestamp instance with the value of the specified column from the specified result set, if non-null.
java.lang.String	printNonNullValue(java.lang.Object value) Returns a representation of the specified value (which should be a java.sql.Timestamp instance) that is appropriate for inclusion in a SQL script.

Methods inherited from class org.afcs.warts.handlers.DataHandlerSupport

getColumnDescription, getNullType, getTableDescription, isCharacterData, isNullHandler, loadBytesFromStream, logWrongValueTypeWarning, postProcessBind, requiresBindPostProcessing, requiresStreamedLoading, toString, verifyObjectIsString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.afcs.warts.handlers.DataHandler

getNullType, isCharacterData, isNullHandler, postProcessBind, requiresBindPostProcessing, requiresStreamedLoading

Constructor Detail

TimestampHandler

public TimestampHandler(TableDescription tableDescription,
                        ColumnDescription columnDescription)

Constructs a new instance on behalf of subclasses that will handle data values for the specified column in the specified table.

Parameters:

tableDescription - The table that the handler will be handling data for.

columnDescription - The column that this class will be processing data for.

Method Detail

bindNonNullValue

public void bindNonNullValue(java.sql.PreparedStatement statement,
                             int variableIndex,
                             java.lang.Object value)
                      throws java.sql.SQLException

This method binds the specified non-null value (which should be a java.sql.Timestamp instance) to the specified index in the specified statement. A warning message is logged if the value is not a Timestamp.

Specified by:

bindNonNullValue in interface DataHandler

Parameters:

statement - The statement to bind the value in.

variableIndex - The index of the variable to bind.

value - The value to bind to the statement.

Throws:

java.sql.SQLException - If a SQL error occurs during binding.

loadValue

public java.lang.Object loadValue(java.sql.ResultSet resultSet,
                                  int columnIndex)
                           throws java.sql.SQLException

Returns a java.sql.Timestamp instance with the value of the specified column from the specified result set, if non-null.

Specified by:

loadValue in interface DataHandler

Parameters:

resultSet - The result set to load data from.

columnIndex - The index of the column to load data from.

Returns:

A Timestamp instance or null.

Throws:

java.sql.SQLException - If a SQL exception occurs while loading data.

printNonNullValue

public java.lang.String printNonNullValue(java.lang.Object value)

Returns a representation of the specified value (which should be a java.sql.Timestamp instance) that is appropriate for inclusion in a SQL script.

Specified by:

printNonNullValue in interface DataHandler

Parameters:

value - The object value to print.

Returns:

A string containing a representation of the specified value appropriate for use in a SQL script.