com.pagerduty.widerow.WideRowSet.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of widerow_2.11 Show documentation
widerow
The newest version!
/*
 * Copyright (c) 2015, PagerDuty
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.pagerduty.widerow

import com.pagerduty.widerow.chain.{Source, Chainable}


/**
 * Wide row index with column names and no column values.
 * Extend this class to tap into the WideRow API.
 *
 * See [[Chainable]] for more details.
 *
 * @param pageSize Query results are internally fetched in blocks of this size. A good value is
 *                 on the order of 100, but the best size is likely approximately equal to the
 *                 expected number of results to the query.
 */
class WideRowSet[RowKey, ColName](
    driver: WideRowDriver[RowKey, ColName, Array[Byte]],
    pageSize: Int)
  extends WideRowView[RowKey, ColName, Array[Byte], ColName](
      driver, Source[RowKey, ColName, Array[Byte]](driver.executor).map(_.column.name), pageSize)
  with WideRowUpdatable[RowKey, ColName, Array[Byte]]
{
  protected def emptyColValue = WideRowSet.EmptyColValue

  /**
   * Allows to manipulate index using pretty syntax.
   */
  class BatchUpdater(rowKey: RowKey) extends super.BatchUpdater(rowKey) {

    /**
     * Queues a single column to be inserted into the index.
     */
    def queueInsert(colName: ColName) :this.type = {
      queueInsert(EntryColumn(colName, emptyColValue))
    }
  }
  override def apply(rowKey: RowKey) = new BatchUpdater(rowKey)
}


object WideRowSet {
  final val EmptyColValue = Array.empty[Byte]
}