edu.stanford.nlp.trees.TransformingTreebank Maven / Gradle / Ivy
package edu.stanford.nlp.trees;
import edu.stanford.nlp.util.Timing;
import edu.stanford.nlp.ling.Label;
import java.io.File;
import java.io.FileFilter;
import java.io.Reader;
import java.util.Iterator;
import java.util.Arrays;
/** This class wraps another Treebank, and will vend trees that have been through
* a TreeTransformer. You can access them via requests like apply() or
* iterator().
*
* Important note: This class will only function properly if the TreeTransformer
* used is a function (which doesn't change its argument) rather than if it is a
* TreeMunger.
*
* @author Pi-Chuan Chang
* @author Christopher Manning
*/
public class TransformingTreebank extends Treebank {
private TreeTransformer transformer;
private Treebank tb;
private static final boolean VERBOSE = false;
/**
* Create a new TransformingTreebank.
* The trees are made with a LabeledScoredTreeReaderFactory.
*
* Compatibility note: Until Sep 2004, this used to create a Treebank
* with a SimpleTreeReaderFactory, but this was changed as the old
* default wasn't very useful, especially to naive users.
*/
public TransformingTreebank() {
this(new LabeledScoredTreeReaderFactory());
}
/**
* Create a new TransformingTreebank.
*
* @param trf the factory class to be called to create a new
* TreeReader
*/
public TransformingTreebank(TreeReaderFactory trf) {
super(trf);
}
/**
* Create a new TransformingTreebank from a base Treebank that will
* transform trees with the given TreeTransformer.
* This is the constructor that you should use.
*
* @param tb The base Treebank
* @param transformer The TreeTransformer applied to each Tree.
*/
public TransformingTreebank(Treebank tb, TreeTransformer transformer) {
this.tb = tb;
this.transformer = transformer;
}
/**
* Empty a Treebank.
*/
@Override
public void clear() {
tb.clear();
transformer = null;
}
// public String toString() {
// return "TransformingTreebank[transformer=" + transformer + "]\n" + super.toString();
// }
/**
* Load trees from given path specification. Not supported for this
* type of treebank.
*
* @param path file or directory to load from
* @param filt a FilenameFilter of files to load
*/
@Override
public void loadPath(File path, FileFilter filt) {
throw new UnsupportedOperationException();
}
/**
* Applies the TreeVisitor to to all trees in the Treebank.
*
* @param tv A class that can process trees.
*/
@Override
public void apply(TreeVisitor tv) {
for (Tree t : tb) {
if (VERBOSE) System.out.println("TfTbApply transforming " + t);
Tree tmpT = t.deepCopy();
if (transformer != null) {
tmpT = transformer.transformTree(tmpT);
}
if (VERBOSE) System.out.println(" to " + tmpT);
tv.visitTree(tmpT);
}
}
/**
*/
@Override
public Iterator iterator() {
return new TransformingTreebankIterator(tb.iterator(), transformer);
}
/**
* Loads treebank grammar from first argument and prints it.
* Just a demonstration of functionality.
* usage: java MemoryTreebank treebankFilesPath
*
* @param args array of command-line arguments
*/
public static void main(String[] args) {
Timing.startTime();
Treebank treebank = new DiskTreebank(in -> new PennTreeReader(in));
Treebank treebank2 = new MemoryTreebank(in -> new PennTreeReader(in));
treebank.loadPath(args[0]);
treebank2.loadPath(args[0]);
CompositeTreebank c = new CompositeTreebank(treebank, treebank2);
Timing.endTime();
TreeTransformer myTransformer = new MyTreeTransformer();
TreeTransformer myTransformer2 = new MyTreeTransformer2();
TreeTransformer myTransformer3 = new MyTreeTransformer3();
Treebank tf1 = c.transform(myTransformer).transform(myTransformer2).transform(myTransformer3);
Treebank tf2 = new TransformingTreebank(new TransformingTreebank(new TransformingTreebank(c, myTransformer), myTransformer2), myTransformer3);
TreeTransformer[] tta = { myTransformer, myTransformer2, myTransformer3 };
TreeTransformer tt3 = new CompositeTreeTransformer(Arrays.asList(tta));
Treebank tf3 = c.transform(tt3);
System.out.println("-------------------------");
System.out.println("COMPOSITE (DISK THEN MEMORY REPEATED VERSION OF) INPUT TREEBANK");
System.out.println(c);
System.out.println("-------------------------");
System.out.println("SLOWLY TRANSFORMED TREEBANK, USING TransformingTreebank() CONSTRUCTOR");
Treebank tx1 = new TransformingTreebank(c, myTransformer);
System.out.println(tx1);
System.out.println("-----");
Treebank tx2 = new TransformingTreebank(tx1, myTransformer2);
System.out.println(tx2);
System.out.println("-----");
Treebank tx3 = new TransformingTreebank(tx2, myTransformer3);
System.out.println(tx3);
System.out.println("-------------------------");
System.out.println("TRANSFORMED TREEBANK, USING Treebank.transform()");
System.out.println(tf1);
System.out.println("-------------------------");
System.out.println("PRINTING AGAIN TRANSFORMED TREEBANK, USING Treebank.transform()");
System.out.println(tf1);
System.out.println("-------------------------");
System.out.println("TRANSFORMED TREEBANK, USING TransformingTreebank() CONSTRUCTOR");
System.out.println(tf2);
System.out.println("-------------------------");
System.out.println("TRANSFORMED TREEBANK, USING CompositeTreeTransformer");
System.out.println(tf3);
System.out.println("-------------------------");
System.out.println("COMPOSITE (DISK THEN MEMORY REPEATED VERSION OF) INPUT TREEBANK");
System.out.println(c);
System.out.println("-------------------------");
} // end main
private static class TransformingTreebankIterator implements Iterator {
private Iterator iter;
private TreeTransformer transformer;
TransformingTreebankIterator (Iterator iter, TreeTransformer transformer) {
this.iter = iter;
this.transformer = transformer;
}
public boolean hasNext() {
return iter.hasNext();
}
public Tree next() {
// this line will throw NoSuchElement exception if empty base iterator....
Tree ret = iter.next();
if (VERBOSE) System.out.println("TfTbIterator transforming " + ret);
if (transformer != null) {
ret = transformer.transformTree(ret);
}
if (VERBOSE) System.out.println(" to " + ret);
return ret;
}
public void remove() {
throw new UnsupportedOperationException();
}
} // end static class TransformingTreebankIterator
private static class MyTreeTransformer implements TreeTransformer {
public Tree transformTree(Tree tree) {
Tree treeCopy = tree.deepCopy();
for (Tree subtree : treeCopy) {
if (subtree.depth() < 2) {
continue;
}
String categoryLabel = subtree.label().toString();
Label label = subtree.label();
label.setFromString(categoryLabel+"-t1");
}
return treeCopy;
}
}
private static class MyTreeTransformer2 implements TreeTransformer {
public Tree transformTree(Tree tree) {
Tree treeCopy = tree.deepCopy();
for (Tree subtree : treeCopy) {
if (subtree.depth() < 1) {
continue;
}
String categoryLabel = subtree.label().toString();
Label label = subtree.label();
label.setFromString(categoryLabel+"-t2");
}
return treeCopy;
}
}
private static class MyTreeTransformer3 implements TreeTransformer {
public Tree transformTree(Tree tree) {
Tree treeCopy = tree.deepCopy();
for (Tree subtree : treeCopy) {
if (subtree.depth() < 2) {
continue;
}
String categoryLabel = subtree.label().toString();
Label label = subtree.label();
label.setFromString(categoryLabel+"-t3");
}
return treeCopy;
}
}
}