KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hibernate > hql > FilterTranslator


1 // $Id: FilterTranslator.java,v 1.4 2004/12/06 14:17:22 pgmjsd Exp $
2 package org.hibernate.hql;
3
4 import org.hibernate.MappingException;
5 import org.hibernate.QueryException;
6
7 import java.util.Map JavaDoc;
8
9
10 /**
11  * Specialized interface for filters.
12  *
13  * @author josh Mar 14, 2004 11:33:35 AM
14  */
15 public interface FilterTranslator extends QueryTranslator {
16     /**
17      * Compile a filter. This method may be called multiple
18      * times. Subsequent invocations are no-ops.
19      *
20      * @param collectionRole the role name of the collection used as the basis for the filter.
21      * @param replacements Defined query substitutions.
22      * @param shallow Does this represent a shallow (scalar or entity-id) select?
23      * @throws QueryException There was a problem parsing the query string.
24      * @throws MappingException There was a problem querying defined mappings.
25      */
26     void compile(String JavaDoc collectionRole, Map JavaDoc replacements, boolean shallow)
27             throws QueryException, MappingException;
28 }
29
Popular Tags