edu.jhu.ece.iacl.jist.pipeline.parameter
Class ParamObject<T>

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<T>

Type Parameters:

T - *

All Implemented Interfaces:

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

Direct Known Subclasses:

ParamSurface, ParamVolume

public class ParamObject<T>
extends ParamFile

Parameter for generic object which uses specified reader/writer.

Author:

Blake Lucas (bclucas@jhu.edu)

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

protected T	obj The obj.
protected FileReaderWriter<T>	readerWriter The reader writer.

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

ParamObject(ParamFile.DialogType type)
Constructor.

ParamObject(java.lang.String name)
Constructor.

ParamObject(java.lang.String name, FileReaderWriter<T> readerWriter)
Constructor.

ParamObject(java.lang.String name, ParamFile.DialogType type)
Constructor.

Method Summary

ParamObject	clone() Clone object.
T	getObject() Get object.
FileReaderWriter<T>	getReaderWriter() Get reader and writer for object.
void	init() Initialize parameter.
void	setFileName(java.lang.String fileName) Set filename to store object.
void	setObject(T obj) Set object.
void	setReaderWriter(FileReaderWriter<T> readerWriter) Set reader writer.
void	setValue(java.io.File f) Set file to store object.
void	setValue(java.lang.String s) Set filename as string.
java.lang.String	toString() Get description of object.
void	validate() Validate filename.
boolean	writeObject(java.io.File f) Write stored object to file.

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

clean, compareTo, getDialogType, getExtensionFilter, getHumanReadableDataType, getURI, getValue, getXMLValue, isCompatible, 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

Field Detail

obj

protected transient T obj

The obj.

readerWriter

protected FileReaderWriter<T> readerWriter

The reader writer.

Constructor Detail

ParamObject

public ParamObject(ParamFile.DialogType type)

Constructor.

Parameters:

type - dialog type

ParamObject

public ParamObject(java.lang.String name)

Constructor.

Parameters:

name - parameter name

ParamObject

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

Constructor.

Parameters:

name - parameter name

type - dialog type

ParamObject

public ParamObject(java.lang.String name,
                   FileReaderWriter<T> readerWriter)

Constructor.

Parameters:

name - parameter name

readerWriter - reader/writer

Method Detail

clone

public ParamObject clone()

Clone object.

Overrides:

clone in class ParamFile

Returns:

the param object

getObject

public T getObject()

Get object.

Returns:

object

getReaderWriter

public FileReaderWriter<T> getReaderWriter()

Get reader and writer for object.

Returns:

reader/writer

init

public void init()

Initialize parameter.

Overrides:

init in class ParamFile

setFileName

public void setFileName(java.lang.String fileName)

Set filename to store object.

Parameters:

fileName - the file name

setObject

public void setObject(T obj)

Set object.

Parameters:

obj - object

setReaderWriter

public void setReaderWriter(FileReaderWriter<T> readerWriter)

Set reader writer. This adds an extra restriction to the file parameter

Parameters:

readerWriter - the reader writer

setValue

public void setValue(java.io.File f)

Set file to store object.

Overrides:

setValue in class ParamFile

Parameters:

f - the f

setValue

public void setValue(java.lang.String s)

Set filename as string.

Overrides:

setValue in class ParamFile

Parameters:

s - the s

toString

public java.lang.String toString()

Get description of object.

Overrides:

toString in class ParamFile

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

Validate filename.

Overrides:

validate in class ParamFile

Throws:

InvalidParameterException - the invalid parameter exception

writeObject

public boolean writeObject(java.io.File f)

Write stored object to file.

Parameters:

f - filename

Returns:

true if writer is successful