ca.ucalgary.services.util
Class ACDFile

java.lang.Object
  ca.ucalgary.services.util.ACDFile

public class ACDFile
extends Object

A class representing the contents of an ACD file (EMBOSS program parameter specification). For more details on the format, please see http://emboss.sourceforge.net/developers/acd/

Field Summary

static String	BLOCK_NAME_KEY
static String	BLOCK_TYPE_KEY

Constructor Summary

ACDFile(File acdFile)
Reads an EMBOSS ACD file and populates data structures representing the sections of the file (see the getXXXSection() methods).

ACDFile(InputStream is)

ACDFile(URL acdURL)

Method Summary

List<Map<String,String>>	getAdditionalParamsSection()
List<Map<String,String>>	getAdvancedParamsSection()
List<Map<String,String>>	getApplicationSection()
List<Map<String,String>>	getInputSection() Returns a list representing the blocks of the section.
List<Map<String,String>>	getOutputSection()
List<Map<String,String>>	getRequiredParamsSection()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BLOCK_TYPE_KEY

public static final String BLOCK_TYPE_KEY

See Also:

Constant Field Values

BLOCK_NAME_KEY

public static final String BLOCK_NAME_KEY

See Also:

Constant Field Values

Constructor Detail

ACDFile

public ACDFile(File acdFile)
        throws Exception

Reads an EMBOSS ACD file and populates data structures representing the sections of the file (see the getXXXSection() methods).

Throws:

Exception - if the file cannot be read or parsed

ACDFile

public ACDFile(URL acdURL)
        throws Exception

Throws:

Exception

ACDFile

public ACDFile(InputStream is)
        throws Exception

Throws:

Exception

Method Detail

getApplicationSection

public List<Map<String,String>> getApplicationSection()

getInputSection

public List<Map<String,String>> getInputSection()

Returns a list representing the blocks of the section. Each block is a map of key/value pairs corresponding to the tag-name/tag-value pairs of the ACD block. Two hardcoded keys are the block name (BLOCK_NAME_KEY) such as "sequence", "trim", "clean" and the block type (BLOCK_TYPE_KEY) such as "list", "boolean", "range", etc.

getRequiredParamsSection

public List<Map<String,String>> getRequiredParamsSection()

getAdditionalParamsSection

public List<Map<String,String>> getAdditionalParamsSection()

getAdvancedParamsSection

public List<Map<String,String>> getAdvancedParamsSection()

getOutputSection

public List<Map<String,String>> getOutputSection()