ParameterWrapper (Sherlock 0.5.61 API)

java.lang.Object
- uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

public class ParameterWrapper
extends java.lang.Object

The wrapper that manages template parameters

Constructor Summary

Constructors
Constructor	Description
`ParameterWrapper(TParameter tParameter, java.util.Map<java.lang.String,AdjustableParameterObj> map)`	Initialise the wrapper class using the parameter entity

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDisplayName()`	Get the display name for this parameter
`TParameter`	`getParameter()`	Get the database parameter entity
`AdjustableParameterObj`	`getParameterObj()`	Get the adjustable parameter object
`void`	`setParameter(TParameter tParameter)`	Set the database parameter entity for this wrapper
`void`	`setParameterObj(AdjustableParameterObj parameterObj)`	Set the adjustable parameter object

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

- Constructor Detail
  - ParameterWrapper
```
public ParameterWrapper(TParameter tParameter,
                        java.util.Map<java.lang.String,AdjustableParameterObj> map)
                 throws ParameterNotFound
```
    Initialise the wrapper class using the parameter entity
    
    Parameters:
    
    tParameter - the parameter to manage
    
    map - the adjustable parameter map for the detector
    
    Throws:
    
    ParameterNotFound - if the parameter was not found in the map
- Method Detail
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Get the display name for this parameter
    
    Returns:
    
    the display name
  - getParameter
```
public TParameter getParameter()
```
    Get the database parameter entity
    
    Returns:
    
    the parameter
  - setParameter
```
public void setParameter(TParameter tParameter)
```
    Set the database parameter entity for this wrapper
    
    Parameters:
    
    tParameter - the new parameter
  - getParameterObj
```
public AdjustableParameterObj getParameterObj()
```
    Get the adjustable parameter object
    
    Returns:
    
    the parameter object
  - setParameterObj
```
public void setParameterObj(AdjustableParameterObj parameterObj)
```
    Set the adjustable parameter object
    
    Parameters:
    
    parameterObj - the new object