edu.jhu.ece.iacl.jist.pipeline.parser
Class LoniPipeParser

java.lang.Object
  extended by edu.jhu.ece.iacl.jist.pipeline.parser.LoniPipeParser
All Implemented Interfaces:
ScriptParser

public class LoniPipeParser
extends java.lang.Object
implements ScriptParser

The Class LoniPipeParser.


Field Summary
static java.lang.String AUTHOR_TAG
          The Constant AUTHOR_TAG.
static java.lang.String AUTHORS_TAG
          The Constant AUTHORS_TAG.
static java.lang.String CITATION_TAG
          The Constant CITATION_TAG.
static java.lang.String CITATIONS_TAG
          The Constant CITATIONS_TAG.
static java.lang.String CONNECTION_TAG
          The Constant CONNECTION_TAG.
static java.lang.String CONNECTIONS_TAG
          The Constant CONNECTIONS_TAG.
static java.lang.String DATA_MODULE_TAG
          The Constant DATA_MODULE_TAG.
static java.lang.String DATA_TAG
          The Constant DATA_TAG.
static java.lang.String ENUMERATION_TAG
          The Constant ENUMERATION_TAG.
static java.lang.String FILE_TYPE_TAG
          The Constant FILE_TYPE_TAG.
static java.lang.String FILE_TYPES_TAG
          The Constant FILE_TYPES_TAG.
static java.lang.String FORMAT_TAG
          The Constant FORMAT_TAG.
static java.lang.String INPUT_TAG
          The Constant INPUT_TAG.
protected  java.util.Hashtable<java.lang.String,java.lang.String> inputAliases
          The input aliases.
static java.lang.String METADATA_TAG
          The Constant METADATA_TAG.
static java.lang.String MODULE_GROUP_TAG
          The Constant MODULE_GROUP_TAG.
static java.lang.String MODULE_TAG
          The Constant MODULE_TAG.
static java.lang.String OUTPUT_TAG
          The Constant OUTPUT_TAG.
protected  java.util.Hashtable<java.lang.String,java.lang.String> outputAliases
          The output aliases.
static java.lang.String PIPELINE_TAG
          The Constant PIPELINE_TAG.
static java.lang.String URI_TAG
          The Constant URI_TAG.
static java.lang.String VALUE_TAG
          The Constant VALUE_TAG.
static java.lang.String VALUES_TAG
          The Constant VALUES_TAG.
 
Constructor Summary
LoniPipeParser()
          Default constructor.
 
Method Summary
 PipeLayout openLayout(java.io.File f)
          Open layout from script file.
 PipeAlgorithm openPipeAlgorithm()
          Open LONI script from file.
protected  void parseConnections(Element elem, PipeAlgorithmGroup algo)
          Parse connections.
protected  void parseConnections(Element elem, PipeLayout layout)
          Parse connections.
protected  java.util.ArrayList<PipeModule> parseDataSources(Elements elems)
          Parse data sources and connect them to modules.
protected  PipeLayout parseLayout(java.io.File f)
          Parse layout.
protected  PipeAlgorithm parseModule(Element elem)
          Parse element.
protected  PipeAlgorithmGroup parseModuleGroup(Element elem)
          parse algorithm group.
protected  void parseParam(Element elem, ParamCollection params, java.util.Hashtable<java.lang.Integer,java.lang.String> orderHash)
          Parse particular parameter.
 PipeAlgorithm parsePipeAlgorithm(java.io.File f)
          Parse LONI script from file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULE_TAG

public static final java.lang.String MODULE_TAG
The Constant MODULE_TAG.

See Also:
Constant Field Values

MODULE_GROUP_TAG

public static final java.lang.String MODULE_GROUP_TAG
The Constant MODULE_GROUP_TAG.

See Also:
Constant Field Values

CONNECTIONS_TAG

public static final java.lang.String CONNECTIONS_TAG
The Constant CONNECTIONS_TAG.

See Also:
Constant Field Values

CONNECTION_TAG

public static final java.lang.String CONNECTION_TAG
The Constant CONNECTION_TAG.

See Also:
Constant Field Values

INPUT_TAG

public static final java.lang.String INPUT_TAG
The Constant INPUT_TAG.

See Also:
Constant Field Values

OUTPUT_TAG

public static final java.lang.String OUTPUT_TAG
The Constant OUTPUT_TAG.

See Also:
Constant Field Values

PIPELINE_TAG

public static final java.lang.String PIPELINE_TAG
The Constant PIPELINE_TAG.

See Also:
Constant Field Values

FORMAT_TAG

public static final java.lang.String FORMAT_TAG
The Constant FORMAT_TAG.

See Also:
Constant Field Values

ENUMERATION_TAG

public static final java.lang.String ENUMERATION_TAG
The Constant ENUMERATION_TAG.

See Also:
Constant Field Values

FILE_TYPE_TAG

public static final java.lang.String FILE_TYPE_TAG
The Constant FILE_TYPE_TAG.

See Also:
Constant Field Values

VALUE_TAG

public static final java.lang.String VALUE_TAG
The Constant VALUE_TAG.

See Also:
Constant Field Values

FILE_TYPES_TAG

public static final java.lang.String FILE_TYPES_TAG
The Constant FILE_TYPES_TAG.

See Also:
Constant Field Values

VALUES_TAG

public static final java.lang.String VALUES_TAG
The Constant VALUES_TAG.

See Also:
Constant Field Values

DATA_MODULE_TAG

public static final java.lang.String DATA_MODULE_TAG
The Constant DATA_MODULE_TAG.

See Also:
Constant Field Values

AUTHOR_TAG

public static final java.lang.String AUTHOR_TAG
The Constant AUTHOR_TAG.

See Also:
Constant Field Values

AUTHORS_TAG

public static final java.lang.String AUTHORS_TAG
The Constant AUTHORS_TAG.

See Also:
Constant Field Values

CITATIONS_TAG

public static final java.lang.String CITATIONS_TAG
The Constant CITATIONS_TAG.

See Also:
Constant Field Values

CITATION_TAG

public static final java.lang.String CITATION_TAG
The Constant CITATION_TAG.

See Also:
Constant Field Values

DATA_TAG

public static final java.lang.String DATA_TAG
The Constant DATA_TAG.

See Also:
Constant Field Values

URI_TAG

public static final java.lang.String URI_TAG
The Constant URI_TAG.

See Also:
Constant Field Values

METADATA_TAG

public static final java.lang.String METADATA_TAG
The Constant METADATA_TAG.

See Also:
Constant Field Values

inputAliases

protected java.util.Hashtable<java.lang.String,java.lang.String> inputAliases
The input aliases.


outputAliases

protected java.util.Hashtable<java.lang.String,java.lang.String> outputAliases
The output aliases.

Constructor Detail

LoniPipeParser

public LoniPipeParser()
Default constructor.

Method Detail

openLayout

public PipeLayout openLayout(java.io.File f)
Open layout from script file.

Parameters:
f - script file
Returns:
pipe layout

openPipeAlgorithm

public PipeAlgorithm openPipeAlgorithm()
Open LONI script from file.

Specified by:
openPipeAlgorithm in interface ScriptParser
Returns:
the pipe algorithm

parseConnections

protected void parseConnections(Element elem,
                                PipeAlgorithmGroup algo)
                         throws java.io.IOException
Parse connections.

Parameters:
elem - xml element
algo - parent algorithm group
Throws:
java.io.IOException - Signals that an I/O exception has occurred.

parseConnections

protected void parseConnections(Element elem,
                                PipeLayout layout)
                         throws java.io.IOException
Parse connections.

Parameters:
elem - xml element
layout - parent layout
Throws:
java.io.IOException - Signals that an I/O exception has occurred.

parseDataSources

protected java.util.ArrayList<PipeModule> parseDataSources(Elements elems)
                                                    throws java.io.IOException
Parse data sources and connect them to modules.

Parameters:
elems - xml elements
Returns:
list of sources
Throws:
java.io.IOException - Signals that an I/O exception has occurred.

parseLayout

protected PipeLayout parseLayout(java.io.File f)
Parse layout.

Parameters:
f - script file
Returns:
pipe layout

parseModule

protected PipeAlgorithm parseModule(Element elem)
                             throws java.io.IOException
Parse element.

Parameters:
elem - xml element
Returns:
pipe algorithm
Throws:
java.io.IOException - Signals that an I/O exception has occurred.

parseModuleGroup

protected PipeAlgorithmGroup parseModuleGroup(Element elem)
                                       throws java.io.IOException
parse algorithm group.

Parameters:
elem - xml element
Returns:
pipe algorithm group
Throws:
java.io.IOException - Signals that an I/O exception has occurred.

parseParam

protected void parseParam(Element elem,
                          ParamCollection params,
                          java.util.Hashtable<java.lang.Integer,java.lang.String> orderHash)
Parse particular parameter.

Parameters:
elem - xml element
params - parent collection
orderHash - parameter order hash

parsePipeAlgorithm

public PipeAlgorithm parsePipeAlgorithm(java.io.File f)
Parse LONI script from file.

Specified by:
parsePipeAlgorithm in interface ScriptParser
Parameters:
f - the f
Returns:
the pipe algorithm