01: /*
02: * This program is free software; you can redistribute it and/or modify
03: * it under the terms of the GNU General Public License as published by
04: * the Free Software Foundation; either version 2 of the License, or
05: * (at your option) any later version.
06: *
07: * This program is distributed in the hope that it will be useful,
08: * but WITHOUT ANY WARRANTY; without even the implied warranty of
09: * 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) 1999 University of Waikato, Hamilton, New Zealand
20: *
21: */
22:
23: package weka.classifiers;
24:
25: /**
26: * Interface for classifiers that can be converted to Java source.
27: *
28: * @author Len Trigg (trigg@cs.waikato.ac.nz)
29: * @version $Revision: 1.5 $
30: */
31: public interface Sourcable {
32:
33: /**
34: * Returns a string that describes the classifier as source. The
35: * classifier will be contained in a class with the given name (there may
36: * be auxiliary classes),
37: * and will contain a method with the signature:
38: * <pre><code>
39: * public static double classify(Object [] i);
40: * </code></pre>
41: * where the array <code>i</code> contains elements that are either
42: * Double, String, with missing values represented as null. The generated
43: * code is public domain and comes with no warranty.
44: *
45: * @param className the name that should be given to the source class.
46: * @return the object source described by a string
47: * @exception Exception if the souce can't be computed
48: */
49: String toSource(String className) throws Exception;
50: }
|