org.immutables.criteria.repository.Reader Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Immutables Authors and Contributors
 *
 * 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 org.immutables.criteria.repository;

import org.immutables.criteria.expression.Ordering;
import org.immutables.criteria.matcher.Projection;

/**
 * Allows chaining operations (like adding {@code offset} / {@code limit}) on some particular query.
 * Subclasses may add other attributes specific to their repository.
 *
 * @param  reader type (self type)
 */
public interface Reader {

  /**
   * Define ordering scheme
   * @param first
   * @param rest
   */
  R orderBy(Ordering first, Ordering ... rest);

  /**
   * Set max number of documents to return
   * @param limit number of documents
   */
  R limit(long limit);

  /**
   * Number of documents to skip
   * @param offset number of documents
   */
  R offset(long offset);

  /**
   * Define grouping attribute
   */
  R groupBy(Projection first, Projection ... rest);
}