edu.jhu.ece.iacl.jist.pipeline.src
Class PipeFileDirectorySource

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipeModule
      edu.jhu.ece.iacl.jist.pipeline.PipeSource
          edu.jhu.ece.iacl.jist.pipeline.src.PipeFileDirectorySource

All Implemented Interfaces:

PipePort.PortListener, ParamViewObserver

Direct Known Subclasses:

PipeSurfaceDirectorySurface, PipeVolumeDirectorySource

public class PipeFileDirectorySource
extends PipeSource

Iterate through all files in specified directory.

Author:

Blake Lucas

Nested Class Summary

Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule

PipeModule.PipeListener

Field Summary

protected ParamFile	dirParam The dir param.
protected ParamString	fileExtension The file extension.
protected java.util.Vector<java.io.File>	fileList The images.
protected ParamFile	fileParam The file parameter
protected ParamString	filterExpression The filter expression.
protected ParamOption	filterRule The filter rule.
protected ParamBoolean	includeParam The include param.
protected int	index The index.
protected ParamInteger	searchDepth The search depth.

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeSource

childPort, isReset, parentPort

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule

bounds, cell, currentContext, inputHash, inputParams, inputPorts, label, listeners, name, outputHash, outputParams, outputPorts

Constructor Summary

PipeFileDirectorySource()
Default constructor.

Method Summary

ParamCollection	createInputParams() Create input parameters.
ParamCollection	createOutputParams() Create output parameters.
protected void	findMatchingFiles()
ParamFile	getOutputParam() Get file parameter.
boolean	hasNext() Returns true if iterator has more elements.
boolean	iterate() Iterate through files.
void	reset() Reset iterator.

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeSource

createModuleCell, disconnect, getChildPort, getParentPort, getRoot, init, isRoot

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule

addListener, connectAction, disconnectAction, forward, getAncestors, getAncestors, getBounds, getChildren, getCurrentContext, getDescendants, getDescendants, getInputHash, getInputParams, getInputPorts, getLabel, getListeners, getModuleCell, getName, getOutputHash, getOutputParams, getOutputPorts, getParents, isAncestorOf, isDescendantOf, push, removeAllListeners, removeListener, setBounds, setCurrentContext, setLabel, setModuleCell, setName, update

Methods inherited from class java.lang.Object

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

Field Detail

dirParam

protected ParamFile dirParam

The dir param.

includeParam

protected ParamBoolean includeParam

The include param.

filterRule

protected ParamOption filterRule

The filter rule.

filterExpression

protected ParamString filterExpression

The filter expression.

fileExtension

protected ParamString fileExtension

The file extension.

searchDepth

protected ParamInteger searchDepth

The search depth.

fileParam

protected ParamFile fileParam

The file parameter

fileList

protected transient java.util.Vector<java.io.File> fileList

The images.

index

protected transient int index

The index.

Constructor Detail

PipeFileDirectorySource

public PipeFileDirectorySource()

Default constructor.

Method Detail

createInputParams

public ParamCollection createInputParams()

Create input parameters.

Specified by:

createInputParams in class PipeSource

Returns:

the param collection

createOutputParams

public ParamCollection createOutputParams()

Create output parameters.

Specified by:

createOutputParams in class PipeSource

Returns:

the parameter collection

getOutputParam

public ParamFile getOutputParam()

Get file parameter.

Specified by:

getOutputParam in class PipeSource

Returns:

the output param

hasNext

public boolean hasNext()

Returns true if iterator has more elements.

Overrides:

hasNext in class PipeSource

Returns:

true, if checks for next

iterate

public boolean iterate()

Iterate through files.

Overrides:

iterate in class PipeSource

Returns:

true, if iterate

findMatchingFiles

protected void findMatchingFiles()

reset

public void reset()

Reset iterator.

Overrides:

reset in class PipeSource