: Class RealColumnMetaData (RealSQL-JDBC)

External Interfaces > Reality Java Interface > JavaDocs > JavaDocs for Reality SQL/JDBC Classes > RealColumnMetaData

Documentation Comments

Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.

Reality V15.0 ()

: Class RealColumnMetaData (RealSQL-JDBC) (realcolumnmetadata.html)

To	Reality
Version
Topic
Submitted by
Company
Location
Email address
Comment

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.northgateis.reality.realsql
Class RealColumnMetaData

java.lang.Object
 |
 +--com.northgateis.reality.realsql.RealColumnMetaData

public class RealColumnMetaData
extends java.lang.Object

The RealColumnMetaData class is used as a container for the column METADATA returned from the Reality SQL Server on completion of the PREPARE phase of an SQL query that returns a ResultSet.

See Also:: ResultSet, RealSQLResultSetMetaData

Constructor Summary
`RealColumnMetaData(RealRowParser row)` Constructs an `RealSQLColumnMetaData` object from the specified row.

Method Summary
`java.lang.String`	`getColumnLabel()` Retrieves the column label, if none assigned this defaults to the column name.
`java.lang.String`	`getColumnName()` Retrieves the column name.
`int`	`getDisplayLength()` Retrieves the maximum display length for this column.
`java.lang.String`	`getOwnerName()` Retrieves the schema (owner) name to which table this column belongs.
`int`	`getPrecision()` Retrieves the column precision.
`int`	`getRealSQLType()` Retrieves the Reality SQL Type.
`int`	`getScale()` Retrieves the column scale.
`int`	`getSQLType()` Retrieves the JDBC SQL Type.
`java.lang.String`	`getTableName()` Retrieves the table name to which this column belongs.
`boolean`	`isAutoIncrement()` Indicates whether the column is automatically numbered, thus read-only.
`boolean`	`isCaseSensitive()` Indicates whether a column's case matters.
`boolean`	`isCurrency()` Indicates whether the column is a cash value.
`boolean`	`isDefinitelyWritable()` Indicates whether a write on the column will definitely succeed.
`boolean`	`isNullable()` Indicates the nullability of values in the designated column.
`boolean`	`isReadOnly()` Indicates whether a column is read-only.
`boolean`	`isSearchable()` Indicates whether the column can be used in a where clause.
`boolean`	`isSigned()` Indicates whether values in the column are signed numbers.
`boolean`	`isWritable()` Indicates whether it is possible for a write on the column to succeed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealColumnMetaData

public RealColumnMetaData(RealRowParser row)
 throws java.sql.SQLException

Constructs an RealSQLColumnMetaData object from the specified row.

Parameters:: row - containing the column metadata.
Throws:: java.sql.SQLException - if an error occurs when reading the row.

Method Detail

getOwnerName

public java.lang.String getOwnerName()

Retrieves the schema (owner) name to which table this column belongs.

Returns:: schema name

getTableName

public java.lang.String getTableName()

Retrieves the table name to which this column belongs.

Returns:: table name

getColumnName

public java.lang.String getColumnName()

Retrieves the column name.

Returns:: column name

getColumnLabel

public java.lang.String getColumnLabel()

Retrieves the column label, if none assigned this defaults to the column name.

Returns:: column label

getRealSQLType

public int getRealSQLType()

Retrieves the Reality SQL Type.

Returns:: RealSQLType for this column.
See Also:: RealTypes

getPrecision

public int getPrecision()

Retrieves the column precision.

Returns:: precision

getScale

public int getScale()

Retrieves the column scale.

Returns:: scale

getDisplayLength

public int getDisplayLength()

Retrieves the maximum display length for this column.

Returns:: maximum display length

getSQLType

public int getSQLType()

Retrieves the JDBC SQL Type.

Returns:: SQL type
See Also:: Types

isAutoIncrement

public boolean isAutoIncrement()

Indicates whether the column is automatically numbered, thus read-only.

Returns:: true if column is automatically numbered; else false.

isCaseSensitive

public boolean isCaseSensitive()

Indicates whether a column's case matters.

Returns:: true if this column's case matters; else false.

isCurrency

public boolean isCurrency()

Indicates whether the column is a cash value.

Returns:: true if this column is a cash value; else false.

isDefinitelyWritable

public boolean isDefinitelyWritable()

Indicates whether a write on the column will definitely succeed.

Returns:: true if a write on this column will definitely succeed; else false.

isNullable

public boolean isNullable()

Indicates the nullability of values in the designated column.

Returns:: true if this column is nullable; else false.

isReadOnly

public boolean isReadOnly()

Indicates whether a column is read-only.

Returns:: true if this column is read-only; else false.

isSearchable

public boolean isSearchable()

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

Returns:: true if this column can be used in a where clause; else false.

isSigned

public boolean isSigned()

Indicates whether values in the column are signed numbers.

Returns:: true if this column values are signed; else false.

isWritable

public boolean isWritable()

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

Returns:: false