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

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.util.ArrayList<java.lang.String>>
              edu.jhu.ece.iacl.jist.pipeline.parameter.ParamArgsOrder

All Implemented Interfaces:

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

public class ParamArgsOrder
extends ParamHidden<java.util.ArrayList<java.lang.String>>
implements JISTInternalParam

Argument order for command line calls.

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.util.ArrayList<java.lang.String>

argsOrder The args order.

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

ParamArgsOrder()
Instantiates a new param args order.

ParamArgsOrder(java.lang.String name, java.util.ArrayList<java.lang.String> argsOrder)
Instantiates a new param args order.

Method Summary

ParamArgsOrder	clone() Clone parameter.
int	compareTo(ParamModel obj) Compare specificity of parameters.
java.lang.String	getHumanReadableDataType()
java.util.ArrayList<java.lang.String>	getValue() Get the value stored in the parameter.
java.lang.String	getXMLValue()
void	init() Initialize parameter.
java.lang.String	probeDefaultValue()
void	setValue(java.util.ArrayList<java.lang.String> value) Set the parameter value.
void	setXMLValue(java.lang.String arg)
java.lang.String	toString() Get description of parameter.
void	validate() Validate parameter associated with this port.

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

argsOrder

protected java.util.ArrayList<java.lang.String> argsOrder

The args order.

Constructor Detail

ParamArgsOrder

public ParamArgsOrder()

Instantiates a new param args order.

ParamArgsOrder

public ParamArgsOrder(java.lang.String name,
                      java.util.ArrayList<java.lang.String> argsOrder)

Instantiates a new param args order.

Parameters:

name - the name

argsOrder - the args order

Method Detail

clone

public ParamArgsOrder clone()

Description copied from class: PipePort

Clone parameter.

Specified by:

clone in class ParamModel<java.util.ArrayList<java.lang.String>>

Returns:

the pipe port

compareTo

public int compareTo(ParamModel obj)

Description copied from class: ParamModel

Compare specificity of parameters. Zero indicates both parameters have the same level of specificity. Negative one indicates this parameter is less specific than the foreign one. Positive one indicates this parameter is more specific than the foreign one.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamModel<java.util.ArrayList<java.lang.String>>

Parameters:

obj - the mod

Returns:

the int

getValue

public java.util.ArrayList<java.lang.String> getValue()

Description copied from class: ParamModel

Get the value stored in the parameter.

Specified by:

getValue in class ParamModel<java.util.ArrayList<java.lang.String>>

Returns:

this the default value stored by the parameter. Although, parameters could potentially store more than one type of value.

init

public void init()

Description copied from class: ParamHidden

Initialize parameter.

Overrides:

init in class ParamHidden<java.util.ArrayList<java.lang.String>>

setValue

public void setValue(java.util.ArrayList<java.lang.String> value)
              throws InvalidParameterValueException

Description copied from class: ParamModel

Set the parameter value. A parameter maybe able to support more than one type of value

Specified by:

setValue in class ParamModel<java.util.ArrayList<java.lang.String>>

Parameters:

value - the value

Throws:

InvalidParameterValueException - object type is not an acceptable value for this parameter

toString

public java.lang.String toString()

Description copied from class: ParamModel

Get description of parameter.

Specified by:

toString in class ParamModel<java.util.ArrayList<java.lang.String>>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

Description copied from class: PipePort

Validate parameter associated with this port.

Specified by:

validate in class ParamModel<java.util.ArrayList<java.lang.String>>

Throws:

InvalidParameterException - the invalid parameter exception

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()

Specified by:

getHumanReadableDataType in class ParamModel<java.util.ArrayList<java.lang.String>>

getXMLValue

public java.lang.String getXMLValue()

Specified by:

getXMLValue in class ParamModel<java.util.ArrayList<java.lang.String>>

setXMLValue

public void setXMLValue(java.lang.String arg)

Specified by:

setXMLValue in class ParamModel<java.util.ArrayList<java.lang.String>>

probeDefaultValue

public java.lang.String probeDefaultValue()

Specified by:

probeDefaultValue in class ParamModel<java.util.ArrayList<java.lang.String>>