|
|||||||||
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.factory.ParamFactory
public abstract class ParamFactory
Parameter Factory is responsible for manipulating Parameter Models, which allows the factory to be substituted for a different factory if a customized factory is required.
Field Summary | |
---|---|
protected ParamInputView |
inputView
Input view for parameter. |
protected ParamOutputView |
outputView
Output view for parameter. |
Constructor Summary | |
---|---|
ParamFactory()
|
Method Summary | |
---|---|
abstract void |
createMipavParameter(AlgorithmParameters scriptParams)
Create Mipav parameter from MAPS parameter. |
javax.swing.tree.MutableTreeNode |
createTreeNode()
Creates a new Param object. |
static java.lang.String |
decodeName(java.lang.String name)
Decode name. |
static java.lang.String |
decodeValue(java.lang.String name)
Decode value. |
static java.lang.String |
encodeName(java.lang.String name)
Encode name. |
static java.lang.String |
encodeValue(java.lang.Object obj)
Encode value. |
boolean |
equals(java.lang.Object obj)
|
static ParamModel |
fromXML(java.io.File f)
Read parameter from XML file. |
static ParamModel |
fromXML(java.lang.String str)
Reconstruct parameter from XML string. |
abstract ParamInputView |
getInputView()
Get the current input view. |
abstract ParamOutputView |
getOutputView()
Get the current output view. |
abstract ParamModel |
getParameter()
Get the parameter. |
abstract void |
importMipavParameter(ParameterTable paramTable)
Import Mipav parameter into this parameter. |
boolean |
importParameter(ParamModel foreign)
Import parameter into existing parameter as long as parameter is not more restrictive than this parameter. |
boolean |
isCompatible(ParamModel foreign)
Import parameter into existing parameter as long as parameter is not more restrictive than this parameter. |
boolean |
loadResources(ParamModel foreignParam,
javax.swing.ProgressMonitor monitor)
Load external resources specified in foreign parameter into this parameter. |
boolean |
read(java.io.File f)
Read parameter from XML file. |
boolean |
read(java.lang.String text,
boolean loadResources)
Read parameter from String. |
boolean |
saveResources(java.io.File dir,
boolean saveSubDirectoryOverride)
Save external resources to specified directory. |
void |
setInputView(ParamInputView view)
Set the input view used to enter the parameter value. |
void |
setOutputView(ParamOutputView view)
Set the output view used to display the parameter value. |
java.lang.String |
toXML()
Serialize parameter as XML. |
boolean |
write(java.io.File f)
Write parameter to file in XML. |
void |
write(java.io.ObjectOutputStream out)
Write object to serialization stream. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected ParamInputView inputView
protected ParamOutputView outputView
Constructor Detail |
---|
public ParamFactory()
Method Detail |
---|
public static java.lang.String decodeName(java.lang.String name)
name
- the name
public static java.lang.String decodeValue(java.lang.String name)
name
- the name
public static java.lang.String encodeName(java.lang.String name)
name
- the name
public static java.lang.String encodeValue(java.lang.Object obj)
obj
- the obj
public static ParamModel fromXML(java.io.File f)
f
- file
public static ParamModel fromXML(java.lang.String str)
str
- the str
public abstract void createMipavParameter(AlgorithmParameters scriptParams) throws ParserException
scriptParams
- script parameters that will store this parameter
ParserException
- the parser exceptionpublic javax.swing.tree.MutableTreeNode createTreeNode()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public abstract ParamInputView getInputView()
public abstract ParamOutputView getOutputView()
public abstract ParamModel getParameter()
public abstract void importMipavParameter(ParameterTable paramTable) throws ParameterException
paramTable
- the param table
ParameterException
- the parameter exceptionpublic boolean importParameter(ParamModel foreign)
foreign
- foreign parameter
public boolean isCompatible(ParamModel foreign)
foreign
- foreign parameter
public boolean loadResources(ParamModel foreignParam, javax.swing.ProgressMonitor monitor)
foreignParam
- foreign parametermonitor
- TODO
public boolean read(java.io.File f)
f
- file
public boolean read(java.lang.String text, boolean loadResources)
text
- stringloadResources
- the load resources
public boolean saveResources(java.io.File dir, boolean saveSubDirectoryOverride)
dir
- directory
public void setInputView(ParamInputView view)
view
- the viewpublic void setOutputView(ParamOutputView view)
view
- the viewpublic java.lang.String toXML()
public boolean write(java.io.File f)
f
- file
public void write(java.io.ObjectOutputStream out) throws java.io.IOException
out
- the out
java.io.IOException
- Signals that an I/O exception has occurred.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |