org.ensembl.hive.ParamContainer Class Reference

Public Member Functions
	ParamContainer (Map< String, Object > unsubParameters)
Object	getParam (String paramName)
Map< String, Object >	getParams ()
Map< String, Object >	getUnsubParameters ()
boolean	hasParam (String paramName)
void	setParam (String paramName, Object value)

Detailed Description

Class for handling eHive parameter expansions. Does not currently support code evaluation in the same way Perl and Python do

Author

dstaines

Definition at line 37 of file ParamContainer.java.

Constructor & Destructor Documentation

ParamContainer()

org.ensembl.hive.ParamContainer.ParamContainer ( Map< String, Object >  unsubParameters )

inline

Definition at line 46 of file ParamContainer.java.

Member Function Documentation

getParam()

Object org.ensembl.hive.ParamContainer.getParam ( String  paramName )

inline

Getter. Performs the parameter substitution and return the value of a parameter

Parameters

paramName

The name of the parameter

Returns

The (substituted) value of this parameter

Definition at line 56 of file ParamContainer.java.

Here is the caller graph for this function:

getParams()

Map<String, Object> org.ensembl.hive.ParamContainer.getParams ( )

inline

Definition at line 78 of file ParamContainer.java.

Here is the caller graph for this function:

getUnsubParameters()

Map<String, Object> org.ensembl.hive.ParamContainer.getUnsubParameters ( )

inline

Definition at line 82 of file ParamContainer.java.

Here is the caller graph for this function:

hasParam()

boolean org.ensembl.hive.ParamContainer.hasParam ( String  paramName )

inline

Returns a boolean. It checks both substituted and unsubstituted parameters

Parameters

paramName

The name of the parameter

Returns

Whether there is a parameter with this name

Definition at line 93 of file ParamContainer.java.

setParam()

void org.ensembl.hive.ParamContainer.setParam ( String  paramName, Object  value  )

inline

Setter. Set the new value of a parameter

Parameters

paramName	The name of the parameter
value	Its new value

Definition at line 152 of file ParamContainer.java.

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• src/main/java/org/ensembl/hive/ParamContainer.java