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

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<java.io.File>
          edu.jhu.ece.iacl.jist.pipeline.parameter.ParamFile
              edu.jhu.ece.iacl.jist.pipeline.parameter.ParamObject<EmbeddedSurface>
                  edu.jhu.ece.iacl.jist.pipeline.parameter.ParamSurface

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<ParamModel>

public class ParamSurface
extends ParamObject<EmbeddedSurface>

Surface parameter file.

Author:

Blake Lucas

Nested Class Summary

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

ParamFile.DialogType

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.ParamObject

obj, readerWriter

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

dialogType, extensionFilter, file, uri

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

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

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

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

Constructor Summary

ParamSurface(ParamFile.DialogType type)
Constructor.

ParamSurface(java.lang.String name)
Construct parameter for a mandatory file type.

ParamSurface(java.lang.String name, ParamFile.DialogType type)
Construct parameter with specified restrictions.

Method Summary

ParamSurface	clone() Clone object.
int	compareTo(ParamModel model) Compare two parameters based on their dialog types, extensionFilters, and mandatory fields F *.
EmbeddedSurface	getObject() Get Surface.
EmbeddedSurface	getSurface() Get surface.
void	init() Initialize parameter.
boolean	isCompatible(PipePort model) Returns true if port is compatible with this parameter's extension filter.
void	setObject(EmbeddedSurface obj) Set surface.
void	setValue(EmbeddedSurface value) Set surface.
java.lang.String	toString() Get description of surface.
void	validate() validate surface.

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

getReaderWriter, setFileName, setReaderWriter, setValue, setValue, writeObject

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

clean, getDialogType, getExtensionFilter, getHumanReadableDataType, getURI, getValue, getXMLValue, probeDefaultValue, replacePath, setExtensionFilter, setValue, setXMLValue, translatePath

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, isMandatory, loadResources, loadResources, read, read, saveResources, setCliTag, setDescription, setFactory, setHidden, setInputView, setLabel, setLoadAndSaveOnValidate, setMandatory, 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

ParamSurface

public ParamSurface(ParamFile.DialogType type)

Constructor.

Parameters:

type - the type

ParamSurface

public ParamSurface(java.lang.String name)

Construct parameter for a mandatory file type.

Parameters:

name - parameter name

ParamSurface

public ParamSurface(java.lang.String name,
                    ParamFile.DialogType type)

Construct parameter with specified restrictions.

Parameters:

name - parameter name

type - directory or file dialog

Method Detail

clone

public ParamSurface clone()

Clone object.

Overrides:

clone in class ParamObject<EmbeddedSurface>

Returns:

the param surface

compareTo

public int compareTo(ParamModel model)

Description copied from class: ParamFile

Compare two parameters based on their dialog types, extensionFilters, and mandatory fields F *.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamFile

Parameters:

model - the model

Returns:

the int

getObject

public EmbeddedSurface getObject()

Get Surface.

Overrides:

getObject in class ParamObject<EmbeddedSurface>

Returns:

the object

getSurface

public EmbeddedSurface getSurface()

Get surface.

Returns:

surface

init

public void init()

Initialize parameter.

Overrides:

init in class ParamObject<EmbeddedSurface>

isCompatible

public boolean isCompatible(PipePort model)

Description copied from class: ParamFile

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

Overrides:

isCompatible in class ParamFile

Parameters:

model - the model

Returns:

true, if checks if is compatible

setObject

public void setObject(EmbeddedSurface obj)

Set surface.

Overrides:

setObject in class ParamObject<EmbeddedSurface>

Parameters:

obj - the obj

setValue

public void setValue(EmbeddedSurface value)

Set surface.

Parameters:

value - the value

toString

public java.lang.String toString()

Get description of surface.

Overrides:

toString in class ParamObject<EmbeddedSurface>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

validate surface.

Overrides:

validate in class ParamObject<EmbeddedSurface>

Throws:

InvalidParameterException - the invalid parameter exception