Package overit.geocall.edm.model

Interface Index

All Superinterfaces:
DataAttributesHolder
public interface Index extends DataAttributesHolder
Represents a database index associated with an EDM entity.
An index is used to improve query performance by creating a data structure that allows faster access to records based on specific fields.

  • Field Details

  • Method Details

    • getId

      Long getId()
      Returns the ID of the index.
      Returns:
      the ID of the index.

    • setId

      void setId(Long id)
      Sets the ID of the index.
      Parameters:
      id - the ID of the index.

    • getName

      String getName()
      Returns the name of the index.
      Returns:
      the name of the index.

    • getDescription

      String getDescription()
      Returns the description of the index.
      Returns:
      the description of the index.

    • getTableName

      String getTableName()
      Returns a String about the name of the table.
      Returns:
      a String about the name of the table.

    • getEntityName

      String getEntityName()
      Returns a String about the name of the entity.
      Returns:
      a String about the name of the entity.

    • getCompany

      Company getCompany()
      Returns the Company associated to this Index instance.
      Returns:
      the Company associated to this Index instance.

    • getCompanyIdField

      String getCompanyIdField()
      Returns the field of the table in which is stored the company ID value associated with the entity model.
      Returns:
      the field of the table in which is stored the company ID value associated with the entity model.

    • getFields

      List<BaseDataAttribute> getFields()
      Returns the List<BaseDataAttribute> (fields) that are part of this index.
      Returns:
      the list of fields included in the index.

    • isUnique

      boolean isUnique()
      Determines whether this index enforces uniqueness constraint.
      Returns:
      true if the index is unique, false otherwise.

    • isUniqueAdapted

      default char isUniqueAdapted()
      Returns TRUE_CHAR_VALUE in case this index is unique; FALSE_CHAR_VALUE otherwise.
      Returns:
      TRUE_CHAR_VALUE in case this index is unique; FALSE_CHAR_VALUE otherwise.

    • getRealName

      String getRealName()
      Returns a String about the real name of the index in the application database.
      Returns:
      a String about the real name of the index in the application database.

    • isAddReverse

      boolean isAddReverse()
      Returns the true in case this index must also be added in reverse order; false otherwise.
      Returns:
      the true in case this index must also be added in reverse order; false otherwise.

    • isAddReverseAdapted

      default char isAddReverseAdapted()
      Returns TRUE_CHAR_VALUE in case this index must also be added in reverse order; FALSE_CHAR_VALUE otherwise.
      Returns:
      TRUE_CHAR_VALUE in case this index must also be added in reverse order; FALSE_CHAR_VALUE otherwise.

    • getStatus

      IndexCreationStatus getStatus()
      Returns the IndexCreationStatus of this Index.
      Returns:
      the IndexCreationStatus of this Index.

    • setStatus

      void setStatus(IndexCreationStatus status)
      Sets the IndexCreationStatus of this Index.
      Parameters:
      status - the IndexCreationStatus of this Index.