View Javadoc

1   /*
2    *   Magic-Project is a turn based strategy simulator
3    *   Copyright (C) 2003-2007 Fabrice Daugan
4    *
5    *   This program is free software; you can redistribute it and/or modify it 
6    * under the terms of the GNU General Public License as published by the Free 
7    * Software Foundation; either version 2 of the License, or (at your option) any
8    * later version.
9    *
10   *   This program is distributed in the hope that it will be useful, but WITHOUT 
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
13   * details.
14   *
15   *   You should have received a copy of the GNU General Public License along  
16   * with this program; if not, write to the Free Software Foundation, Inc., 
17   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  package net.sf.magicproject.chart;
20  
21  import java.util.Collection;
22  import java.util.List;
23  
24  import net.sf.magicproject.clickable.targetable.card.CardModel;
25  
26  /***
27   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
28   * @since 0.93
29   */
30  public interface IDataProvider {
31  
32  	/***
33  	 * Return the keys corresponding to the given card.
34  	 * 
35  	 * @param cardModel
36  	 *          the requested key.
37  	 * @param filter
38  	 *          the filter to apply to retrieve the keys.
39  	 * @return the keys corresponding to the given card.
40  	 */
41  	Collection<IChartKey> getKeys(CardModel cardModel, ChartFilter filter);
42  
43  	/***
44  	 * Return working set keys
45  	 * 
46  	 * @param filter
47  	 *          the filter to apply to retrieve the valid keys.
48  	 * @return working set keys
49  	 */
50  	List<IChartKey> getKeys(ChartFilter filter);
51  }