|
|||||||||
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.PipeModule edu.jhu.ece.iacl.jist.pipeline.PipeAlgorithm
public class PipeAlgorithm
A pipe module for processing algorithms.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule |
---|
PipeModule.PipeListener |
Field Summary | |
---|---|
protected ProcessingAlgorithm |
algo
processing algorithm. |
protected PipeAlgorithmFactory.AlgorithmCell |
lastCell
graph cell to represent algorithm. |
protected java.io.File |
mapFile
file that stores this module definition. |
protected PipeAlgorithmGroup |
parent
parent graph cell if this algorithm is in a group. |
Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule |
---|
bounds, cell, currentContext, inputHash, inputParams, inputPorts, label, listeners, name, outputHash, outputParams, outputPorts |
Constructor Summary | |
---|---|
PipeAlgorithm()
Default constructor. |
|
PipeAlgorithm(ProcessingAlgorithm algo)
The Constructor. |
Method Summary | |
---|---|
PipeAlgorithm |
clone()
Clone algorithm by serializing and deserializing module. |
protected ProcessingAlgorithm |
createAlgorithm()
Create Processing Algorithm from the algorithm class. |
PipeAlgorithmFactory.AlgorithmCell |
createModuleCell()
Create cell to render this module. |
static PipeAlgorithm |
fromXML(java.lang.String str)
Reconstruct algorithm from string. |
ProcessingAlgorithm |
getAlgorithm()
Get Processing Algorithm wrapped by this pipe module. |
java.lang.Class |
getAlgorithmClass()
Get the Processing Algorithm class from the input parameters. |
java.lang.String |
getCategory()
Gets the category. |
java.util.Vector<ExecutionContext> |
getCurrentParentContexts()
Gets the current parent contexts. |
java.lang.String[] |
getDefaultJVMArgs()
Gets the default jvm args for the algorithm unit that is encapsulated by this class |
java.io.File |
getMapFile()
Get file that stores this algorithm. |
java.lang.String |
getPackage()
Gets the package. |
PipeAlgorithmGroup |
getParentGroup()
Get parent module if this is a member of a group. |
PipeModuleCell |
init(PipeJGraph graph)
Initialize transient fields that could not be deserialized. |
boolean |
isRoot()
Return true if this module doesn't have any parents who are Processing Algorithms. |
static PipeAlgorithm |
open(java.awt.Component parent)
Open file from user specified location. |
static PipeAlgorithm |
read(java.io.File f)
Read algorithm from file. |
boolean |
saveAs()
Save algorithm in specified user location. |
boolean |
saveInputParams(java.io.File f)
Write input parameters to file. |
boolean |
saveOutputParams(java.io.File f)
Write output parameters to file. |
protected java.io.File |
selectSaveFile()
Select location to save algorithm. |
void |
setAlgorithm(ProcessingAlgorithm algo)
Automatically creates all the input and output ports using the input and output parameters in the Processing Algorithm. |
void |
setMapFile(java.io.File mapFile)
Set file that stores this algorithm. |
void |
setParentGroup(PipeAlgorithmGroup parent)
Set parent module. |
java.lang.String |
toString()
Returns algorithm label. |
java.lang.String |
toXML()
Serialize class as XML. |
boolean |
write(java.io.File f)
Write algorithm to file. |
Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipeModule |
---|
addListener, connectAction, disconnect, disconnectAction, forward, getAncestors, getAncestors, getBounds, getChildren, getCurrentContext, getDescendants, getDescendants, getInputHash, getInputParams, getInputPorts, getLabel, getListeners, getModuleCell, getName, getOutputHash, getOutputParams, getOutputPorts, getParents, isAncestorOf, isDescendantOf, push, removeAllListeners, removeListener, setBounds, setCurrentContext, setLabel, setModuleCell, setName, update |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected transient ProcessingAlgorithm algo
protected transient PipeAlgorithmFactory.AlgorithmCell lastCell
protected transient PipeAlgorithmGroup parent
protected transient java.io.File mapFile
Constructor Detail |
---|
public PipeAlgorithm()
public PipeAlgorithm(ProcessingAlgorithm algo)
algo
- Processing Algorithm to wrap with this pipe moduleMethod Detail |
---|
public static PipeAlgorithm fromXML(java.lang.String str)
str
- the string
public static PipeAlgorithm open(java.awt.Component parent)
parent
- parent component
public static PipeAlgorithm read(java.io.File f)
f
- the file
public java.lang.String[] getDefaultJVMArgs()
public java.lang.String getCategory()
public java.lang.String getPackage()
public PipeAlgorithm clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
- the clone not supported exceptionprotected ProcessingAlgorithm createAlgorithm()
public PipeAlgorithmFactory.AlgorithmCell createModuleCell()
createModuleCell
in class PipeModule
public ProcessingAlgorithm getAlgorithm()
public java.lang.Class getAlgorithmClass()
public java.util.Vector<ExecutionContext> getCurrentParentContexts()
public java.io.File getMapFile()
public PipeAlgorithmGroup getParentGroup()
public PipeModuleCell init(PipeJGraph graph)
init
in class PipeModule
graph
- the graph
public boolean isRoot()
isRoot
in class PipeModule
public boolean saveAs()
public boolean saveInputParams(java.io.File f)
f
- the file
public boolean saveOutputParams(java.io.File f)
f
- the file
protected java.io.File selectSaveFile()
public void setAlgorithm(ProcessingAlgorithm algo)
algo
- the algorithmpublic void setMapFile(java.io.File mapFile)
mapFile
- map filepublic void setParentGroup(PipeAlgorithmGroup parent)
parent
- parent modulepublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toXML()
public boolean write(java.io.File f)
f
- output file
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |