Class RDBMSColumnInfo

java.lang.Object
org.datanucleus.store.rdbms.schema.RDBMSColumnInfo
All Implemented Interfaces:
org.datanucleus.store.schema.ListStoreSchemaData, org.datanucleus.store.schema.StoreSchemaData
public class RDBMSColumnInfo extends Object implements org.datanucleus.store.schema.ListStoreSchemaData
Representation of column schema information in the datastore.

  • Field Details

    • tableCat

      protected String tableCat
      The table catalog, which may be null.

    • tableSchem

      protected String tableSchem
      The table schema, which may be null.

    • tableName

      protected String tableName
      The table name.

    • columnName

      protected String columnName
      The column name.

    • dataType

      protected short dataType
      Indicates the JDBC (SQL) data type from Types.

    • typeName

      protected String typeName
      The local type name used by the data source.

    • columnSize

      protected int columnSize
      The column size. For char/date types, this is the maximum num of chars, otherwise precision.

    • decimalDigits

      protected int decimalDigits
      Indicates the number of fractional digits.

    • numPrecRadix

      protected int numPrecRadix
      Indicates the radix, which is typically either 10 or 2.

    • nullable

      protected int nullable
      Indicates whether the column can be NULL.

    • remarks

      protected String remarks
      An explanatory comment on the column; may be null.

    • columnDef

      protected String columnDef
      The default value for the column; may be null.

    • charOctetLength

      protected int charOctetLength
      Indicates the maximum number of bytes in the column (for char types only).

    • ordinalPosition

      protected int ordinalPosition
      The index of the column in its table; the first column is 1, the second column is 2.

    • isNullable

      protected String isNullable
      Whether the column definitely doesnt allow NULL values ("NO") or possibly does ("YES").

    • hash

      private int hash
      Hashcode. Set on first use.

    • tableInfo

      RDBMSTableInfo tableInfo
      Parent table schema info.

  • Constructor Details

    • RDBMSColumnInfo

      public RDBMSColumnInfo(ResultSet rs)
      Constructor to create a column info definition for the current row of the passed ResultSet.
      Parameters:
      rs - ResultSet (from DatabaseMetaData.getColumns() for example).
      Throws:
      org.datanucleus.exceptions.NucleusDataStoreException - Thrown if an error occurs getting the information

  • Method Details

    • setParent

      public void setParent(org.datanucleus.store.schema.StoreSchemaData parent)
      Mutator for the parent component.
      Specified by:
      setParent in interface org.datanucleus.store.schema.ListStoreSchemaData
      Parameters:
      parent - Parent component

    • getParent

      public org.datanucleus.store.schema.StoreSchemaData getParent()
      Accessor for the parent Table schema component.
      Specified by:
      getParent in interface org.datanucleus.store.schema.ListStoreSchemaData
      Returns:
      Table schema

    • setDecimalDigits

      public void setDecimalDigits(int digits)

    • setDataType

      public void setDataType(short type)

    • setColumnSize

      public void setColumnSize(int size)

    • setColumnDef

      public void setColumnDef(String def)

    • getDecimalDigits

      public int getDecimalDigits()

    • getIsNullable

      public String getIsNullable()

    • getNullable

      public int getNullable()

    • getColumnSize

      public int getColumnSize()

    • getDataType

      public short getDataType()

    • getNumPrecRadix

      public int getNumPrecRadix()

    • getCharOctetLength

      public int getCharOctetLength()

    • getOrdinalPosition

      public int getOrdinalPosition()

    • getColumnDef

      public String getColumnDef()

    • getRemarks

      public String getRemarks()

    • getTypeName

      public String getTypeName()

    • getTableName

      public String getTableName()

    • getColumnName

      public String getColumnName()

    • getTableCat

      public String getTableCat()

    • getTableSchem

      public String getTableSchem()

    • addProperty

      public void addProperty(String name, Object value)
      Method to add a property for the column.
      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

    • addChild

      public void addChild(org.datanucleus.store.schema.StoreSchemaData child)
      Specified by:
      addChild in interface org.datanucleus.store.schema.ListStoreSchemaData

    • clearChildren

      public void clearChildren()
      Method to remove all children.
      Specified by:
      clearChildren in interface org.datanucleus.store.schema.ListStoreSchemaData

    • getChild

      public org.datanucleus.store.schema.StoreSchemaData getChild(int position)
      Specified by:
      getChild in interface org.datanucleus.store.schema.ListStoreSchemaData

    • getChildren

      public List<org.datanucleus.store.schema.StoreSchemaData> getChildren()
      Specified by:
      getChildren in interface org.datanucleus.store.schema.ListStoreSchemaData

    • getNumberOfChildren

      public int getNumberOfChildren()
      Specified by:
      getNumberOfChildren in interface org.datanucleus.store.schema.ListStoreSchemaData

    • equals

      public final boolean equals(Object obj)
      Indicates whether some object is "equal to" this one. Two RDBMSColumnInfo are considered equal if their catalog, schema, table, and column name 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.