edu.stanford.nlp.trees
Class MemoryTreebank

java.lang.Object
  java.util.AbstractCollection<Tree>
      edu.stanford.nlp.trees.Treebank
          edu.stanford.nlp.trees.MemoryTreebank

All Implemented Interfaces:

FileProcessor, Iterable<Tree>, Collection<Tree>, List<Tree>

public final class MemoryTreebank
extends Treebank
implements FileProcessor, List<Tree>

A MemoryTreebank object stores a corpus of examples with given tree structures in memory (as a List).

Author:

Christopher Manning

Constructor Summary

MemoryTreebank()
Create a new tree bank.

MemoryTreebank(int initialCapacity)
Create a new Treebank.

MemoryTreebank(int initialCapacity, TreeReaderFactory trf)
Create a new tree bank.

MemoryTreebank(String encoding)
Create a new tree bank, set the encoding for file access

MemoryTreebank(TreeReaderFactory trf)
Create a new tree bank.

MemoryTreebank(TreeReaderFactory trf, String encoding)
Create a new tree bank.

Method Summary

void	add(int index, Tree element)
boolean	add(Tree element)
boolean	addAll(int index, Collection<? extends Tree> c)
void	apply(TreeVisitor tp) Apply the TreeVisitor tp to all trees in the Treebank.
void	clear() Empty a Treebank.
Tree	get(int i) Get a tree by index from the Treebank.
int	indexOf(Object o)
Iterator	iterator() Return an Iterator over Trees in the Treebank.
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(int index)
void	loadPath(File path, FileFilter filt) Load trees from given directory.
static void	main(String[] args) Loads treebank grammar from first argument and prints it.
void	processFile(File file) Load a collection of parse trees from the file of given name.
Tree	remove(int index)
Tree	set(int index, Tree element)
int	size() Returns the size of the Treebank.
List	subList(int fromIndex, int toIndex)

Methods inherited from class edu.stanford.nlp.trees.Treebank

encoding, loadPath, loadPath, loadPath, loadPath, loadPath, remove, textualSummary, toString, transform, treeReaderFactory

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toArray, toArray

Constructor Detail

MemoryTreebank

public MemoryTreebank()

Create a new tree bank. 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.

MemoryTreebank

public MemoryTreebank(String encoding)

Create a new tree bank, set the encoding for file access

Parameters:

encoding - the encoding to use for file access.

MemoryTreebank

public MemoryTreebank(TreeReaderFactory trf)

Create a new tree bank.

Parameters:

trf - the factory class to be called to create a new TreeReader

MemoryTreebank

public MemoryTreebank(TreeReaderFactory trf,
                      String encoding)

Create a new tree bank.

Parameters:

trf - the factory class to be called to create a new TreeReader

encoding - the encoding to use for file access.

MemoryTreebank

public MemoryTreebank(int initialCapacity)

Create a new Treebank.

Parameters:

initialCapacity - The initial size of the underlying Collection, (if a Collection-based storage mechanism is being provided)

MemoryTreebank

public MemoryTreebank(int initialCapacity,
                      TreeReaderFactory trf)

Create a new tree bank.

Parameters:

initialCapacity - The initial size of the underlying Collection

trf - the factory class to be called to create a new TreeReader

Method Detail

clear

public void clear()

Empty a Treebank.

Specified by:

clear in interface Collection<Tree>

Specified by:

clear in interface List<Tree>

Specified by:

clear in class Treebank

loadPath

public void loadPath(File path,
                     FileFilter filt)

Load trees from given directory.

Specified by:

loadPath in class Treebank

Parameters:

path - file or directory to load from

filt - a FilenameFilter of files to load

processFile

public void processFile(File file)

Load a collection of parse trees from the file of given name. Each tree may optionally be encased in parens to allow for Penn Treebank style trees. This methods implements the FileProcessor interface.

Specified by:

processFile in interface FileProcessor

Parameters:

file - file to load a tree from

See Also:

for traversing directories

get

public Tree get(int i)

Get a tree by index from the Treebank. This operation isn't in the Treebank feature set, and so is only available with a MemoryTreebank, but is useful in allowing the latter to be used as an ArrayList.

Specified by:

get in interface List<Tree>

Parameters:

i - The integer (counting from 0) index of the tree

Returns:

A tree

apply

public void apply(TreeVisitor tp)

Apply the TreeVisitor tp to all trees in the Treebank.

Specified by:

apply in class Treebank

Parameters:

tp - A class that implements the TreeVisitor interface

iterator

public Iterator iterator()

Return an Iterator over Trees in the Treebank.

Specified by:

iterator in interface Iterable<Tree>

Specified by:

iterator in interface Collection<Tree>

Specified by:

iterator in interface List<Tree>

Specified by:

iterator in class AbstractCollection<Tree>

Returns:

The iterator

size

public int size()

Returns the size of the Treebank. Provides a more efficient implementation than the one for a generic Treebank

Specified by:

size in interface Collection<Tree>

Specified by:

size in interface List<Tree>

Overrides:

size in class Treebank

Returns:

the number of trees in the Treebank

add

public void add(int index,
                Tree element)

Specified by:

add in interface List<Tree>

add

public boolean add(Tree element)

Specified by:

add in interface Collection<Tree>

Specified by:

add in interface List<Tree>

Overrides:

add in class AbstractCollection<Tree>

addAll

public boolean addAll(int index,
                      Collection<? extends Tree> c)

Specified by:

addAll in interface List<Tree>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<Tree>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<Tree>

remove

public Tree remove(int index)

Specified by:

remove in interface List<Tree>

set

public Tree set(int index,
                Tree element)

Specified by:

set in interface List<Tree>

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List<Tree>

listIterator

public ListIterator listIterator(int index)

Specified by:

listIterator in interface List<Tree>

subList

public List subList(int fromIndex,
                    int toIndex)

Specified by:

subList in interface List<Tree>

main

public static void main(String[] args)

Loads treebank grammar from first argument and prints it. Just a demonstration of functionality.
usage: java MemoryTreebank treebankFilesPath

Parameters:

args - array of command-line arguments