org.hibernate.persister.entity.Joinable.java Source code

Introduction

Here is the source code for org.hibernate.persister.entity.Joinable.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.persister.entity;

import java.util.Map;
import java.util.Set;

import org.hibernate.MappingException;

/**
 * Anything that can be loaded by outer join - namely
 * persisters for classes or collections.
 *
 * @author Gavin King
 */
public interface Joinable {
    //should this interface extend PropertyMapping?

    /**
     * An identifying name; a class name or collection role name.
     */
    public String getName();

    /**
     * The table to join to.
     */
    public String getTableName();

    /**
     * All columns to select, when loading.
     */
    public String selectFragment(Joinable rhs, String rhsAlias, String lhsAlias, String currentEntitySuffix,
            String currentCollectionSuffix, boolean includeCollectionColumns);

    /**
     * Get the where clause part of any joins
     * (optional operation)
     */
    public String whereJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses);

    /**
     * Get the where clause part of any joins
     * (optional operation)
     */
    public String whereJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses,
            Set<String> treatAsDeclarations);

    /**
     * Get the from clause part of any joins
     * (optional operation)
     */
    public String fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses);

    /**
     * Get the from clause part of any joins
     * (optional operation)
     */
    public String fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses,
            Set<String> treatAsDeclarations);

    /**
     * Get the from clause part of any joins
     * (optional operation)
     */
    default String fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses,
            Set<String> treatAsDeclarations, Set<String> referencedTables) {
        return fromJoinFragment(alias, innerJoin, includeSubclasses, treatAsDeclarations);
    }

    /**
     * The columns to join on
     */
    public String[] getKeyColumnNames();

    /**
     * Get the where clause filter, given a query alias and considering enabled session filters
     */
    public String filterFragment(String alias, Map enabledFilters) throws MappingException;

    /**
     * Get the where clause filter, given a query alias and considering enabled session filters
     */
    public String filterFragment(String alias, Map enabledFilters, Set<String> treatAsDeclarations)
            throws MappingException;

    public String oneToManyFilterFragment(String alias) throws MappingException;

    public String oneToManyFilterFragment(String alias, Set<String> treatAsDeclarations);

    /**
     * Is this instance actually a CollectionPersister?
     */
    public boolean isCollection();

    /**
     * Very, very, very ugly...
     *
     * @return Does this persister "consume" entity column aliases in the result
     * set?
     */
    public boolean consumesEntityAlias();

    /**
     * Very, very, very ugly...
     *
     * @return Does this persister "consume" collection column aliases in the result
     * set?
     */
    public boolean consumesCollectionAlias();
}