Package org.jumpmind.db.model

Class IndexColumn

java.lang.Object
org.jumpmind.db.model.IndexColumn
All Implemented Interfaces:
Serializable, Cloneable
public class IndexColumn extends Object implements Cloneable, Serializable
Represents a column of an index in the database model.
See Also:

  • Field Details

    • name

      protected String name
      The name of the column.

    • size

      protected String size
      The size of the column in the index.

    • primaryKey

      protected boolean primaryKey

  • Constructor Details

    • IndexColumn

      public IndexColumn()
      Creates a new index column object.

    • IndexColumn

      public IndexColumn(Column column)
      Creates a new index column object.
      Parameters:
      column - The indexed column

    • IndexColumn

      public IndexColumn(String columnName)
      Creates a new index column object.
      Parameters:
      columnName - The name of the corresponding table column

  • Method Details

    • getOrdinalPosition

      public int getOrdinalPosition()
      Returns the position within the owning index.
      Returns:
      The position

    • setOrdinalPosition

      public void setOrdinalPosition(int position)
      Sets the position within the owning index. Please note that you should not change the value once the column has been added to a index.
      Parameters:
      position - The position

    • getName

      public String getName()
      Returns the name of the column.
      Returns:
      The name

    • setName

      public void setName(String name)
      Sets the name of the column.
      Parameters:
      name - The name

    • getColumn

      public Column getColumn()
      Returns the indexed column.
      Returns:
      The column

    • setColumn

      public void setColumn(Column column)
      Sets the indexed column.
      Parameters:
      column - The column

    • getSize

      public String getSize()
      Returns the size of the column in the index.
      Returns:
      The size

    • setSize

      public void setSize(String size)
      Sets the size of the column in the index.
      Parameters:
      size - The size

    • setPrimaryKey

      public void setPrimaryKey(boolean primaryKey)

    • isPrimaryKey

      public boolean isPrimaryKey()

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsIgnoreCase

      public boolean equalsIgnoreCase(IndexColumn other)
      Compares this index column to the given one while ignoring the case of identifiers.
      Parameters:
      other - The other index column
      Returns:
      true if this index column is equal (ignoring case) to the given one

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object