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

java.lang.Object
  extended by edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      extended by edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<java.lang.String>
          extended by edu.jhu.ece.iacl.jist.pipeline.parameter.ParamString
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable<ParamModel>

public class ParamString
extends ParamModel<java.lang.String>

String parameter.

Author:
Blake Lucas

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 string
          The 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
ParamString()
          Constructor.
ParamString(java.lang.String name)
          Constructor.
ParamString(java.lang.String name, java.lang.String str)
          Constructor.
 
Method Summary
 ParamString clone()
          Clone object.
 int compareTo(ParamModel model)
          Compare specificity of parameters.
 java.lang.String getHumanReadableDataType()
           
 java.lang.String getValue()
          Get string.
 java.lang.String getXMLValue()
           
 void init()
          Initialize parameter.
 java.lang.String probeDefaultValue()
           
 void setValue(java.lang.String value)
          Set string.
 void setXMLValue(java.lang.String arg)
           
 java.lang.String toString()
          Get string.
 void validate()
          validate string.
 
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, 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

string

protected java.lang.String string
The string.

Constructor Detail

ParamString

public ParamString()
Constructor.


ParamString

public ParamString(java.lang.String name)
Constructor.

Parameters:
name - parameter name

ParamString

public ParamString(java.lang.String name,
                   java.lang.String str)
Constructor.

Parameters:
name - parameter name
str - string
Method Detail

clone

public ParamString clone()
Clone object.

Specified by:
clone in class ParamModel<java.lang.String>
Returns:
the param string

compareTo

public int compareTo(ParamModel model)
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.lang.String>
Parameters:
model - the mod
Returns:
the int

getValue

public java.lang.String getValue()
Get string.

Specified by:
getValue in class ParamModel<java.lang.String>
Returns:
the value

init

public void init()
Initialize parameter.

Specified by:
init in class PipePort<java.lang.String>

setValue

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

Specified by:
setValue in class ParamModel<java.lang.String>
Parameters:
value - the value
Throws:
InvalidParameterValueException - the invalid parameter value exception

toString

public java.lang.String toString()
Get string.

Specified by:
toString in class ParamModel<java.lang.String>
Returns:
the string

validate

public void validate()
              throws InvalidParameterException
validate string. String cannot be null or zero length.

Specified by:
validate in class ParamModel<java.lang.String>
Throws:
InvalidParameterException - the invalid parameter exception

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()
Specified by:
getHumanReadableDataType in class ParamModel<java.lang.String>

getXMLValue

public java.lang.String getXMLValue()
Specified by:
getXMLValue in class ParamModel<java.lang.String>

setXMLValue

public void setXMLValue(java.lang.String arg)
Specified by:
setXMLValue in class ParamModel<java.lang.String>

probeDefaultValue

public java.lang.String probeDefaultValue()
Specified by:
probeDefaultValue in class ParamModel<java.lang.String>