Open Source Repository

Home /hibernate/hibernate-3.2.7.ga | Repository Home


org/hibernate/persister/entity/Joinable.java
//$Id: Joinable.java 6828 2005-05-19 07:28:59Z steveebersole $
package org.hibernate.persister.entity;

import org.hibernate.MappingException;

import java.util.Map;

/**
 * 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 from clause part of any joins
   * (optional operation)
   */
  public String fromJoinFragment(String alias, boolean innerJoin, boolean includeSubclasses);
  /**
   * 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 enabledFiltersthrows MappingException;

  public String oneToManyFilterFragment(String aliasthrows MappingException;
  /**
   * 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();
}