gate.jape.Rule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of annie Show documentation
Show all versions of annie Show documentation
ANNIE is a general purpose information extraction system that
provides the building blocks of many other GATE applications.
/*
* Rule.java - transducer class
*
* Copyright (c) 1995-2012, The University of Sheffield. See the file
* COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
*
* This file is part of GATE (see http://gate.ac.uk/), and is free
* software, licenced under the GNU Library General Public License,
* Version 2, June 1991 (in the distribution as file licence.html,
* and also available at http://gate.ac.uk/gate/licence.html).
*
* Hamish Cunningham, 24/07/98
*
* $Id: Rule.java 17768 2014-04-03 14:37:54Z markagreenwood $
*/
package gate.jape;
import gate.AnnotationSet;
import gate.Document;
import gate.event.ProgressListener;
import gate.event.StatusListener;
import gate.util.GateClassLoader;
import gate.util.Out;
import gate.util.Strings;
import java.io.Serializable;
/**
* A CPSL rule. Has an LHS, RHS and a name, and a priority.
*/
public class Rule extends Transducer
implements JapeConstants, Serializable
{
private static final long serialVersionUID = 564304936210127542L;
/** Debug flag */
private static final boolean DEBUG = false;
/** Construction */
public Rule(
String name, int position, int priority,
LeftHandSide lhs, RightHandSide rhs
) {
this.name = name;
this.position = position;
this.priority = priority;
this.lhs = lhs;
this.rhs = rhs;
} // Construction
/** Copy constructor */
public Rule(Rule existingRule) {
this.name = existingRule.name;
this.position = existingRule.position;
this.priority = existingRule.priority;
this.lhs = existingRule.lhs;
this.rhs = new RightHandSide(existingRule.rhs);
}
/** The LHS or pattern of the rule. */
private LeftHandSide lhs;
/** The RHS or action of the rule. */
private RightHandSide rhs;
/** The priority of the rule. */
private int priority;
/** Get the rule priority. */
public int getPriority() { return priority; }
/** The rule's position in sequence (e.g. order in file). */
private int position;
/** Get the rule's position in sequence (e.g. order in file). */
public int getPosition() { return position; }
/** If we're pending (have matched), get the position we want to fire in,
* else -1.
*/
public int pending() {
return pendingPosition;
} // pending
/** If we matched but didn't fire yet, this is our pending position. */
private int pendingPosition = -1;
/** Flag for end of document during getNextMatch. */
private boolean weFinished = false;
/** Have we hit the end of the document without matching? */
public boolean finished() {
return weFinished;
} // finished
/** Finish: replace dynamic data structures with Java arrays; called
* after parsing. WARNING:
* bad choice of names: this is not related to the weFinished
* member or the finished method!
*/
@Override
public void finish(GateClassLoader classloader) {
lhs.finish();
rhs.finish(classloader);
} // finish
/** Apply the RHS of this rule (LHS must have been matched first). */
@Override
public void transduce(Document doc, AnnotationSet inputAS,
AnnotationSet outputAS) throws JapeException {
// the righthand side does the transduction, using bindings from lhs */
if(DEBUG) Out.println("applying rule " + name);
// rhs.transduce(doc);
/*Debug.pr(
this, "Rule.transduce: annotations after transduction: " +
doc.selectAnnotations("Name", new FeatureMap()).toString() +
Debug.getNl()
);*/
// clear the caches of matched annotations in the LHS
// reset();
//Debug.pr(this, "LHS after reset: " + lhs.toString());
} // transduce
/** For debugging. */
// public String getName() { return name; }
/** Clean up (delete action class files, for e.g.). */
@Override
public void cleanUp() {
RightHandSide.cleanUp();
} // cleanUp
/** Create a string representation of the object. */
@Override
public String toString() { return toString(""); }
/** Create a string representation of the object. */
@Override
public String toString(String pad) {
String newline = Strings.getNl();
String newPad = Strings.addPadding(pad, INDENT_PADDING);
StringBuffer buf = new StringBuffer(
pad + "Rule: name(" + name + "); position(" + position + "); priority(" +
priority + "); pendingPosition(" + pendingPosition + "); " +
"weFinished(" + weFinished + "); lhs(" + newline +
lhs.toString(newPad) + newline + pad + "); rhs(" + newline +
rhs.toString(newPad) + newline + pad + ");"
);
buf.append(newline + pad + ") Rule." + newline);
return buf.toString();
} // toString
//needed by FSM
public LeftHandSide getLHS(){
return lhs;
}
public RightHandSide getRHS(){
return rhs;
}
//StatusReporter VOID Implementation
@Override
public void addStatusListener(StatusListener listener){}
@Override
public void removeStatusListener(StatusListener listener){}
//ProcessProgressReporter VOID implementation
public void addProcessProgressListener(ProgressListener listener){}
public void removeProcessProgressListener(ProgressListener listener){}
//ProcessProgressReporter implementation ends here
} // class Rule
// $Log$
// Revision 1.17 2005/01/11 13:51:36 ian
// Updating copyrights to 1998-2005 in preparation for v3.0
//
// Revision 1.16 2004/07/21 17:10:08 akshay
// Changed copyright from 1998-2001 to 1998-2004
//
// Revision 1.15 2004/03/25 13:23:04 valyt
//
// Style: static access to static members
//
// Revision 1.14 2004/03/25 13:01:14 valyt
// Imports optimisation throughout the Java sources
// (to get rid of annoying warnings in Eclipse)
//
// Revision 1.13 2001/09/13 12:09:50 kalina
// Removed completely the use of jgl.objectspace.Array and such.
// Instead all sources now use the new Collections, typically ArrayList.
// I ran the tests and I ran some documents and compared with keys.
// JAPE seems to work well (that's where it all was). If there are problems
// maybe look at those new structures first.
//
// Revision 1.12 2001/03/06 20:11:14 valyt
//
// DOCUMENTATION for most of the GUI classes.
//
// Cleaned up some obsolete classes
//
// Revision 1.11 2001/02/20 12:25:49 valyt
//
// Fixed the Jpae priorities bug
//
// Revision 1.10 2001/01/21 20:51:31 valyt
// Added the DocumentEditor class and the necessary changes to the gate API
//
// Revision 1.9 2000/11/08 16:35:03 hamish
// formatting
//
// Revision 1.8 2000/10/26 10:45:31 oana
// Modified in the code style
//
// Revision 1.7 2000/10/16 16:44:34 oana
// Changed the comment of DEBUG variable
//
// Revision 1.6 2000/10/10 15:36:37 oana
// Changed System.out in Out and System.err in Err;
// Added the DEBUG variable seted on false;
// Added in the header the licence;
//
// Revision 1.5 2000/07/04 14:37:39 valyt
// Added some support for Jape-ing in a different annotations et than the default one;
// Changed the L&F for the JapeGUI to the System default
//
// Revision 1.4 2000/07/03 21:00:59 valyt
// Added StatusBar and ProgressBar support for tokenisation & Jape transduction
// (it looks great :) )
//
// Revision 1.3 2000/05/05 12:51:12 valyt
// Got rid of deprecation warnings
//
// Revision 1.2 2000/04/14 18:02:46 valyt
// Added some gate.fsm classes
// added some accessor function in old jape classes
//
// Revision 1.1 2000/02/23 13:46:11 hamish
// added
//
// Revision 1.1.1.1 1999/02/03 16:23:02 hamish
// added gate2
//
// Revision 1.16 1998/11/01 21:21:40 hamish
// use Java arrays in transduction where possible
//
// Revision 1.15 1998/10/30 14:06:46 hamish
// added getTransducer
//
// Revision 1.14 1998/10/29 12:16:13 hamish
// changed reset to not do lhs if weFinished - coz
// there should be no state cached if the last try failed
//
// Revision 1.13 1998/10/01 16:06:37 hamish
// new appelt transduction style, replacing buggy version
//
// Revision 1.12 1998/09/18 13:36:00 hamish
// made Transducer a class
//
// Revision 1.11 1998/08/19 20:21:43 hamish
// new RHS assignment expression stuff added
//
// Revision 1.10 1998/08/12 19:05:48 hamish
// fixed multi-part CG bug; set reset to real reset and fixed multi-doc bug
//
// Revision 1.9 1998/08/12 15:39:43 hamish
// added padding toString methods
//
// Revision 1.8 1998/08/10 14:16:39 hamish
// fixed consumeblock bug and added batch.java
//
// Revision 1.7 1998/08/03 21:44:58 hamish
// moved parser classes to gate.jape.parser
//
// Revision 1.6 1998/08/03 19:51:27 hamish
// rollback added
//
// Revision 1.5 1998/07/31 16:50:19 mks
// RHS compilation works; it runs - and falls over...
//
// Revision 1.4 1998/07/31 13:12:27 mks
// done RHS stuff, not tested
//
// Revision 1.3 1998/07/30 11:05:25 mks
// more jape
//
// Revision 1.2 1998/07/29 11:07:11 hamish
// first compiling version
//
// Revision 1.1.1.1 1998/07/28 16:37:46 hamish
// gate2 lives