loadable.java

用Java实现的23个常用设计模式源代码

//$Id: Loadable.java,v 1.10.2.6 2003/10/30 07:32:06 oneovthafew Exp $
package net.sf.hibernate.persister;

import net.sf.hibernate.type.Type;

/**
 * Implemented by a <tt>ClassPersister</tt> that uses <tt>Loader</tt>. There are several optional
 * operations used only by loaders that inherit <tt>OuterJoinLoader</tt>.
 *
 * @see net.sf.hibernate.loader.Loader
 * @see net.sf.hibernate.loader.OuterJoinLoader
 * @author Gavin King
 */
public interface Loadable extends ClassPersister, Joinable {

	/**
	 * Does this persistent class have subclasses?
	 */
	public boolean hasSubclasses();

	/**
	 * Get the fully-qualified tablename used to persist this class
	 */
	public String getTableName();

	/**
	 * Get the names of columns used to persist the identifier
	 */
	public String[] getIdentifierColumnNames();

	/**
	 * Get the name of the column used as a discriminator
	 */
	public String getDiscriminatorColumnName();

	/**
	 * Get the discriminator type
	 */
	public Type getDiscriminatorType();

	/**
	 * Get the concrete subclass corresponding to the given discriminator
	 * value
	 */
	public Class getSubclassForDiscriminatorValue(Object value);

	/**
	 * Get the column names for the numbered property of <em>this</em> class
	 */
	public String[] getPropertyColumnNames(int i);

	//USED BY OuterJoinLoader + subclasses

	/**
	 * How many properties are there, for this class and all subclasses (optional operation).
	 */
	public int countSubclassProperties();

	/**
	 * May this property be fetched using an SQL outerjoin (optional operation).
	 */
	public int enableJoinedFetch(int i);

	/**
	 * Is this property defined on a subclass of the mapped class.
	 */
	public boolean isDefinedOnSubclass(int i);

	/**
	 * Get the type of the numbered property of the class or a subclass (optional operation).
	 */
	public Type getSubclassPropertyType(int i);

	/**
	 * Get the name of the numbered property of the class or a subclass (optional operation).
	 */
	public String getSubclassPropertyName(int i);

	/**
	 * Return the column names used to persist the numbered property of the class or a subclass (optional operation).
	 */
	public String[] getSubclassPropertyColumnNames(int i);

	/**
	 * Return the table name used to persist the numbered property of the class or a subclass (optional operation).
	 */
	public String getSubclassPropertyTableName(int i);
	/**
	 * Given the number of a property of a subclass, and a table alias, return the aliased column names (optional operation).
	 */
	public String[] toColumns(String name, int i);

	/**
	 * Given a query alias and an identifying suffix, render the intentifier select fragment.
	 */
	public String identifierSelectFragment(String name, String suffix);
	/**
	 * Given a query alias and an identifying suffix, render the property select fragment (optional operation).
	 */
	public String propertySelectFragment(String alias, String suffix);
	/**
	 * Get the main from table fragment, given a query alias (optional operation).
	 */
	public String fromTableFragment(String alias);

	/**
	 * Return the column alias names used to persist/query the numbered property of the class or a subclass (optional operation).
	 */
	public String[] getSubclassPropertyColumnAliases(String propertyName, String suffix);

	/**
	 * Get the result set aliases used for the identifier columns, given a suffix
	 */
	public String[] getIdentifierAliases(String suffix);
	/**
	 * Get the result set aliases used for the property columns, given a suffix (properties of this class, only).
	 */
	public String[] getPropertyAliases(String suffix, int i);
	/**
	 * Get the result set aliases used for the identifier columns, given a suffix
	 */
	public String getDiscriminatorAlias(String suffix);
}