1 //----------------------------------------------------------------------
2 //
3 // PerfectJPattern: "Design patterns are good but components are better!"
4 // IFinderNamingStrategy.java Copyright (c) 2009 Giovanni Azua Garcia
5 // bravegag@hotmail.com
6 //
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License
9 // as published by the Free Software Foundation; either version 3
10 // of the License, or (at your option) any later version.
11 //
12 // This program 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
15 // GNU General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, see <http://www.gnu.org/licenses/>.
19 //
20 //----------------------------------------------------------------------
21 package org.perfectjpattern.jee.api.integration.dao;
22
23 import java.lang.reflect.Method;
24
25 import org.perfectjpattern.core.api.behavioral.strategy.IStrategy;
26
27
28 /**
29 * Abstract definition of a Strategy for discovering query names based
30 * on a data model type and a finder interface method
31 *
32 * @author <a href="mailto:bravegag@hotmail.com">Giovanni Azua</a>
33 * @version $ $Date: Nov 5, 2008 11:55:29 AM $
34 */
35 public
36 interface IFinderNamingStrategy
37 extends IStrategy
38 {
39 //------------------------------------------------------------------------
40 // public
41 //------------------------------------------------------------------------
42 /**
43 * Returns the query name based on the given finder method. Defines
44 * a discovery mechanism to connect queries declared in mapping
45 * files to a data model type class
46 *
47 * @param aClass Data model class type
48 * @param aMethod Method to derive the query name from
49 *
50 * @return Query name based on the given method
51 * @throws IllegalArgumentException 'aClass' must no be null
52 * @throws IllegalArgumentException 'aMethod' must no be null
53 */
54 public String
55 getQueryName(Class<?> aClass, Method aMethod)
56 throws IllegalArgumentException;
57 }