org.ibatis.persist.criteria.Selection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbatis Show documentation

The jBATIS persistence framework will help you to significantly reduce the amount of Java code that you normally need to access a relational database. iBATIS simply maps JavaBeans to SQL statements using a very simple XML descriptor.

The newest version!

package org.ibatis.persist.criteria;

import java.util.List;

/**
 * The Selection interface defines an item that is to be returned in a query result.
 *
 * @param 
 *            the type of the selection item
 *
 * @since iBatis Persistence 1.0
 */
public interface Selection {

    /**
     * Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned. Returns the same
     * selection item.
     * 
     * @param name
     *            alias
     * @return selection item
     */
    Selection alias(String name);

    /**
     * Whether the selection item is a compound selection.
     * @return boolean indicating whether the selection is a compound
     *         selection
     */
    boolean isCompoundSelection();

    /**
     * Return the selection items composing a compound selection.
     * Modifications to the list do not affect the query.
     * @return list of selection items
     * @throws IllegalStateException if selection is not a 
     *         compound selection
     */
    List> getCompoundSelectionItems();

    /**
     * Return the Java type of the tuple element.
     * 
     * @return the Java type of the tuple element
     */
    Class getJavaType();

    /**
     * Return the alias assigned to the tuple element or null, if no alias has been assigned.
     * 
     * @return alias
     */
    String getAlias();
}