fi.pelam.csv.cell

CellKey

final case class CellKey(rowIndex: Int, colIndex: Int) extends Ordered[CellKey] with Product with Serializable

Coordinates of a Cell in a CSV "table".

Basically a composition of RowKey and ColKey or alternatively just two zero based integers rowIndex and colIndex.

Each Cell has a CellKey as a member.

Cell coordinates

Columns and rows are thought to start from top left corner.

Typically in spreadsheet programs columns are numbered with an alphabetical scheme and the row number is a one based integer.

Ordering

CellKeys are ordered first in increasing row order and then in increasing column order.

The object representations provide type safety and spread sheet style column and row numbering.

Source
CellKey.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Ordered[CellKey], Comparable[CellKey], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CellKey
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Ordered
  7. Comparable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CellKey(rowIndex: Int, colIndex: Int)

    See alternate constructors on the companion object.

    See alternate constructors on the companion object. Create a new CellKey from row index and column index.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def <(that: CellKey): Boolean

    Definition Classes
    Ordered

  4. def <=(that: CellKey): Boolean

    Definition Classes
    Ordered

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  6. def >(that: CellKey): Boolean

    Definition Classes
    Ordered

  7. def >=(that: CellKey): Boolean

    Definition Classes
    Ordered

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val colIndex: Int

  11. def colKey: ColKey

    Extracts the column key component.

  12. def compare(that: CellKey): Int

    See section on ordering at class top level documentation.

    See section on ordering at class top level documentation.

    Definition Classes
    CellKey → Ordered

  13. def compareTo(that: CellKey): Int

    Definition Classes
    Ordered → Comparable

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def indices: IndicesTuple

    This is equivalent to CellKey.unapply(cellKey).get.

    This is equivalent to CellKey.unapply(cellKey).get.

    returns

    the (rowIndex, colIndex) tuple.

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. def nextCol: CellKey

    Method for advancing one column.

  21. def nextRow: CellKey

    Method for advancing one row.

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. val rowIndex: Int

  25. def rowKey: RowKey

    Extracts the row key component.

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  27. def toString(): String

    Example:

    Example: 

    scala> CellKey(26, 26)
cellKey: fi.pelam.csv.cell.CellKey = Row 26, Column AA (26)
    Definition Classes
    CellKey → AnyRef → Any

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. def withColOffset(offset: Int): CellKey

  32. def withRowOffset(offset: Int): CellKey

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ordered[CellKey]

Inherited from Comparable[CellKey]

Inherited from AnyRef

Inherited from Any

Ungrouped