com.querydsl.sql.Union Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of querydsl-sql Show documentation

SQL support for Querydsl

There is a newer version: 6.10.1

/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * 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 com.querydsl.sql;

import com.mysema.commons.lang.CloseableIterator;
import com.querydsl.core.Fetchable;
import com.querydsl.core.types.Expression;
import com.querydsl.core.types.OrderSpecifier;
import com.querydsl.core.types.Path;
import com.querydsl.core.types.Predicate;
import com.querydsl.core.types.SubQueryExpression;
import java.util.List;

/**
 * {@code Union} defines an interface for Union queries
 *
 * @author tiwe
 * @param  return type of projection
 */
public interface Union extends SubQueryExpression, Fetchable {

  /**
   * Get the projection as a typed List
   *
   * @deprecated Use {@link Union#fetch()}
   */
  @Deprecated
  List list();

  /**
   * Get the projection as a typed Iterator
   *
   * @return result iterator
   */
  @Override
  CloseableIterator iterate();

  /**
   * Defines the grouping/aggregation expressions
   *
   * @param o group by
   * @return the current object
   */
  Union groupBy(Expression... o);

  /**
   * Defines the filters for aggregation
   *
   * @param o having conditions
   * @return the current object
   */
  Union having(Predicate... o);

  /**
   * Define the ordering of the query results
   *
   * @param o order
   * @return the current object
   */
  Union orderBy(OrderSpecifier... o);

  /**
   * Create an alias for the expression
   *
   * @param alias alias
   * @return this as alias
   */
  Expression as(String alias);

  /**
   * Create an alias for the expression
   *
   * @param alias alias
   * @return this as alias
   */
  Expression as(Path alias);
}