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

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<AlgorithmInformation>
          edu.jhu.ece.iacl.jist.pipeline.parameter.ParamInformation

All Implemented Interfaces:

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

public class ParamInformation
extends ParamModel<AlgorithmInformation>
implements JISTInternalParam

Stores information about algorithm.

Author:

Blake Lucas (bclucas@jhu.edu)

Nested Class Summary

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

PipePort.PortListener, PipePort.type

Field Summary

protected AlgorithmInformation

info The info.

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

ParamInformation()
Default constructor.

ParamInformation(AlgorithmInformation info)
Constructor.

ParamInformation(java.lang.String name)
Constructor.

ParamInformation(java.lang.String name, AlgorithmInformation info)
Constructor.

Method Summary

ParamInformation	clone() Clone object.
int	compareTo(ParamModel mod) Compare information.
boolean	equals(ParamModel<AlgorithmInformation> mod)
java.lang.String	getHumanReadableDataType()
AlgorithmInformation	getValue() Get algorithm information.
java.lang.String	getXMLValue()
void	init() Initialize parameter.
java.lang.String	probeDefaultValue()
void	setValue(AlgorithmInformation value) Set algorithm information.
void	setXMLValue(java.lang.String arg)
java.lang.String	toString() Get description of information.
void	validate() Validate information.

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

clean, createMipavParameter, createTreeNode, dispose, getCliTag, getDescription, getFactory, getInputView, getLabel, getName, getOutputView, getShortLabel, getView, hide, importMipavParameter, importParameter, isCompatible, isConnectible, isHidden, isMandatory, loadResources, loadResources, read, read, replacePath, 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

info

protected AlgorithmInformation info

The info.

Constructor Detail

ParamInformation

public ParamInformation()

Default constructor.

ParamInformation

public ParamInformation(AlgorithmInformation info)

Constructor.

Parameters:

info - algorithm information

ParamInformation

public ParamInformation(java.lang.String name)

Constructor.

Parameters:

name - parameter name

ParamInformation

public ParamInformation(java.lang.String name,
                        AlgorithmInformation info)

Constructor.

Parameters:

name - parameter name

info - algorithm information

Method Detail

clone

public ParamInformation clone()

Clone object.

Specified by:

clone in class ParamModel<AlgorithmInformation>

Returns:

the param information

compareTo

public int compareTo(ParamModel mod)

Compare information.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamModel<AlgorithmInformation>

Parameters:

mod - the mod

Returns:

the int

getValue

public AlgorithmInformation getValue()

Get algorithm information.

Specified by:

getValue in class ParamModel<AlgorithmInformation>

Returns:

the value

init

public void init()

Initialize parameter.

Specified by:

init in class PipePort<AlgorithmInformation>

setValue

public void setValue(AlgorithmInformation value)
              throws InvalidParameterValueException

Set algorithm information.

Specified by:

setValue in class ParamModel<AlgorithmInformation>

Parameters:

value - the value

Throws:

InvalidParameterValueException - the invalid parameter value exception

toString

public java.lang.String toString()

Get description of information.

Specified by:

toString in class ParamModel<AlgorithmInformation>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

Validate information.

Specified by:

validate in class ParamModel<AlgorithmInformation>

Throws:

InvalidParameterException - the invalid parameter exception

equals

public boolean equals(ParamModel<AlgorithmInformation> mod)

Overrides:

equals in class ParamModel<AlgorithmInformation>

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()

Specified by:

getHumanReadableDataType in class ParamModel<AlgorithmInformation>

getXMLValue

public java.lang.String getXMLValue()

Specified by:

getXMLValue in class ParamModel<AlgorithmInformation>

setXMLValue

public void setXMLValue(java.lang.String arg)

Specified by:

setXMLValue in class ParamModel<AlgorithmInformation>

probeDefaultValue

public java.lang.String probeDefaultValue()

Specified by:

probeDefaultValue in class ParamModel<AlgorithmInformation>