JDBCQueryMetaData


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.ejb.plugins.cmp.jdbc.metadata;
23  
24  import java.lang.reflect.Method  ;
25  
26  /**
27   * This interface is used to identify a query that will be invoked in
28   * responce to the invocation of a finder method in a home interface or
29   * an ejbSelect method in a bean implementation class.
30   *
31   * @author <a HREF="mailto:dain@daingroup.com">Dain Sundstrom</a>
32   * @author <a HREF="sebastien.alborini@m4x.org">Sebastien Alborini</a>
33   * @author <a HREF="danch@nvisia.com">danch</a>
34   * @author <a HREF="on@ibis.odessa.ua">Oleg Nitz</a>
35   * @version $Revision: 37459 $
36   */
37  public interface JDBCQueryMetaData {
38     /**
39      * Gets the method which invokes this query.
40      * @return the Method object which invokes this query
41      */
42     public Method   getMethod();
43  
44     /**
45      * Is the result set of ejbSelect is mapped to local ejb objects or 
46      * remote ejb objects.
47      * @return true, if the result set is to be local objects
48      */
49     public boolean isResultTypeMappingLocal();
50  
51     /**
52      * Gets the read ahead metadata for the query.
53      * @return the read ahead metadata for the query.
54      */
55     public JDBCReadAheadMetaData getReadAhead();
56  
57     /**
58      * @return EJBQL compiler implementation
59      */
60     public Class   getQLCompilerClass();
61  
62     public boolean isLazyResultSetLoading();
63  }
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags