Module org.tentackle.sql
Package org.tentackle.sql.metadata

Class IndexColumnMetaData

java.lang.Object
org.tentackle.sql.metadata.IndexColumnMetaData
All Implemented Interfaces:
Comparable<IndexColumnMetaData>
Direct Known Subclasses:
PostgresIndexColumnMetaData
public class IndexColumnMetaData extends Object implements Comparable<IndexColumnMetaData>
Metadata for a column of an index.
Author:
harald

  • Constructor Details

    • IndexColumnMetaData

      public IndexColumnMetaData(IndexMetaData indexMetaData)
      Creates an index column.
      Parameters:
      indexMetaData - the index column belongs to

  • Method Details

    • setupIndexColumnFromMetaData

      public void setupIndexColumnFromMetaData(ResultSet resultSet) throws SQLException
      Sets up the index column from the database metadata result.
      Parameters:
      resultSet - the column result set
      Throws:
      SQLException - the processing the result set failed

    • getIndexMetaData

      public IndexMetaData getIndexMetaData()
      Gets the index.
      Returns:
      index column belongs to

    • isDescending

      public boolean isDescending()
      Returns ascending or descending order.
      Returns:
      true if descending

    • getColumnName

      public String getColumnName()
      Gets the column columnName.
      Returns:
      the index column's columnName in lowercase

    • getFunctionName

      public String getFunctionName()
      Gets the optional function name.
      Returns:
      the function in uppercase, null if none

    • getPosition

      public int getPosition()
      Gets the ordinal position within the index.
      Returns:
      the position

    • compareTo

      public int compareTo(IndexColumnMetaData o)
      Specified by:
      compareTo in interface Comparable<IndexColumnMetaData>

    • validate

      public void validate()
      Validates and post-processes the index column data.

    • toString

      public String toString()
      Overrides:
      toString in class Object