|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.String> edu.jhu.ece.iacl.jist.pipeline.parameter.ParamSwitch
public class ParamSwitch
Command line switch parameter.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort |
---|
PipePort.PortListener, PipePort.type |
Field Summary | |
---|---|
protected boolean |
switchSpaced
The switch spaced. |
protected java.lang.String |
switchString
The switch string. |
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 | |
---|---|
ParamSwitch()
Default constructor. |
|
ParamSwitch(java.lang.String name,
java.lang.String switchString)
Constructor. |
|
ParamSwitch(java.lang.String name,
java.lang.String switchString,
boolean switchSpaced)
Constructor. |
Method Summary | |
---|---|
ParamSwitch |
clone()
Clone object. |
int |
compareTo(ParamModel obj)
Compare specificity of parameters. |
java.lang.String |
getHumanReadableDataType()
|
java.lang.String |
getValue()
Get switch string. |
java.lang.String |
getXMLValue()
|
void |
init()
Initialize parameter. |
boolean |
isSwitchSpaced()
Returns true if there is a space after the switch. |
java.lang.String |
probeDefaultValue()
|
void |
setSwitchSpaced(boolean switchSpaced)
Indicates whether there should be a space after the switch. |
void |
setValue(java.lang.String value)
Set switch string. |
void |
setXMLValue(java.lang.String arg)
|
java.lang.String |
toString()
Get switch description. |
void |
validate()
Unimplemented. |
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 |
---|
protected java.lang.String switchString
protected boolean switchSpaced
Constructor Detail |
---|
public ParamSwitch()
public ParamSwitch(java.lang.String name, java.lang.String switchString)
name
- parameter nameswitchString
- switch stringpublic ParamSwitch(java.lang.String name, java.lang.String switchString, boolean switchSpaced)
name
- parameter nameswitchString
- switch stringswitchSpaced
- flag to indicate whether to put a space after switchMethod Detail |
---|
public ParamSwitch clone()
clone
in class ParamModel<java.lang.String>
public int compareTo(ParamModel obj)
ParamModel
compareTo
in interface java.lang.Comparable<ParamModel>
compareTo
in class ParamModel<java.lang.String>
obj
- the mod
public java.lang.String getValue()
getValue
in class ParamModel<java.lang.String>
public void init()
init
in class ParamHidden<java.lang.String>
public boolean isSwitchSpaced()
public void setSwitchSpaced(boolean switchSpaced)
switchSpaced
- true if spacedpublic void setValue(java.lang.String value) throws InvalidParameterValueException
setValue
in class ParamModel<java.lang.String>
value
- the value
InvalidParameterValueException
- the invalid parameter value exceptionpublic java.lang.String toString()
toString
in class ParamModel<java.lang.String>
public void validate() throws InvalidParameterException
validate
in class ParamModel<java.lang.String>
InvalidParameterException
- the invalid parameter exceptionpublic java.lang.String getHumanReadableDataType()
getHumanReadableDataType
in class ParamModel<java.lang.String>
public java.lang.String getXMLValue()
getXMLValue
in class ParamModel<java.lang.String>
public void setXMLValue(java.lang.String arg)
setXMLValue
in class ParamModel<java.lang.String>
public java.lang.String probeDefaultValue()
probeDefaultValue
in class ParamModel<java.lang.String>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |