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

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<T>
          edu.jhu.ece.iacl.jist.pipeline.parameter.ParamHidden<java.lang.Class>
              edu.jhu.ece.iacl.jist.pipeline.parameter.ParamHeader

All Implemented Interfaces:

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

public class ParamHeader
extends ParamHidden<java.lang.Class>
implements JISTInternalParam

Header identifies plug-in.

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 java.lang.String	className Canonical calss name, which may or may not exist.
protected java.lang.String	uuid Least significant part of uuid
protected float	version Version of MAPS that created this header.

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

ParamHeader()
Default constructor.

ParamHeader(java.lang.String name, java.lang.Class c)
Instantiates a new param header.

Method Summary

ParamHeader	clone() Clone object.
int	compareTo(ParamModel obj) Compare values for compatibility.
boolean	equals(ParamModel<java.lang.Class> mod)
static java.lang.Class	findClass(java.lang.String className)
java.lang.String	getHumanReadableDataType()
java.lang.String	getUUID()
java.lang.Class	getValue() Get plug-in class.
float	getVersion() Get MAPS version number.
java.lang.String	getXMLValue()
void	init() Initialize parameter.
java.lang.String	probeDefaultValue()
void	setUUID(java.lang.String uuid)
void	setValue(java.lang.Class value) Set class.
void	setValue(java.lang.String value) Set class by canonical name.
void	setVersion(float version) Set MAPS version number.
void	setXMLValue(java.lang.String arg)
void	stampUUID()
java.lang.String	toString() Get class name.
void	validate() Validate class.

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

isHidden

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

className

protected java.lang.String className

Canonical calss name, which may or may not exist.

version

protected float version

Version of MAPS that created this header.

uuid

protected java.lang.String uuid

Least significant part of uuid

Constructor Detail

ParamHeader

public ParamHeader()

Default constructor.

ParamHeader

public ParamHeader(java.lang.String name,
                   java.lang.Class c)

Instantiates a new param header.

Parameters:

name - the name

c - the c

Method Detail

stampUUID

public void stampUUID()

setUUID

public void setUUID(java.lang.String uuid)

getUUID

public java.lang.String getUUID()

clone

public ParamHeader clone()

Clone object.

Specified by:

clone in class ParamModel<java.lang.Class>

Returns:

the param header

compareTo

public int compareTo(ParamModel obj)

Compare values for compatibility.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamModel<java.lang.Class>

Parameters:

obj - the obj

Returns:

the int

getValue

public java.lang.Class getValue()

Get plug-in class.

Specified by:

getValue in class ParamModel<java.lang.Class>

Returns:

the value

findClass

public static java.lang.Class findClass(java.lang.String className)

getVersion

public float getVersion()

Get MAPS version number.

Returns:

the version

init

public void init()

Initialize parameter.

Overrides:

init in class ParamHidden<java.lang.Class>

setValue

public void setValue(java.lang.Class value)
              throws InvalidParameterValueException

Set class.

Specified by:

setValue in class ParamModel<java.lang.Class>

Parameters:

value - the value

Throws:

InvalidParameterValueException - the invalid parameter value exception

setValue

public void setValue(java.lang.String value)
              throws InvalidParameterValueException

Set class by canonical name.

Parameters:

value - the value

Throws:

InvalidParameterValueException - the invalid parameter value exception

setVersion

public void setVersion(float version)

Set MAPS version number.

Parameters:

version - the version

toString

public java.lang.String toString()

Get class name.

Specified by:

toString in class ParamModel<java.lang.Class>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

Validate class.

Specified by:

validate in class ParamModel<java.lang.Class>

Throws:

InvalidParameterException - the invalid parameter exception

equals

public boolean equals(ParamModel<java.lang.Class> mod)

Overrides:

equals in class ParamModel<java.lang.Class>

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()

Specified by:

getHumanReadableDataType in class ParamModel<java.lang.Class>

getXMLValue

public java.lang.String getXMLValue()

Specified by:

getXMLValue in class ParamModel<java.lang.Class>

setXMLValue

public void setXMLValue(java.lang.String arg)

Specified by:

setXMLValue in class ParamModel<java.lang.Class>

probeDefaultValue

public java.lang.String probeDefaultValue()

Specified by:

probeDefaultValue in class ParamModel<java.lang.Class>