BaseThresholdDefConfigWrapper (OpenNMS 2017.1.26 API)

java.lang.Object
- org.opennms.netmgt.threshd.BaseThresholdDefConfigWrapper

Direct Known Subclasses:

ExpressionConfigWrapper, ThresholdConfigWrapper
```
public abstract class BaseThresholdDefConfigWrapper
extends Object
```
Abstract BaseThresholdDefConfigWrapper class.

Author:

Jeff Gehlbach, Craig Miskell

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseThresholdDefConfigWrapper(Basethresholddef baseDef)
Constructor for BaseThresholdDefConfigWrapper.

Constructors
Modifier	Constructor and Description
`protected`	`BaseThresholdDefConfigWrapper(Basethresholddef baseDef)` Constructor for BaseThresholdDefConfigWrapper.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`abstract double`	`evaluate(Map<String,Double> values)` Evaluate the threshold expression/datasource in terms of the named values supplied, and return that value
`Basethresholddef`	`getBasethresholddef()` getBasethresholddef
`static BaseThresholdDefConfigWrapper`	`getConfigWrapper(Basethresholddef baseDef)` getConfigWrapper
`abstract String`	`getDatasourceExpression()` getDatasourceExpression
`Optional<String>`	`getDsLabel()` getDsLabel
`String`	`getDsType()` getDsType
`List<String>`	`getFilterDatasources()` Returns the names of the datasources required from the resource filters
`double`	`getRearm()` getRearm
`Optional<String>`	`getRearmedUEI()` getRearmedUEI
`abstract Collection<String>`	`getRequiredDatasources()` Returns the names of the datasources required to evaluate this threshold
`int`	`getTrigger()` getTrigger
`Optional<String>`	`getTriggeredUEI()` getTriggeredUEI
`ThresholdType`	`getType()` getType
`double`	`getValue()` getValue
`int`	`hashCode()`
`boolean`	`hasRearm()` hasRearm
`boolean`	`hasTrigger()` hasTrigger
`boolean`	`hasValue()` hasValue
`void`	`merge(BaseThresholdDefConfigWrapper threshold)` merge

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

- Constructor Detail
  - BaseThresholdDefConfigWrapper
```
protected BaseThresholdDefConfigWrapper(Basethresholddef baseDef)
```
    Constructor for BaseThresholdDefConfigWrapper.
    
    Parameters:
    
    baseDef - a Basethresholddef object.
- Method Detail
  - getConfigWrapper
```
public static BaseThresholdDefConfigWrapper getConfigWrapper(Basethresholddef baseDef)
                                                      throws ThresholdExpressionException
```
    getConfigWrapper
    
    Parameters:
    
    baseDef - a Basethresholddef object.
    
    Returns:
    
    a BaseThresholdDefConfigWrapper object.
    
    Throws:
    
    ThresholdExpressionException - if any.
  - getFilterDatasources
```
public List<String> getFilterDatasources()
```
    Returns the names of the datasources required from the resource filters
    
    Returns:
    
    Collection of the names of datasources
  - getDatasourceExpression
```
public abstract String getDatasourceExpression()
```
    getDatasourceExpression
    
    Returns:
    
    a descriptive string for the data source - typically either a data source name, or an expression of data source names
  - getRequiredDatasources
```
public abstract Collection<String> getRequiredDatasources()
```
    Returns the names of the datasources required to evaluate this threshold
    
    Returns:
    
    Collection of the names of datasources
  - evaluate
```
public abstract double evaluate(Map<String,Double> values)
                         throws ThresholdExpressionException
```
    Evaluate the threshold expression/datasource in terms of the named values supplied, and return that value
    
    Parameters:
    
    values - named values to use in evaluating the expression/data source
    
    Returns:
    
    the value of the evaluated expression
    
    Throws:
    
    ThresholdExpressionException - if any.
  - getDsType
```
public String getDsType()
```
    getDsType
    
    Returns:
    
    a String object.
  - getDsLabel
```
public Optional<String> getDsLabel()
```
    getDsLabel
    
    Returns:
    
    a String object.
  - getRearm
```
public double getRearm()
```
    getRearm
    
    Returns:
    
    a double.
  - getTrigger
```
public int getTrigger()
```
    getTrigger
    
    Returns:
    
    a int.
  - getType
```
public ThresholdType getType()
```
    getType
    
    Returns:
    
    a String object.
  - getValue
```
public double getValue()
```
    getValue
    
    Returns:
    
    a double.
  - hasRearm
```
public boolean hasRearm()
```
    hasRearm
    
    Returns:
    
    a boolean.
  - hasTrigger
```
public boolean hasTrigger()
```
    hasTrigger
    
    Returns:
    
    a boolean.
  - hasValue
```
public boolean hasValue()
```
    hasValue
    
    Returns:
    
    a boolean.
  - getTriggeredUEI
```
public Optional<String> getTriggeredUEI()
```
    getTriggeredUEI
    
    Returns:
    
    a String object.
  - getRearmedUEI
```
public Optional<String> getRearmedUEI()
```
    getRearmedUEI
    
    Returns:
    
    a String object.
  - getBasethresholddef
```
public Basethresholddef getBasethresholddef()
```
    getBasethresholddef
    
    Returns:
    
    a Basethresholddef object.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - merge
```
public void merge(BaseThresholdDefConfigWrapper threshold)
```
    merge
    
    Parameters:
    
    threshold - a BaseThresholdDefConfigWrapper object.

Class BaseThresholdDefConfigWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseThresholdDefConfigWrapper

Method Detail

getConfigWrapper

getFilterDatasources

getDatasourceExpression

getRequiredDatasources

evaluate

getDsType

getDsLabel

getRearm

getTrigger

getType

getValue

hasRearm

hasTrigger

hasValue

getTriggeredUEI

getRearmedUEI

getBasethresholddef

equals

hashCode

merge