org.datanucleus.store.rdbms.mapping.datastore

Class CharRDBMSMapping

java.lang.Object

org.datanucleus.store.rdbms.mapping.datastore.AbstractDatastoreMapping

org.datanucleus.store.rdbms.mapping.datastore.CharRDBMSMapping

All Implemented Interfaces:

DatastoreMapping

Direct Known Subclasses:

DB2DatalinkRDBMSMapping, NCharRDBMSMapping, OracleXMLTypeRDBMSMapping, VarCharRDBMSMapping

public class CharRDBMSMapping
extends AbstractDatastoreMapping

Mapping of a CHAR RDBMS type.

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.mapping.datastore.AbstractDatastoreMapping

column, mapping, storeMgr

Constructor Summary

Constructors

Constructor and Description
CharRDBMSMapping(JavaTypeMapping mapping, RDBMSStoreManager storeMgr, Column col) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(ResultSet rs, int param) Method to extract a boolean from the ResultSet at the specified position
char	getChar(ResultSet rs, int param) Method to extract a character from the ResultSet at the specified position
SimpleDateFormat	getJavaUtilDateFormat() Get a Format object to handle java.util.Date.
int	getJDBCType() Method to return the java.sql.Types type that this relates to.
Object	getObject(ResultSet rs, int param) Method to extract an object from the ResultSet at the specified position
String	getString(ResultSet rs, int param) Method to extract a String from the ResultSet at the specified position
protected void	initialize() Method to initialise the column mapping.
boolean	isStringBased() Accessor for whether the mapping is string-based.
void	setBoolean(PreparedStatement ps, int param, boolean value) Method to set a boolean at the specified position in the JDBC PreparedStatement.
void	setChar(PreparedStatement ps, int param, char value) Method to set a character at the specified position in the JDBC PreparedStatement.
void	setObject(PreparedStatement ps, int param, Object value) Method to set an object at the specified position in the JDBC PreparedStatement.
void	setString(PreparedStatement ps, int param, String value) Method to set a String at the specified position in the JDBC PreparedStatement.

Methods inherited from class org.datanucleus.store.rdbms.mapping.datastore.AbstractDatastoreMapping

equals, failureMessage, failureMessage, failureMessage, getByte, getColumn, getDatastoreAdapter, getDouble, getFloat, getInsertionInputParameter, getInt, getJavaTypeMapping, getLong, getShort, getTypeInfo, getUpdateInputParameter, hashCode, includeInFetchStatement, initTypeInfo, insertValuesOnInsert, isBitBased, isBooleanBased, isDecimalBased, isIntegerBased, isNullable, setByte, setDouble, setFloat, setInt, setLong, setShort, useDefaultWhenNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharRDBMSMapping

public CharRDBMSMapping(JavaTypeMapping mapping,
                        RDBMSStoreManager storeMgr,
                        Column col)

Constructor.

Parameters:

mapping - Java type mapping

storeMgr - Store Manager

col - column to be mapped

Method Detail

initialize

protected void initialize()

Method to initialise the column mapping. Provides default length specifications for the CHAR column to fit the data being stored.

isStringBased

public boolean isStringBased()

Accessor for whether the mapping is string-based.

Specified by:

isStringBased in interface DatastoreMapping

Overrides:

isStringBased in class AbstractDatastoreMapping

Returns:

Whether the mapping is string based

getJDBCType

public int getJDBCType()

Description copied from class: AbstractDatastoreMapping

Method to return the java.sql.Types type that this relates to.

Specified by:

getJDBCType in class AbstractDatastoreMapping

Returns:

The JDBC "type"

setChar

public void setChar(PreparedStatement ps,
                    int param,
                    char value)

Method to set a character at the specified position in the JDBC PreparedStatement.

Specified by:

setChar in interface DatastoreMapping

Overrides:

setChar in class AbstractDatastoreMapping

Parameters:

ps - The PreparedStatement

param - Parameter position

value - The value to set

getChar

public char getChar(ResultSet rs,
                    int param)

Method to extract a character from the ResultSet at the specified position

Specified by:

getChar in interface DatastoreMapping

Overrides:

getChar in class AbstractDatastoreMapping

Parameters:

rs - The Result Set

param - The parameter position

Returns:

the character

setString

public void setString(PreparedStatement ps,
                      int param,
                      String value)

Method to set a String at the specified position in the JDBC PreparedStatement.

Specified by:

setString in interface DatastoreMapping

Overrides:

setString in class AbstractDatastoreMapping

Parameters:

ps - The PreparedStatement

param - Parameter position

value - The value to set

getString

public String getString(ResultSet rs,
                        int param)

Method to extract a String from the ResultSet at the specified position

Specified by:

getString in interface DatastoreMapping

Overrides:

getString in class AbstractDatastoreMapping

Parameters:

rs - The Result Set

param - The parameter position

Returns:

the String

setBoolean

public void setBoolean(PreparedStatement ps,
                       int param,
                       boolean value)

Method to set a boolean at the specified position in the JDBC PreparedStatement.

Specified by:

setBoolean in interface DatastoreMapping

Overrides:

setBoolean in class AbstractDatastoreMapping

Parameters:

ps - The PreparedStatement

param - Parameter position

value - The value to set

getBoolean

public boolean getBoolean(ResultSet rs,
                          int param)

Method to extract a boolean from the ResultSet at the specified position

Specified by:

getBoolean in interface DatastoreMapping

Overrides:

getBoolean in class AbstractDatastoreMapping

Parameters:

rs - The Result Set

param - The parameter position

Returns:

the boolean

setObject

public void setObject(PreparedStatement ps,
                      int param,
                      Object value)

Method to set an object at the specified position in the JDBC PreparedStatement.

Specified by:

setObject in interface DatastoreMapping

Overrides:

setObject in class AbstractDatastoreMapping

Parameters:

ps - The PreparedStatement

param - Parameter position

value - The value to set

getObject

public Object getObject(ResultSet rs,
                        int param)

Method to extract an object from the ResultSet at the specified position

Specified by:

getObject in interface DatastoreMapping

Overrides:

getObject in class AbstractDatastoreMapping

Parameters:

rs - The Result Set

param - The parameter position

Returns:

the object

getJavaUtilDateFormat

public SimpleDateFormat getJavaUtilDateFormat()

Get a Format object to handle java.util.Date. If a TimeZone is present, it will be used to format dates to that zone.

Returns:

Date formatter to use