com.triactive.jdo.store.adapter
Class PrimaryKeyInfo

java.lang.Object
  extended bycom.triactive.jdo.store.adapter.CatalogInfo
      extended bycom.triactive.jdo.store.adapter.PrimaryKeyInfo

public class PrimaryKeyInfo
extends CatalogInfo

Represents the metadata of a specific primary key column. This class is basically a data structure that makes accessing the JDBC primary key metadata easier. Each of the items returned by DatabaseMetaData.getPrimaryKeys(java.lang.String, java.lang.String, java.lang.String) is represented by a public field in this class.

Subclasses of PrimaryKeyInfo can be created on a per-DBMS basis to supply missing metadata or correct faulty metadata obtained from that DBMS's JDBC driver(s).

Author:
Mike Martin
See Also:
DatabaseAdapter.newPrimaryKeyInfo(java.sql.ResultSet)

Field Summary
 java.lang.String columnName
          The primary key column name.
 short keySeq
          The sequence number within the primary key, base 1.
 java.lang.String pkName
          The primary key name.
 java.lang.String tableCat
          The primary key table catalog, which may be null.
 java.lang.String tableName
          The primary key table name.
 java.lang.String tableSchem
          The primary key table schema, which may be null.
 
Constructor Summary
PrimaryKeyInfo(java.sql.ResultSet rs)
          Constructs a primary key information object from the current row of the given result set.
PrimaryKeyInfo(java.lang.String tableCat, java.lang.String tableSchem, java.lang.String tableName, java.lang.String columnName, short keySeq, java.lang.String pkName)
          Constructs a primary key information object from its individual attributes.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some object is "equal to" this one.
 java.lang.String getTableCatalog()
           
 java.lang.String getTableName()
           
 java.lang.String getTableSchema()
           
 int hashCode()
          Returns a hash code value for this object.
 java.lang.String toString()
          Returns the string representation of this object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

tableCat

public java.lang.String tableCat
The primary key table catalog, which may be null.


tableSchem

public java.lang.String tableSchem
The primary key table schema, which may be null.


tableName

public java.lang.String tableName
The primary key table name.


columnName

public java.lang.String columnName
The primary key column name.


keySeq

public short keySeq
The sequence number within the primary key, base 1.


pkName

public java.lang.String pkName
The primary key name.

Constructor Detail

PrimaryKeyInfo

public PrimaryKeyInfo(java.sql.ResultSet rs)
               throws java.sql.SQLException
Constructs a primary key information object from the current row of the given result set. The result set passed must have been obtained from a call to DatabaseMetaData.getPrimaryKeys().

This method only retrieves the values from the current row; the caller is required to advance to the next row with ResultSet.next().

Parameters:
rs - The result set returned from DatabaseMetaData.getPrimaryKeys().
Throws:
java.sql.SQLException - if a column of primary key information could not be retrieved from the result set.

PrimaryKeyInfo

public PrimaryKeyInfo(java.lang.String tableCat,
                      java.lang.String tableSchem,
                      java.lang.String tableName,
                      java.lang.String columnName,
                      short keySeq,
                      java.lang.String pkName)
Constructs a primary key information object from its individual attributes.

This can be useful to subclasses and/or custom DatabaseAdapters that need to modify and/or correct the metadata returned by the JDBC driver.

Method Detail

getTableCatalog

public java.lang.String getTableCatalog()
Specified by:
getTableCatalog in class CatalogInfo

getTableSchema

public java.lang.String getTableSchema()
Specified by:
getTableSchema in class CatalogInfo

getTableName

public java.lang.String getTableName()
Specified by:
getTableName in class CatalogInfo

equals

public final boolean equals(java.lang.Object obj)
Indicates whether some object is "equal to" this one. Two PrimaryKeyInfo objects are considered equal if their catalog, schema, table, and column names are all equal.

Parameters:
obj - the reference object with which to compare
Returns:
true if this object is equal to the obj argument; false otherwise.

hashCode

public final int hashCode()
Returns a hash code value for this object.


toString

public java.lang.String toString()
Returns the string representation of this object.



Copyright 2001-2007 The TJDO Project All Rights Reserved.