Class ForeignKeyInfo

java.lang.Object
org.datanucleus.store.rdbms.schema.ForeignKeyInfo
All Implemented Interfaces:
org.datanucleus.store.schema.StoreSchemaData
public class ForeignKeyInfo extends Object implements org.datanucleus.store.schema.StoreSchemaData
Represents the metadata of a specific foreign key column. Supports the following properties.
  • pk_table_cat
  • pk_table_schem
  • pk_table_name
  • pk_column_name
  • fk_table_cat
  • fk_table_schem
  • fk_table_name
  • fk_column_name
  • key_seq
  • update_rule
  • delete_rule
  • pk_name
  • fk_name
  • deferrability

  • Field Details

    • properties

      Map<String,Object> properties
      Properties of the foreign-key.

    • hash

      private int hash
      Hashcode. Set on first use.

  • Constructor Details

    • ForeignKeyInfo

      public ForeignKeyInfo(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 Details

    • addProperty

      public void addProperty(String name, 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 Object getProperty(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(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 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 Object
      Returns:
      a hash code value for this object.

    • toString

      public String toString()
      Returns the string representation of this object.
      Overrides:
      toString in class Object
      Returns:
      string representation of this object.