CarobNS::Field Class Reference

Field is our private implementation of ResultSetMetaData, holding the information for one column. More...

#include <Field.hpp>

List of all members.

Public Member Functions
	Field (const DriverSocket &sock) throw (SocketIOException, UnexpectedException)
	Creates a new Field object, deserialized from an input socket.
std::wstring	getFieldLabel () const
	Returns the fieldLabel value.
std::wstring	getFieldName () const
	Gets the field name.
std::wstring	getFullName ()
	Gets the full name: "tableName.fieldName".
int	getPrecision ()
	Get the number of decimal digits.
int	getScale ()
	Gets the number of digits to right of the decimal point.
int	getSqlType ()
	Returns the JDBC type code.
std::wstring	getTableName ()
	Gets the table name.
std::wstring	getTypeName ()
	Retrieves the database-specific type name.
std::wstring	getColumnClassName ()
	Returns the Java class used by the mapping.
int	getColumnDisplaySize ()
	Indicates the normal maximum width in characters.
bool	isAutoIncrement ()
	Indicates whether the column (field) is automatically numbered, thus read-only.
bool	isCaseSensitive ()
	Indicates whether a column's case matters.
bool	isCurrency ()
	Indicates whether the column is a cash value.
bool	isDefinitelyWritable ()
	Indicates whether a write will definitely succeed.
int	isNullable ()
	Indicates the nullability of values.
bool	isReadOnly ()
	Indicates whether the column is definitely not writable.
bool	isSearchable ()
	Indicates whether the column can be used in a where clause.
bool	isSigned ()
	Indicates whether values in the column are signed numbers.
bool	isWritable ()
	Indicates whether it is possible for a write on the column to succeed.
std::wstring	toString ()
	Returns the full name of the column.
std::wstring	getEncoding ()
	Retrieves the encoding of the field.

---

Detailed Description

Field is our private implementation of ResultSetMetaData, holding the information for one column.

---

Constructor & Destructor Documentation

CarobNS::Field::Field

(

const DriverSocket &

sock

)

throw (SocketIOException, UnexpectedException)

Creates a new Field object, deserialized from an input socket.

Parameters:

sock

the socket

Exceptions:

SocketIOException

if a stream error occurs

---

Member Function Documentation

std::wstring CarobNS::Field::getFieldLabel

(

)

const [inline]

Returns the fieldLabel value.

Returns:

the fieldLabel

std::wstring CarobNS::Field::getFieldName

(

)

const [inline]

Gets the field name.

Returns:

a wstring containing the field name

std::wstring CarobNS::Field::getFullName

(

)

[inline]

Gets the full name: "tableName.fieldName".

Returns:

a String containing the full field name

int CarobNS::Field::getPrecision

(

)

[inline]

Get the number of decimal digits.

Returns:

precision

int CarobNS::Field::getScale

(

)

[inline]

Gets the number of digits to right of the decimal point.

Returns:

scale

int CarobNS::Field::getSqlType

(

)

[inline]

Returns the JDBC type code.

Returns:

int Type according to java.sql.Types, reflected in TypeConstants.hpp

See also:

TypeConstants.hpp

std::wstring CarobNS::Field::getTableName

(

)

[inline]

Gets the table name.

Returns:

table name

std::wstring CarobNS::Field::getTypeName

(

)

[inline]

Retrieves the database-specific type name.

Returns:

SQL type name

std::wstring CarobNS::Field::getColumnClassName

(

)

[inline]

Returns the Java class used by the mapping.

Not very meanfull for carob, but keeps java driver code reflexion

int CarobNS::Field::getColumnDisplaySize

(

)

[inline]

Indicates the normal maximum width in characters.

Returns:

column display size

bool CarobNS::Field::isCaseSensitive

(

)

[inline]

Indicates whether a column's case matters.

Returns:

true if case sensitive

bool CarobNS::Field::isCurrency

(

)

[inline]

Indicates whether the column is a cash value.

Returns:

true if the column is a currency

bool CarobNS::Field::isDefinitelyWritable

(

)

[inline]

Indicates whether a write will definitely succeed.

Returns:

definitely writable

int CarobNS::Field::isNullable

(

)

[inline]

Indicates the nullability of values.

Returns:

the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown

See also:

ResultSetMetadata.hpp

bool CarobNS::Field::isReadOnly

(

)

[inline]

Indicates whether the column is definitely not writable.

Returns:

is readonly

bool CarobNS::Field::isSearchable

(

)

[inline]

Indicates whether the column can be used in a where clause.

Returns:

is searchable

bool CarobNS::Field::isSigned

(

)

[inline]

Indicates whether values in the column are signed numbers.

Returns:

is signed

bool CarobNS::Field::isWritable

(

)

[inline]

Indicates whether it is possible for a write on the column to succeed.

Returns:

is writable

std::wstring CarobNS::Field::toString

(

)

[inline]

Returns the full name of the column.

Returns:

full name

See also:

getFullName()

std::wstring CarobNS::Field::getEncoding

(

)

[inline]

Retrieves the encoding of the field.

Returns:

encoding

---

The documentation for this class was generated from the following file:

• include/Field.hpp

---