01 /*
02 * YamPlugin.java
03 * Copyright (c) 1998-2008, The University of Sheffield.
04 *
05 * This code is from the GATE project (http://gate.ac.uk/) and is free
06 * software licenced under the GNU General Public License version 3. It is
07 * distributed without any warranty. For more details see COPYING.txt in the
08 * top level directory (or at http://gatewiki.sf.net/COPYING.txt).
09 *
10 * Hamish Cunningham, 24th August 2009
11 */
12
13 package gate.yam;
14
15 import java.util.*;
16 import gate.yam.translate.AbstractTranslator;
17
18 /**
19 * This interface must be implemented by all YAM plugins (which must be in the
20 * package <tt>gate.yam.plugins</tt>).
21 * @author Hamish Cunningham
22 */
23 public interface YamPlugin
24 {
25 /**
26 * Translate a set of plugin arguments.
27 * @param m a map of arguments from the YAM source
28 * @param t the translator that is converting the YAM document
29 * @param target the target output language
30 * @return the translation for insertion at the plugin call location
31 */
32 public String translate(Map m, AbstractTranslator t, String target);
33
34 } // YamPlugin
|