javax.persistence.Tuple Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ow2-jpa-2.0-spec Show documentation
JPA API of Java EE 6.0
The newest version!
/*
 * Copyright 2010 Bull S.A.S.
 *
 * 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 javax.persistence;

import java.util.List;

/**
 * Interface for extracting the elements of a query result tuple.
 * @see JPA 2.0 specification
 * @author Florent Benoit
 * @since JPA 2.0 version.
 */
public interface Tuple {
    /**
     * Get the value of the specified tuple element.
     * @param tupleElement tuple element
     * @return value of tuple element
     * @throws IllegalArgumentException if tuple element does not correspond to an element in the query result tuple
     */
     X get(TupleElement tupleElement);

    /**
     * Get the value of the tuple element to which the specified alias has been assigned.
     * @param alias alias assigned to tuple element
     * @param type of the tuple element
     * @return value of the tuple element
     * @throws IllegalArgumentException if alias does not correspond to an element in the query result tuple or element cannot be
     * assigned to the specified type
     */
     X get(String alias, Class type);

    /**
     * Get the value of the tuple element to which the specified alias has been assigned.
     * @param alias alias assigned to tuple element
     * @return value of the tuple element
     * @throws IllegalArgumentException if alias does not correspond to an element in the query result tuple
     */
    Object get(String alias);

    /**
     * Get the value of the element at the specified position in the result tuple. The first position is 0.
     * @param i position in result tuple
     * @param type type of the tuple element
     * @return value of the tuple element
     * @throws IllegalArgumentException if i exceeds length of result tuple or element cannot be assigned to the specified type
     */
     X get(int i, Class type);

    /**
     * Get the value of the element at the specified position in the result tuple. The first position is 0.
     * @param i position in result tuple
     * @return value of the tuple element
     * @throws IllegalArgumentException if i exceeds length of result tuple
     */
    Object get(int i);

    /**
     * Return the values of the result tuple elements as an array.
     * @return tuple element values
     */
    Object[] toArray();

    /**
     * Return the tuple elements.
     * @return tuple elements
     */
    List> getElements();
}