MapTools (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.util.maptools.MapTools

```
public class MapTools
extends Object
```
MapTools class.

Version:

$Id: $Id

Author:

boconnor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LEGACY_VAR_BUNDLE_DIR`
`static String`	`LEGACY_VAR_DATE`
`static String`	`LEGACY_VAR_RANDOM`
`static String`	`VAR_BUNDLE_DIR`
`static String`	`VAR_DATE`
`static String`	`VAR_DATETIME`
`static String`	`VAR_RANDOM`
`static String`	`VAR_TIMESTAMP`
`static String`	`VAR_UUID`
`static String`	`VAR_WORKFLOW_VERSION`

Constructor Summary

Constructors
Constructor and Description

MapTools()

Constructors
Constructor and Description
`MapTools()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`cli2Map(String[] args, Map<String,String> hm)` Method to getValues all "--key=value" or "--key value" parameters and add them to hashmap
`static SortedSet<WorkflowRunParam>`	`createWorkflowRunParameters(HashMap<String,String> map)` Convert what looks like a map of ini key-value pairs into a SortedSet of WorkflowRunParams
`static Map<String,String>`	`expandVariables(Map<String,String> raw)`
`static Map<String,String>`	`expandVariables(Map<String,String> raw, Map<String,String> provided)`
`static Map<String,String>`	`expandVariables(Map<String,String> raw, Map<String,String> provided, boolean allowMissingVars)`
`static String`	`generatedValue(String key)`
`static void`	`ini2Map(InputStream iniFile, Map<String,String> hm, boolean keyToUpper)` ini2Map.
`static void`	`ini2Map(String iniFile, Map<String,String> hm)` ini2Map.
`static void`	`ini2Map(String iniFile, Map<String,String> hm, boolean keyToUpper)` ini2Map.
`static void`	`ini2RichMap(String iniFile, Map<String,Map<String,String>> hm)` This is a little different than the ini2Map since it allows us to read ini files where key-value annotations on the key-values appear in comments on the previous line above the current such as: key=bam_inputs:type=file:display=T:display_name=BAM Input(s):file_meta_type=application/bam or key=run_ends:type=pulldown:display=T:display_name=Single or Paired Ends:pulldown_items=Single End\|1;Paired End\|2 The extra information is used by the Portal and Web Service to display interfaces that let people call the workflows correctly.
`static Map<String,String>`	`iniString2Map(String iniString)` iniString2Map.
`static Map`	`mapString2Int(Map map)` mapString2Int.
`static void`	`provideBundleDir(Map<String,String> m, String bundleDir)`
`static void`	`provideBundleVersion(Map<String,String> m, String bundleVersion)`
`static Map<String,String>`	`providedMap(String bundleDir, String bundleSeqwareVersion)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- VAR_RANDOM
```
public static final String VAR_RANDOM
```
  See Also:
  Constant Field Values
- VAR_DATE
```
public static final String VAR_DATE
```
  See Also:
  Constant Field Values
- VAR_DATETIME
```
public static final String VAR_DATETIME
```
  See Also:
  Constant Field Values
- VAR_TIMESTAMP
```
public static final String VAR_TIMESTAMP
```
  See Also:
  Constant Field Values
- VAR_UUID
```
public static final String VAR_UUID
```
  See Also:
  Constant Field Values
- VAR_BUNDLE_DIR
```
public static final String VAR_BUNDLE_DIR
```
  See Also:
  Constant Field Values
- LEGACY_VAR_RANDOM
```
public static final String LEGACY_VAR_RANDOM
```
  See Also:
  Constant Field Values
- LEGACY_VAR_DATE
```
public static final String LEGACY_VAR_DATE
```
  See Also:
  Constant Field Values
- LEGACY_VAR_BUNDLE_DIR
```
public static final String LEGACY_VAR_BUNDLE_DIR
```
  See Also:
  Constant Field Values
- VAR_WORKFLOW_VERSION
```
public static final String VAR_WORKFLOW_VERSION
```
  See Also:
  Constant Field Values

Constructor Detail
- MapTools
```
public MapTools()
```

Method Detail

ini2Map

public static void ini2Map(String iniFile,
           Map<String,String> hm)

ini2Map.

Parameters:: iniFile - a String object.; hm - a Map object.

ini2RichMap
```
public static void ini2RichMap(String iniFile,
               Map<String,Map<String,String>> hm)
```
This is a little different than the ini2Map since it allows us to read ini files where key-value annotations on the key-values appear in comments on the previous line above the current such as: key=bam_inputs:type=file:display=T:display_name=BAM Input(s):file_meta_type=application/bam or key=run_ends:type=pulldown:display=T:display_name=Single or Paired Ends:pulldown_items=Single End|1;Paired End|2 The extra information is used by the Portal and Web Service to display interfaces that let people call the workflows correctly. This code doesn't know about the contents of the metadata key-values other than they are ":" delimited with key=value.

Parameters:
iniFile - a String object.
hm - a HashMap to be filled with key and details as key-values in a nested HashMap.

ini2Map

public static void ini2Map(String iniFile,
           Map<String,String> hm,
           boolean keyToUpper)

ini2Map.

Parameters:: iniFile - a String object.; hm - a Map object.; keyToUpper - a boolean.

ini2Map

public static void ini2Map(InputStream iniFile,
           Map<String,String> hm,
           boolean keyToUpper)
                    throws IOException

ini2Map.

Parameters:: iniFile - a InputStream object.; hm - a Map object.; keyToUpper - a boolean.
Throws:: IOException - if any.

cli2Map
```
public static void cli2Map(String[] args,
           Map<String,String> hm)
```
Method to getValues all "--key=value" or "--key value" parameters and add them to hashmap

Parameters:
args - an array of String objects.
hm - a Map object.

mapString2Int
```
public static Map mapString2Int(Map map)
```
mapString2Int.

Parameters:
map - a Map object.

Returns:
a Map object.

provideBundleVersion

public static void provideBundleVersion(Map<String,String> m,
                        String bundleVersion)

provideBundleDir

public static void provideBundleDir(Map<String,String> m,
                    String bundleDir)

providedMap

public static Map<String,String> providedMap(String bundleDir,
                             String bundleSeqwareVersion)

generatedValue

public static String generatedValue(String key)

expandVariables

public static Map<String,String> expandVariables(Map<String,String> raw)

expandVariables

public static Map<String,String> expandVariables(Map<String,String> raw,
                                 Map<String,String> provided)

expandVariables

public static Map<String,String> expandVariables(Map<String,String> raw,
                                 Map<String,String> provided,
                                 boolean allowMissingVars)

iniString2Map
```
public static Map<String,String> iniString2Map(String iniString)
```
iniString2Map.

Parameters:
iniString - a String object.

Returns:
a Map object.

createWorkflowRunParameters

public static SortedSet<WorkflowRunParam> createWorkflowRunParameters(HashMap<String,String> map)
                                                               throws NumberFormatException

Convert what looks like a map of ini key-value pairs into a SortedSet of WorkflowRunParams

Parameters:: map -
Returns:
Throws:: NumberFormatException

Class MapTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VAR_RANDOM

VAR_DATE

VAR_DATETIME

VAR_TIMESTAMP

VAR_UUID

VAR_BUNDLE_DIR

LEGACY_VAR_RANDOM

LEGACY_VAR_DATE

LEGACY_VAR_BUNDLE_DIR

VAR_WORKFLOW_VERSION

Constructor Detail

MapTools

Method Detail

ini2Map

ini2RichMap

ini2Map

ini2Map

cli2Map

mapString2Int

provideBundleVersion

provideBundleDir

providedMap

generatedValue

expandVariables

expandVariables

expandVariables

iniString2Map

createWorkflowRunParameters