← Back to branch summary

~ubuntu-branches/ubuntu/precise/weka/precise

« back to all changes in this revision

Viewing changes to weka/filters/Sourcable.java

  • Committer: Bazaar Package Importer
  • Author(s): Soeren Sonnenburg
  • Date: 2008-02-24 09:18:45 UTC
  • Revision ID: james.westby@ubuntu.com-20080224091845-1l8zy6fm6xipbzsr
Tags: upstream-3.5.7+tut1
Import upstream version 3.5.7+tut1

Show diffs side-by-side

added added

removed removed

Lines of Context:
weka/filters/Sourcable.java
 
1
/*
 
2
 *    This program is free software; you can redistribute it and/or modify
 
3
 *    it under the terms of the GNU General Public License as published by
 
4
 *    the Free Software Foundation; either version 2 of the License, or
 
5
 *    (at your option) any later version.
 
6
 *
 
7
 *    This program is distributed in the hope that it will be useful,
 
8
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
9
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
10
 *    GNU General Public License for more details.
 
11
 *
 
12
 *    You should have received a copy of the GNU General Public License
 
13
 *    along with this program; if not, write to the Free Software
 
14
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
15
 */
 
16
 
 
17
/*
 
18
 *    Sourcable.java
 
19
 *    Copyright (C) 2007 University of Waikato, Hamilton, New Zealand
 
20
 *
 
21
 */
 
22
 
 
23
package weka.filters;
 
24
 
 
25
import weka.core.Instances;
 
26
 
 
27
/** 
 
28
 * Interface for filters that can be converted to Java source.
 
29
 *
 
30
 * @author FracPete (fracpete at waikato dot ac dot nz)
 
31
 * @version $Revision: 1.1 $
 
32
 */
 
33
public interface Sourcable {
 
34
 
 
35
  /**
 
36
   * Returns a string that describes the filter as source. The
 
37
   * filter will be contained in a class with the given name (there may
 
38
   * be auxiliary classes),
 
39
   * and will contain two methods with these signatures:
 
40
   * <pre><code>
 
41
   * // converts one row
 
42
   * public static Object[] filter(Object[] i);
 
43
   * // converts a full dataset (first dimension is row index)
 
44
   * public static Object[][] filter(Object[][] i);
 
45
   * </code></pre>
 
46
   * where the array <code>i</code> contains elements that are either
 
47
   * Double, String, with missing values represented as null. The generated
 
48
   * code is public domain and comes with no warranty.
 
49
   *
 
50
   * @param className   the name that should be given to the source class.
 
51
   * @param data        the dataset used for initializing the filter
 
52
   * @return            the object source described by a string
 
53
   * @throws Exception  if the source can't be computed
 
54
   */
 
55
  public String toSource(String className, Instances data) throws Exception;
 
56
}