fi.pelam.csv.cell.AxisKey.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pelam-scala-csv_2.12 Show documentation

Scala library for reading and writing CSV data with an optional high level API. Supports structured access to tabular data and a form of CSV format detection.

The newest version!

/*
 * This file is part of pelam-scala-csv
 *
 * Copyright © Peter Lamberg 2015 ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package fi.pelam.csv.cell

/**
 * Base type for [[fi.pelam.csv.cell.RowKey RowKey]] and [[fi.pelam.csv.cell.ColKey ColKey]].
 * Provides index and ordering.
 *
 * Ordering is simply the natural order of the index values.
 */
trait AxisKey[T <: AxisKey[_]] extends Ordered[T] {
  val index: Int

  override def compare(that: T): Int = this.index - that.index

  def inRange(count: Int): Boolean = index >= 0 && index < count

  /**
   * To construct a cell or row key with given index.
   */
  def updated(index: Int): T

  /**
   * To construct a cell or row key with given offset added to index.
   */
  def withOffset(offset: Int): T
}