edu.jhu.ece.iacl.jist.pipeline.factory
Class ParamCollectionFactory

java.lang.Object
  extended by edu.jhu.ece.iacl.jist.pipeline.factory.ParamFactory
      extended by edu.jhu.ece.iacl.jist.pipeline.factory.ParamCollectionFactory

public class ParamCollectionFactory
extends ParamFactory

Parameter Collection Factory.

Author:
Blake Lucas

Field Summary
 
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.factory.ParamFactory
inputView, outputView
 
Constructor Summary
ParamCollectionFactory(ParamCollection params)
          Instantiates a new param collection factory.
 
Method Summary
 void createMipavParameter(AlgorithmParameters scriptParams)
          Create Mipav parameter from MAPS parameter.
 javax.swing.tree.MutableTreeNode createTreeNode()
          Creates a new Param object.
 boolean equals(java.lang.Object obj)
           
 ParamInputView getInputView()
          Get the current input view.
 ParamOutputView getOutputView()
          Get the current output view.
 ParamCollection getParameter()
          Get the parameter.
 ParamModel getParameter(java.lang.String name)
          Gets the parameter.
 void importMipavParameter(ParameterTable paramTable)
          Import Mipav parameter into this parameter.
 boolean importParameter(ParamModel model)
          Import parameter into existing parameter as long as parameter is not more restrictive than this parameter.
 boolean loadResources(ParamModel foreign, javax.swing.ProgressMonitor monitor)
          Load external resources specified in foreign parameter into this parameter.
 boolean saveResources(java.io.File dir, boolean saveSubDirectoryOverride)
          Save external resources to specified directory.
 
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.factory.ParamFactory
decodeName, decodeValue, encodeName, encodeValue, fromXML, fromXML, isCompatible, read, read, setInputView, setOutputView, toXML, write, write
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParamCollectionFactory

public ParamCollectionFactory(ParamCollection params)
Instantiates a new param collection factory.

Parameters:
params - the params
Method Detail

createMipavParameter

public void createMipavParameter(AlgorithmParameters scriptParams)
                          throws ParserException
Description copied from class: ParamFactory
Create Mipav parameter from MAPS parameter.

Specified by:
createMipavParameter in class ParamFactory
Parameters:
scriptParams - script parameters that will store this parameter
Throws:
ParserException - the parser exception

createTreeNode

public javax.swing.tree.MutableTreeNode createTreeNode()
Description copied from class: ParamFactory
Creates a new Param object.

Overrides:
createTreeNode in class ParamFactory
Returns:
the mutable tree node

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class ParamFactory

getInputView

public ParamInputView getInputView()
Description copied from class: ParamFactory
Get the current input view.

Specified by:
getInputView in class ParamFactory
Returns:
the input view

getOutputView

public ParamOutputView getOutputView()
Description copied from class: ParamFactory
Get the current output view.

Specified by:
getOutputView in class ParamFactory
Returns:
the output view

getParameter

public ParamCollection getParameter()
Description copied from class: ParamFactory
Get the parameter.

Specified by:
getParameter in class ParamFactory
Returns:
the parameter

getParameter

public ParamModel getParameter(java.lang.String name)
Gets the parameter.

Parameters:
name - the name
Returns:
the parameter

importMipavParameter

public void importMipavParameter(ParameterTable paramTable)
                          throws ParameterException
Description copied from class: ParamFactory
Import Mipav parameter into this parameter.

Specified by:
importMipavParameter in class ParamFactory
Parameters:
paramTable - the param table
Throws:
ParameterException - the parameter exception

importParameter

public boolean importParameter(ParamModel model)
Description copied from class: ParamFactory
Import parameter into existing parameter as long as parameter is not more restrictive than this parameter. This method copies value of foreign parameter into this parameter.

Overrides:
importParameter in class ParamFactory
Parameters:
model - foreign parameter
Returns:
import successful

loadResources

public boolean loadResources(ParamModel foreign,
                             javax.swing.ProgressMonitor monitor)
Description copied from class: ParamFactory
Load external resources specified in foreign parameter into this parameter.

Overrides:
loadResources in class ParamFactory
Parameters:
foreign - foreign parameter
monitor - TODO
Returns:
true, if load resources

saveResources

public boolean saveResources(java.io.File dir,
                             boolean saveSubDirectoryOverride)
Description copied from class: ParamFactory
Save external resources to specified directory.

Overrides:
saveResources in class ParamFactory
Parameters:
dir - directory
Returns:
true, if save resources