org.datanucleus.store.rdbms.schema
Class ForeignKeyInfo

java.lang.Object
  extended by org.datanucleus.store.rdbms.schema.ForeignKeyInfo
All Implemented Interfaces:
org.datanucleus.store.schema.StoreSchemaData

public class ForeignKeyInfo
extends java.lang.Object
implements org.datanucleus.store.schema.StoreSchemaData

Represents the metadata of a specific foreign key column. Supports the following properties.


Constructor Summary
ForeignKeyInfo(java.sql.ResultSet rs)
          Constructs a foreign key information object from the current row of the given result set.
 
Method Summary
 void addProperty(java.lang.String name, java.lang.Object value)
          Method to add a property for the type.
 boolean equals(java.lang.Object obj)
          Indicates whether some object is "equal to" this one.
 java.lang.Object getProperty(java.lang.String name)
          Accessor for a property.
 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
 

Constructor Detail

ForeignKeyInfo

public ForeignKeyInfo(java.sql.ResultSet rs)
Constructs a foreign key information object from the current row of the given result set. The ResultSet object passed must have been obtained from a call to java.sql.DatabaseMetaData.getImportedKeys() or java.sql.DatabaseMetaData.getImportedKeys().

Parameters:
rs - The result set returned from java.sql.DatabaseMetaData.getImportedKeys() or java.sql.DatabaseMetaData.getExportedKeys().
Throws:
org.datanucleus.exceptions.NucleusDataStoreException - if an exception is thrown upon retrieval
Method Detail

addProperty

public void addProperty(java.lang.String name,
                        java.lang.Object value)
Method to add a property for the type.

Specified by:
addProperty in interface org.datanucleus.store.schema.StoreSchemaData
Parameters:
name - Name of property
value - Its value

getProperty

public java.lang.Object getProperty(java.lang.String name)
Accessor for a property.

Specified by:
getProperty in interface org.datanucleus.store.schema.StoreSchemaData
Parameters:
name - Name of the property
Returns:
Its value, or null if not defined

equals

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

Overrides:
equals in class java.lang.Object
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.

Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value for this object.

toString

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

Overrides:
toString in class java.lang.Object
Returns:
string representation of this object.


Copyright © 2009. All Rights Reserved.