KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hibernate > persister > entity > OuterJoinLoadable


1 //$Id: OuterJoinLoadable.java,v 1.2 2005/05/16 05:44:46 oneovthafew Exp $
2
package org.hibernate.persister.entity;
3
4 import org.hibernate.FetchMode;
5 import org.hibernate.type.EntityType;
6 import org.hibernate.type.Type;
7
8 /**
9  * A <tt>EntityPersister</tt> that may be loaded by outer join using
10  * the <tt>OuterJoinLoader</tt> hierarchy and may be an element
11  * of a one-to-many association.
12  *
13  * @see org.hibernate.loader.OuterJoinLoader
14  * @author Gavin King
15  */

16 public interface OuterJoinLoadable extends Loadable, Joinable {
17
18     /**
19      * Generate a list of collection index, key and element columns
20      */

21     public String JavaDoc selectFragment(String JavaDoc alias, String JavaDoc suffix);
22     /**
23      * How many properties are there, for this class and all subclasses.
24      */

25     public int countSubclassProperties();
26
27     /**
28      * May this property be fetched using an SQL outerjoin.
29      */

30     public FetchMode getFetchMode(int i);
31
32     /**
33      * Is this property defined on a subclass of the mapped class.
34      */

35     public boolean isDefinedOnSubclass(int i);
36
37     /**
38      * Get the type of the numbered property of the class or a subclass.
39      */

40     public Type getSubclassPropertyType(int i);
41
42     /**
43      * Get the name of the numbered property of the class or a subclass.
44      */

45     public String JavaDoc getSubclassPropertyName(int i);
46     
47     /**
48      * Is the numbered property of the class of subclass nullable?
49      */

50     public boolean isSubclassPropertyNullable(int i);
51
52     /**
53      * Return the column names used to persist the numbered property of the
54      * class or a subclass.
55      */

56     public String JavaDoc[] getSubclassPropertyColumnNames(int i);
57
58     /**
59      * Return the table name used to persist the numbered property of the
60      * class or a subclass.
61      */

62     public String JavaDoc getSubclassPropertyTableName(int i);
63     /**
64      * Given the number of a property of a subclass, and a table alias,
65      * return the aliased column names.
66      */

67     public String JavaDoc[] toColumns(String JavaDoc name, int i);
68
69     /**
70      * Get the main from table fragment, given a query alias.
71      */

72     public String JavaDoc fromTableFragment(String JavaDoc alias);
73
74     /**
75      * Get the column names for the given property path
76      */

77     public String JavaDoc[] getPropertyColumnNames(String JavaDoc propertyPath);
78     /**
79      * Get the table name for the given property path
80      */

81     public String JavaDoc getPropertyTableName(String JavaDoc propertyName);
82     
83     public EntityType getEntityType();
84
85 }
86
Popular Tags