KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hibernate > loader > CollectionAliases


1 // $Id: CollectionAliases.java,v 1.1 2005/05/19 07:28:58 steveebersole Exp $
2
package org.hibernate.loader;
3
4 /**
5  * Type definition of CollectionAliases.
6  *
7  * @author Steve Ebersole
8  */

9 public interface CollectionAliases {
10     /**
11      * Returns the suffixed result-set column-aliases for columns making
12      * up the key for this collection (i.e., its FK to its owner).
13      *
14      * @return The key result-set column aliases.
15      */

16     public String JavaDoc[] getSuffixedKeyAliases();
17
18     /**
19      * Returns the suffixed result-set column-aliases for the collumns
20      * making up the collection's index (map or list).
21      *
22      * @return The index result-set column aliases.
23      */

24     public String JavaDoc[] getSuffixedIndexAliases();
25
26     /**
27      * Returns the suffixed result-set column-aliases for the columns
28      * making up the collection's elements.
29      *
30      * @return The element result-set column aliases.
31      */

32     public String JavaDoc[] getSuffixedElementAliases();
33
34     /**
35      * Returns the suffixed result-set column-aliases for the column
36      * defining the collection's identifier (if any).
37      *
38      * @return The identifier result-set column aliases.
39      */

40     public String JavaDoc getSuffixedIdentifierAlias();
41
42     /**
43      * Returns the suffix used to unique the column aliases for this
44      * particular alias set.
45      *
46      * @return The uniqued column alias suffix.
47      */

48     public String JavaDoc getSuffix();
49 }
50
Popular Tags