InequalityNumberValue (Protempa Framework 4.0-Alpha-20 API)

java.lang.Object
- org.protempa.proposition.value.InequalityNumberValue

All Implemented Interfaces:

Serializable, NumericalValue, OrderedValue, Value, ValueVisitable
```
public final class InequalityNumberValue
extends Object
implements NumericalValue, Serializable
```
Represents a test result that is outside of the reportable range of the test and thus is reported prefixed with a greater than or less than sign. They are comparable to actual NumberValues.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`InequalityNumberValue(ValueComparator comparator, BigDecimal val)` Creates a new `InequalityNumberValue` with the given comparator and value.
`InequalityNumberValue(ValueComparator comparator, double val)` Creates a new `InequalityNumberValue` with the given comparator and value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(ValueVisitor valueVisitor)` Performs some processing on a value.
`InequalityNumberValueBuilder`	`asBuilder()`
`ValueComparator`	`compare(Value d2)` Compares this value and another numerically, or checks this value for membership in a value list.
`double`	`doubleValue()` Gets this value as a double.
`boolean`	`equals(Object obj)`
`String`	`format(Format format)` Returns a string representing this value, formatted by the provided `Format`.
`BigDecimal`	`getBigDecimal()` Gets this value as a `BigDecimal`.
`ValueComparator`	`getComparator()`
`String`	`getFormatted()` Returns a string representing this value for display purposes.
`ValueComparator`	`getInequality()`
`Number`	`getNumber()` Gets this value as a number.
`NumberValue`	`getNumberValue()` Gets the number value component of this numerical value.
`ValueType`	`getType()` Returns this object's type, guaranteed not `null`.
`int`	`hashCode()`
`static InequalityNumberValue`	`parse(String str)` Parses a number with an inequality from a string, e.g., "> 100".
`InequalityNumberValue`	`replace()` Returns a value from a cache that is equal to this one, if such a value exists.
`String`	`toString()`

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

- Constructor Detail
  - InequalityNumberValue
```
public InequalityNumberValue(ValueComparator comparator,
                             double val)
```
    Creates a new InequalityNumberValue with the given comparator and value.
    
    Parameters:
    
    comparator - a ValueComparator. If null, the default comparator is used (ValueComparator.EQUAL_TO).
    
    val - a double.
  - InequalityNumberValue
```
public InequalityNumberValue(ValueComparator comparator,
                             BigDecimal val)
```
    Creates a new InequalityNumberValue with the given comparator and value.
    
    Parameters:
    
    comparator - a ValueComparator. If null, the default comparator is used (ValueComparator.EQUAL_TO).
    
    val - a BigDecimal. If null, a value of 0 is used.
- Method Detail
  - parse
```
public static InequalityNumberValue parse(String str)
```
    Parses a number with an inequality from a string, e.g., "> 100".
    
    Parameters:
    
    str - a string representing a number prefixed with an inequality.
    
    Returns:
    
    a InequalityNumberValue, or null if no such number was found.
  - replace
```
public InequalityNumberValue replace()
```
    Description copied from interface: Value
    
    Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.
    
    Specified by:
    
    replace in interface Value
    
    Returns:
    
    a Value for which #equals(Value) is true.
  - getNumber
```
public Number getNumber()
```
    Description copied from interface: NumericalValue
    
    Gets this value as a number.
    
    Specified by:
    
    getNumber in interface NumericalValue
    
    Returns:
    
    a Number.
  - getBigDecimal
```
public BigDecimal getBigDecimal()
```
    Description copied from interface: NumericalValue
    
    Gets this value as a BigDecimal.
    
    Specified by:
    
    getBigDecimal in interface NumericalValue
    
    Returns:
    
    a BigDecimal.
  - doubleValue
```
public double doubleValue()
```
    Description copied from interface: NumericalValue
    
    Gets this value as a double.
    
    Specified by:
    
    doubleValue in interface NumericalValue
    
    Returns:
    
    a double.
  - getInequality
```
public ValueComparator getInequality()
```
  - getFormatted
```
public String getFormatted()
```
    Description copied from interface: Value
    
    Returns a string representing this value for display purposes.
    
    Specified by:
    
    getFormatted in interface Value
    
    Returns:
    
    a String. Guaranteed not null.
  - format
```
public String format(Format format)
```
    Description copied from interface: Value
    
    Returns a string representing this value, formatted by the provided Format.
    
    Specified by:
    
    format in interface Value
    
    Parameters:
    
    format - a Format. Passing in a null will result in the same behavior as Value.getFormatted().
    
    Returns:
    
    a String.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getComparator
```
public ValueComparator getComparator()
```
  - getType
```
public ValueType getType()
```
    Description copied from interface: Value
    
    Returns this object's type, guaranteed not null.
    
    Specified by:
    
    getType in interface Value
    
    Returns:
    
    a ValueType.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compare
```
public ValueComparator compare(Value d2)
```
    Compares this value and another numerically, or checks this value for membership in a value list.
    
    Specified by:
    
    compare in interface Value
    
    Parameters:
    
    o - a Value.
    
    Returns:
    
    If the provided value is a NumericalValue, returns ValueComparator.GREATER_THAN, ValueComparator.LESS_THAN or ValueComparator.EQUAL_TO depending on whether this value is numerically greater than, less than or equal to the value provided as argument. IF the provided value is a ValueList, returns ValueComparator.IN if this object is a member of the value list, or ValueComparator.NOT_IN if this object is not a member. Otherwise, returns ValueComparator.UNKNOWN.
  - accept
```
public void accept(ValueVisitor valueVisitor)
```
    Description copied from interface: ValueVisitable
    
    Performs some processing on a value.
    
    Specified by:
    
    accept in interface ValueVisitable
  - getNumberValue
```
public NumberValue getNumberValue()
```
    Description copied from interface: NumericalValue
    
    Gets the number value component of this numerical value.
    
    Specified by:
    
    getNumberValue in interface NumericalValue
    
    Returns:
    
    a NumberValue.
  - asBuilder
```
public InequalityNumberValueBuilder asBuilder()
```
    Specified by:
    
    asBuilder in interface NumericalValue
    
    Specified by:
    
    asBuilder in interface OrderedValue
    
    Specified by:
    
    asBuilder in interface Value

Class InequalityNumberValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InequalityNumberValue

InequalityNumberValue

Method Detail

parse

replace

getNumber

getBigDecimal

doubleValue

getInequality

getFormatted

format

toString

getComparator

getType

equals

hashCode

compare

accept

getNumberValue

asBuilder