GMutableIntervalDate (Genius 1.13.1 API)

java.lang.Object
- fr.cnes.genius.interval.GMutableIntervalDate

```
public class GMutableIntervalDate
extends Object
```
Class defining a mutable interval of values to test values against. The interval is composed of two ranges of values [okMinValue, okMaxValue] and [warnMinValue, warnMaxValue], fully configurable, and the test algorithm is the following: if (okMinValue <= value <= okMaxValue) then OK else if (warnMinValue <= value <= warnMaxValue) then WARN else ERROR end if The interval limits can be, independently, inclusive or exclusive, so the comparisons are "<=" and "=>" or just "<" and ">".

Author:

ffsm

Constructor Summary

Constructors
Constructor and Description
`GMutableIntervalDate(GIntervalDate interval)` Constructor copy from an immutable GInterval object.
`GMutableIntervalDate(GMutableIntervalDate interval)` Constructor copy from a mutable GMutableInterval object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GIntervalDate`	`getGInterval()` Getter of an immutable GInterval object.
`Date`	`getOkMax()` Get the absolute maximum value of the OK zone.
`GIntervalAbstract.Rule`	`getOkMaxRule()` Get the rule applying to the absolute maximum of the OK zone.
`Date`	`getOkMin()` Get the absolute minimum value of the OK zone.
`GIntervalAbstract.Rule`	`getOkMinRule()` Get the rule applying to the absolute minimum of the OK zone.
`Date`	`getWarnMax()` Get the absolute maximum value of the WARN zone.
`GIntervalAbstract.Rule`	`getWarnMaxRule()` Get the rule applying to the absolute maximum of the WARN zone.
`Date`	`getWarnMin()` Get the absolute minimum value of the WARN zone.
`GIntervalAbstract.Rule`	`getWarnMinRule()` Get the rule applying to the absolute minimum of the WARN zone.
`boolean`	`isWarnCheckEnabled()` Get the flag for the WARN zone.
`void`	`removeWarnCheck()` Removes the WARN zone of the interval.
`void`	`setGInterval(GIntervalDate interval)` Setter from an immutable GInterval object.
`void`	`setOkMax(Date okMax)` Set the absolute maximum value of the OK zone.
`void`	`setOkMax(String okMax)` Set the absolute maximum value of the OK zone.
`void`	`setOkMaxRule(GIntervalAbstract.Rule okMaxRule)` Set the rule applying to the absolute maximum of the OK zone.
`void`	`setOkMin(Date okMin)` Set the absolute minimum value of the OK zone.
`void`	`setOkMin(String okMin)` Set the absolute minimum value of the OK zone.
`void`	`setOkMinRule(GIntervalAbstract.Rule okMinRule)` Set the rule applying to the absolute minimum of the OK zone.
`void`	`setWarnMax(Date warnMax)` Set the absolute maximum value of the WARN zone.
`void`	`setWarnMax(String warnMax)` Set the absolute maximum value of the WARN zone.
`void`	`setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule)` Set the rule applying to the absolute maximum of the WARN zone.
`void`	`setWarnMin(Date warnMin)` Set the absolute minimum value of the WARN zone.
`void`	`setWarnMin(String warnMin)` Set the absolute minimum value of the WARN zone.
`void`	`setWarnMinRule(GIntervalAbstract.Rule warnMinRule)` Set the rule applying to the absolute minimum of the WARN zone.

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

- Constructor Detail
  - GMutableIntervalDate
```
public GMutableIntervalDate(GIntervalDate interval)
```
    Constructor copy from an immutable GInterval object.
    
    Parameters:
    
    interval - interval to copy.
  - GMutableIntervalDate
```
public GMutableIntervalDate(GMutableIntervalDate interval)
```
    Constructor copy from a mutable GMutableInterval object.
    
    Parameters:
    
    interval - interval to copy.
- Method Detail
  - setGInterval
```
public void setGInterval(GIntervalDate interval)
```
    Setter from an immutable GInterval object.
    
    Parameters:
    
    interval - immutable interval to copy.
  - getGInterval
```
public GIntervalDate getGInterval()
```
    Getter of an immutable GInterval object.
    
    Returns:
    
    immutable interval copy.
  - getOkMin
```
public Date getOkMin()
```
    Get the absolute minimum value of the OK zone.
    
    Returns:
    
    the absolute minimum value of the OK zone.
  - getOkMax
```
public Date getOkMax()
```
    Get the absolute maximum value of the OK zone.
    
    Returns:
    
    the absolute maximum value of the OK zone.
  - getOkMinRule
```
public GIntervalAbstract.Rule getOkMinRule()
```
    Get the rule applying to the absolute minimum of the OK zone.
    
    Returns:
    
    the rule applying to the absolute minimum of the OK zone.
  - getOkMaxRule
```
public GIntervalAbstract.Rule getOkMaxRule()
```
    Get the rule applying to the absolute maximum of the OK zone.
    
    Returns:
    
    the rule applying to the absolute maximum of the OK zone.
  - getWarnMin
```
public Date getWarnMin()
```
    Get the absolute minimum value of the WARN zone.
    
    Returns:
    
    the absolute minimum value of the WARN zone.
  - getWarnMax
```
public Date getWarnMax()
```
    Get the absolute maximum value of the WARN zone.
    
    Returns:
    
    the absolute maximum value of the WARN zone.
  - getWarnMinRule
```
public GIntervalAbstract.Rule getWarnMinRule()
```
    Get the rule applying to the absolute minimum of the WARN zone.
    
    Returns:
    
    the rule applying to the absolute minimum of the WARN zone.
  - getWarnMaxRule
```
public GIntervalAbstract.Rule getWarnMaxRule()
```
    Get the rule applying to the absolute maximum of the WARN zone.
    
    Returns:
    
    the rule applying to the absolute maximum of the WARN zone.
  - isWarnCheckEnabled
```
public boolean isWarnCheckEnabled()
```
    Get the flag for the WARN zone.
    
    Returns:
    
    the flag to know if the interval has a WARN zone fully defined.
  - setOkMin
```
public void setOkMin(Date okMin)
```
    Set the absolute minimum value of the OK zone.
    
    Parameters:
    
    okMin - the absolute minimum value of the OK zone.
  - setOkMin
```
public void setOkMin(String okMin)
              throws GDateFieldException
```
    Set the absolute minimum value of the OK zone.
    
    Parameters:
    
    okMin - the absolute minimum value of the OK zone.
    
    Throws:
    
    GDateFieldException - in case the date can not be parsed.
  - setOkMax
```
public void setOkMax(Date okMax)
```
    Set the absolute maximum value of the OK zone.
    
    Parameters:
    
    okMax - the absolute maximum value of the OK zone.
  - setOkMax
```
public void setOkMax(String okMax)
              throws GDateFieldException
```
    Set the absolute maximum value of the OK zone.
    
    Parameters:
    
    okMax - the absolute maximum value of the OK zone.
    
    Throws:
    
    GDateFieldException - in case the date can not be parsed.
  - setOkMinRule
```
public void setOkMinRule(GIntervalAbstract.Rule okMinRule)
```
    Set the rule applying to the absolute minimum of the OK zone.
    
    Parameters:
    
    okMinRule - the rule applying to the absolute minimum of the OK zone.
  - setOkMaxRule
```
public void setOkMaxRule(GIntervalAbstract.Rule okMaxRule)
```
    Set the rule applying to the absolute maximum of the OK zone.
    
    Parameters:
    
    okMaxRule - the rule applying to the absolute maximum of the OK zone.
  - setWarnMin
```
public void setWarnMin(Date warnMin)
```
    Set the absolute minimum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.
    
    Parameters:
    
    warnMin - the absolute minimum value of the WARN zone.
  - setWarnMin
```
public void setWarnMin(String warnMin)
                throws GDateFieldException
```
    Set the absolute minimum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.
    
    Parameters:
    
    warnMin - the absolute minimum value of the WARN zone.
    
    Throws:
    
    GDateFieldException - in case the date can not be parsed.
  - setWarnMax
```
public void setWarnMax(Date warnMax)
```
    Set the absolute maximum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.
    
    Parameters:
    
    warnMax - the absolute maximum value of the WARN zone.
  - setWarnMax
```
public void setWarnMax(String warnMax)
                throws GDateFieldException
```
    Set the absolute maximum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.
    
    Parameters:
    
    warnMax - the absolute maximum value of the WARN zone.
    
    Throws:
    
    GDateFieldException - in case the date can not be parsed.
  - setWarnMinRule
```
public void setWarnMinRule(GIntervalAbstract.Rule warnMinRule)
```
    Set the rule applying to the absolute minimum of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.
    
    Parameters:
    
    warnMinRule - the rule applying to the absolute minimum of the WARN zone.
  - setWarnMaxRule
```
public void setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule)
```
    Set the rule applying to the absolute maximum of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.
    
    Parameters:
    
    warnMaxRule - the rule applying to the absolute maximum of the WARN zone.
  - removeWarnCheck
```
public void removeWarnCheck()
```
    Removes the WARN zone of the interval.

Class GMutableIntervalDate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GMutableIntervalDate

GMutableIntervalDate

Method Detail

setGInterval

getGInterval

getOkMin

getOkMax

getOkMinRule

getOkMaxRule

getWarnMin

getWarnMax

getWarnMinRule

getWarnMaxRule

isWarnCheckEnabled

setOkMin

setOkMin

setOkMax

setOkMax

setOkMinRule

setOkMaxRule

setWarnMin

setWarnMin

setWarnMax

setWarnMax

setWarnMinRule

setWarnMaxRule

removeWarnCheck