edu.umass.cs.mallet.base.pipe.iterator

Class FileIterator

java.lang.Object

edu.umass.cs.mallet.base.pipe.iterator.AbstractPipeInputIterator

edu.umass.cs.mallet.base.pipe.iterator.FileIterator

All Implemented Interfaces:

PipeInputIterator, Iterator

Direct Known Subclasses:

FileUriIterator

public class FileIterator
extends AbstractPipeInputIterator

An iterator that generates instances from an initial directory or set of directories. Each filename becomes the data field of an instance, and the result of a user-specified regular expression pattern applied to the filename becomes the target value of the instance.

In document classification it is common that the file name in the data field will be subsequently processed by one or more pipes until it contains a feature vector. The pattern applied to the file name is often used to extract a directory name that will be used as the true label of the instance; this label is kept in the target field.

Author:

Andrew McCallum mccallum@cs.umass.edu

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	ALL_DIRECTORIES Use as label names all the directory names in the filename.
static Pattern	FIRST_DIRECTORY Use as label names the first directory in the filename.
static Pattern	LAST_DIRECTORY Use as label name the last directory in the filename.
static Pattern	STARTING_DIRECTORIES Use as label names the directories specified in the constructor, optionally removing common prefix of all starting directories

Fields inherited from class edu.umass.cs.mallet.base.pipe.iterator.AbstractPipeInputIterator

parentInstance

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileIterator(File directory)
	FileIterator(File[] directories, FileFilter fileFilter, Pattern targetPattern)
protected	FileIterator(File[] directories, FileFilter fileFilter, Pattern targetPattern, boolean removeCommonPrefix) Construct a FileIterator that will supply filenames within initial directories as instances
	FileIterator(File[] directories, Pattern targetPattern) Iterate over Files that pass the fileFilter test, setting...
	FileIterator(File[] directories, Pattern targetPattern, boolean removeCommonPrefix)
	FileIterator(File directory, FileFilter fileFilter)
	FileIterator(File directory, FileFilter fileFilter, Pattern targetPattern)
	FileIterator(File directory, FileFilter fileFilter, Pattern targetPattern, boolean removeCommonPrefix)
	FileIterator(File directory, Pattern targetPattern)
	FileIterator(File directory, Pattern targetPattern, boolean removeCommonPrefix)
	FileIterator(String directory)
	FileIterator(String[] directories, FileFilter ff)
	FileIterator(String[] directories, Pattern targetPattern)
	FileIterator(String[] directories, Pattern targetPattern, boolean removeCommonPrefix)
	FileIterator(String[] directories, String targetPattern)
	FileIterator(String directory, FileFilter filter)
	FileIterator(String directory, Pattern targetPattern)
	FileIterator(String directory, Pattern targetPattern, boolean removeCommonPrefix)

Method Summary

Modifier and Type	Method and Description
ArrayList	getFileArray()
boolean	hasNext()
File	nextFile()
Instance	nextInstance()
static File[]	stringArray2FileArray(String[] sa)

Methods inherited from class edu.umass.cs.mallet.base.pipe.iterator.AbstractPipeInputIterator

next, remove, setParentInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

STARTING_DIRECTORIES

public static final Pattern STARTING_DIRECTORIES

Use as label names the directories specified in the constructor, optionally removing common prefix of all starting directories

FIRST_DIRECTORY

public static final Pattern FIRST_DIRECTORY

Use as label names the first directory in the filename.

LAST_DIRECTORY

public static final Pattern LAST_DIRECTORY

Use as label name the last directory in the filename.

ALL_DIRECTORIES

public static final Pattern ALL_DIRECTORIES

Use as label names all the directory names in the filename.

Constructor Detail

FileIterator

protected FileIterator(File[] directories,
                       FileFilter fileFilter,
                       Pattern targetPattern,
                       boolean removeCommonPrefix)

Construct a FileIterator that will supply filenames within initial directories as instances

Parameters:

directories - Array of directories to collect files from

fileFilter - class implementing interface FileFilter that will decide which names to accept. May be null.

targetPattern - regex Pattern applied to the filename whose first parenthesized group on matching is taken to be the target value of the generated instance. The pattern is applied to the directory with the matcher.find() method. If null, then all instances will have target null.

removeCommonPrefix - boolean that modifies the behavior of the STARTING_DIRECTORIES pattern, removing the common prefix of all initially specified directories, leaving the remainder of each filename as the target value.

FileIterator

public FileIterator(File[] directories,
                    FileFilter fileFilter,
                    Pattern targetPattern)

FileIterator

public FileIterator(File[] directories,
                    Pattern targetPattern)

Iterate over Files that pass the fileFilter test, setting...

FileIterator

public FileIterator(File[] directories,
                    Pattern targetPattern,
                    boolean removeCommonPrefix)

FileIterator

public FileIterator(String[] directories,
                    FileFilter ff)

FileIterator

public FileIterator(String[] directories,
                    String targetPattern)

FileIterator

public FileIterator(String[] directories,
                    Pattern targetPattern)

FileIterator

public FileIterator(String[] directories,
                    Pattern targetPattern,
                    boolean removeCommonPrefix)

FileIterator

public FileIterator(File directory,
                    FileFilter fileFilter,
                    Pattern targetPattern)

FileIterator

public FileIterator(File directory,
                    FileFilter fileFilter,
                    Pattern targetPattern,
                    boolean removeCommonPrefix)

FileIterator

public FileIterator(File directory,
                    FileFilter fileFilter)

FileIterator

public FileIterator(File directory,
                    Pattern targetPattern)

FileIterator

public FileIterator(File directory,
                    Pattern targetPattern,
                    boolean removeCommonPrefix)

FileIterator

public FileIterator(String directory,
                    Pattern targetPattern)

FileIterator

public FileIterator(String directory,
                    Pattern targetPattern,
                    boolean removeCommonPrefix)

FileIterator

public FileIterator(File directory)

FileIterator

public FileIterator(String directory)

FileIterator

public FileIterator(String directory,
                    FileFilter filter)

Method Detail

getFileArray

public ArrayList getFileArray()

stringArray2FileArray

public static File[] stringArray2FileArray(String[] sa)

nextInstance

public Instance nextInstance()

Specified by:

nextInstance in interface PipeInputIterator

Specified by:

nextInstance in class AbstractPipeInputIterator

nextFile

public File nextFile()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator

Specified by:

hasNext in class AbstractPipeInputIterator