edu.jhu.ece.iacl.jist.pipeline.parameter
Class ParamSurfaceCollection

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<java.util.List>
          edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFileCollection
              edu.jhu.ece.iacl.jist.pipeline.parameter.ParamSurfaceLocationCollection
                  edu.jhu.ece.iacl.jist.pipeline.parameter.ParamSurfaceCollection

All Implemented Interfaces:

ObjectCollection<java.io.File>, java.lang.Cloneable, java.lang.Comparable<ParamModel>

public class ParamSurfaceCollection
extends ParamSurfaceLocationCollection

Surface collection stores a collection of files. The restrictions on the files are set to be the same as the collection.

Author:

Blake Lucas

Nested Class Summary

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

PipePort.PortListener, PipePort.type

Field Summary

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFileCollection

extensionFilter, fileParams, mandatory, readerWriter

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel

cliTag, description, factory, hidden, label, loadAndSaveOnValidate, shortLabel

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

connectible, gport, incomingConnectors, listeners, maxIncoming, maxOutgoing, outgoingConnectors, owner, portType, useWire

Constructor Summary

ParamSurfaceCollection()
Default constructor.

ParamSurfaceCollection(java.lang.String name)
Constructor.

Method Summary

ParamSurface	add(java.lang.Object value) Add a new value to the collection.
void	clear() Remove all files from collection.
ParamSurfaceCollection	clone() Clone object.
int	compareTo(ParamModel model) Compare restriction of one volume collection to another.
protected ParamSurface	create(java.lang.Object value) Create a new ParamSurface with the same restrictions as the collection and the specified value.
java.util.List<EmbeddedSurface>	getSurfaceList() Get surfaces.
boolean	isCompatible(PipePort model) Returns true if port is compatible with this parameter's extension filter.
void	setValue(java.util.List value) Set the volume collection.
int	size() Returns size of collection.

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFileCollection

add, clean, getExtensionFilter, getHumanReadableDataType, getParameters, getReaderWriter, getValue, getValue, getXMLValue, init, isMandatory, probeDefaultValue, replacePath, set, set, setCollection, setExtensionFilter, setMandatory, setReaderWriter, setXMLValue, toString, validate

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel

createMipavParameter, createTreeNode, dispose, equals, getCliTag, getDescription, getFactory, getInputView, getLabel, getName, getOutputView, getShortLabel, getView, hide, importMipavParameter, importParameter, isConnectible, isHidden, loadResources, loadResources, read, read, saveResources, setCliTag, setDescription, setFactory, setHidden, setInputView, setLabel, setLoadAndSaveOnValidate, setName, setOutputView, setShortLabel, toXML, write, write, writeAndFreeNow

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

addListener, disconnect, disconnect, disconnect, disconnect, getGraphPort, getIncomingConnector, getIncomingConnectors, getIncomingPorts, getListeners, getMaxIncoming, getMaxOutgoing, getOutgoingConnector, getOutgoingConnectors, getOutgoingPorts, getOwner, getPortType, isConnected, isConnectedTo, isInputPort, isOutputPort, notifyListenersOfConnection, notifyListenersOfDisconnection, removeAllListeners, removeListener, setConnectable, setGraphPort, setMaxIncoming, setMaxOutgoing, setOwner, setPortType, setUseConnector, usingConnector

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamSurfaceCollection

public ParamSurfaceCollection()

Default constructor.

ParamSurfaceCollection

public ParamSurfaceCollection(java.lang.String name)

Constructor.

Parameters:

name - parameter name

Method Detail

add

public ParamSurface add(java.lang.Object value)

Add a new value to the collection.

Overrides:

add in class ParamFileCollection

Parameters:

value - the value

Returns:

surface parameter

clear

public void clear()

Remove all files from collection.

Specified by:

clear in interface ObjectCollection<java.io.File>

Overrides:

clear in class ParamFileCollection

clone

public ParamSurfaceCollection clone()

Clone object.

Overrides:

clone in class ParamFileCollection

Returns:

the param surface collection

compareTo

public int compareTo(ParamModel model)

Compare restriction of one volume collection to another.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamFileCollection

Parameters:

model - the model

Returns:

the int

create

protected ParamSurface create(java.lang.Object value)

Create a new ParamSurface with the same restrictions as the collection and the specified value.

Overrides:

create in class ParamFileCollection

Parameters:

value - the value

Returns:

surface parameter

getSurfaceList

public java.util.List<EmbeddedSurface> getSurfaceList()

Get surfaces.

Returns:

list of surface

isCompatible

public boolean isCompatible(PipePort model)

Description copied from class: ParamFileCollection

Returns true if port is compatible with this parameter's extension filter.

Overrides:

isCompatible in class ParamFileCollection

Parameters:

model - the model

Returns:

true, if checks if is compatible

setValue

public void setValue(java.util.List value)

Set the volume collection. This method accepts ArrayLists with any of the valid types of ParamFile

Overrides:

setValue in class ParamFileCollection

Parameters:

value - parameter value

size

public int size()

Description copied from interface: ObjectCollection

Returns size of collection.

Specified by:

size in interface ObjectCollection<java.io.File>

Overrides:

size in class ParamFileCollection

Returns:

size