Module org.tentackle.model
Package org.tentackle.model

Interface IndexAttribute

All Known Implementing Classes:
IndexAttributeImpl
public interface IndexAttribute
An attribute of an index.
Author:
harald

  • Method Summary

    Modifier and Type
    Method
    Description
    Attribute
    getAttribute()
    Gets the attribute.
    String
    getColumnName()
    Gets the column name.
    For single-column data types: the column name of the attribute.
    String
    getFunctionName()
    Gets the name of the function.
    boolean
    isDescending()
    Returns whether the attribute is descending.

  • Method Details

    • getAttribute

      Attribute getAttribute()
      Gets the attribute.
      Returns:
      the attribute

    • getColumnName

      String getColumnName()
      Gets the column name.
      For single-column data types: the column name of the attribute. For multi-column data types: the corresponding column name within the data type.
      Returns:
      the column name

    • getFunctionName

      String getFunctionName()
      Gets the name of the function.
      Returns:
      the function name, null if no function-based index

    • isDescending

      boolean isDescending()
      Returns whether the attribute is descending.
      Returns:
      true if descending, else ascending (default)