org.agmip.ace.util

Class AcePathfinderUtil

java.lang.Object

org.agmip.ace.util.AcePathfinderUtil

public class AcePathfinderUtil
extends Object

A collection of utilities to interact with the AcePathfinder.

AcePathfinderUtil

is a collection of static methods used to interact with the AcePathfinder singleton. The path, for the purposes of this class, is formated as:

a@b!c,a@b!c,...

• a - nested bucket(s) seperated by

  :

  [

  HashMap

  ]
• b - series data container [

  ArrayList

  ]
• c - event-based series data record [

  <String,String> = <"event",c>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcePathfinderUtil.PathType

Constructor Summary

Constructors

Constructor and Description
AcePathfinderUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getEventDateVar(String event, String var) Renames a date variable from an event
static AcePathfinder	getInstance()
static String	getPathOr(HashMap<String,Object> map, String var, String alternatePath)
static AcePathfinderUtil.PathType	getVariableType(String var) Returns the general section of this variable (weather, soil, experiment).
static void	insertValue(HashMap m, String var, String val) Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.
static void	insertValue(HashMap m, String var, String val, boolean eventAppendMode) Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.
static void	insertValue(HashMap m, String var, String val, String path) Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.
static void	insertValue(HashMap m, String var, String val, String path, boolean eventAppendMode) Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.
static boolean	isDate(String var) Returns if the variable is a date.
static void	newRecord(HashMap m, String path) Creates a new record in a series, such as daily weather records, soil layers, etc.
static String	setEventDateVar(String var, boolean isEvent) Renames a date variable for an event
static HashMap	traverseToPoint(HashMap m, String p) A helper method to help traverse to a certain point in the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

AcePathfinderUtil

public AcePathfinderUtil()

Method Detail

getInstance

public static AcePathfinder getInstance()

getVariableType

public static AcePathfinderUtil.PathType getVariableType(String var)

Returns the general section of this variable (weather, soil, experiment).

Parameters:

var - Variable to lookup

isDate

public static boolean isDate(String var)

Returns if the variable is a date.

Parameters:

var - Variable to check

insertValue

public static void insertValue(HashMap m,
               String var,
               String val)

Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.

Parameters:

m - the HashMap to add the variable to.

var - Variable to lookup

val - the value to insert into the HashMap

insertValue

public static void insertValue(HashMap m,
               String var,
               String val,
               boolean eventAppendMode)

Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.

Parameters:

m - the HashMap to add the variable to.

var - Variable to lookup

val - the value to insert into the HashMap

eventAppendMode - True for add variable into last same type event; False for add to last event without type check

insertValue

public static void insertValue(HashMap m,
               String var,
               String val,
               String path)

Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.

Parameters:

m - the HashMap to add the variable to.

var - the variable to lookup in the AcePathfinder

val - the value to insert into the HashMap

path - use a custom path vs. a lookup path, useful if dealing with custom variables

insertValue

public static void insertValue(HashMap m,
               String var,
               String val,
               String path,
               boolean eventAppendMode)

Inserts the variable in the appropriate place in a HashMap, according to the AcePathfinder.

Parameters:

m - the HashMap to add the variable to.

var - the variable to lookup in the AcePathfinder

val - the value to insert into the HashMap

path - use a custom path vs. a lookup path, useful if dealing with custom variables

eventAppendMode - True for add variable into last same type event; False for add to last event without type check

newRecord

public static void newRecord(HashMap m,
             String path)

Creates a new record in a series, such as daily weather records, soil layers, etc. If the multi-line dataset space is not already in the

m

parameter, it will be created.

Parameters:

m - The HashMap to be modified.

path - The path to lookup and see if a multi-line record is supported for this field.

traverseToPoint

public static HashMap traverseToPoint(HashMap m,
                      String p)

A helper method to help traverse to a certain point in the map.

Parameters:

m - Map to traverse

p - Path to traverse to

Returns:

A reference to the point in the map.

getPathOr

public static String getPathOr(HashMap<String,Object> map,
               String var,
               String alternatePath)

setEventDateVar

public static String setEventDateVar(String var,
                     boolean isEvent)

Renames a date variable for an event

getEventDateVar

public static String getEventDateVar(String event,
                     String var)

Renames a date variable from an event