org.wikidata.wdtk.datamodel.json.jackson.datavalues

Class JacksonInnerQuantity

java.lang.Object

org.wikidata.wdtk.datamodel.json.jackson.datavalues.JacksonInnerQuantity

public class JacksonInnerQuantity
extends Object

Helper object that represents the JSON object structure that is used to represent values of type JacksonValue.JSON_VALUE_TYPE_QUANTITY.

Author:

Fredo Erxleben

Constructor Summary

Constructors

Constructor and Description
JacksonInnerQuantity() Constructor.
JacksonInnerQuantity(BigDecimal amount, BigDecimal upperBound, BigDecimal lowerBound) TODO Review the utility of this constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
BigDecimal	getAmount() Returns the numeric value.
String	getAmountAsString()
BigDecimal	getLowerBound() Returns the lower bound.
String	getLowerBoundAsString()
String	getUnit() Returns the string to use for the "unit" field in JSON.
BigDecimal	getUpperBound() Returns the upper bound.
String	getUpperBoundAsString()
void	setAmount(BigDecimal amount) Sets the numerical value to the given value.
void	setLowerBound(BigDecimal lowerBound) Sets the lower bound to the given value.
void	setUpperBound(BigDecimal upperBound) Sets the upper bound to the given value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JacksonInnerQuantity

public JacksonInnerQuantity()

Constructor. Creates an empty object that can be populated during JSON deserialization. Should only be used by Jackson for this very purpose.

JacksonInnerQuantity

public JacksonInnerQuantity(BigDecimal amount,
                    BigDecimal upperBound,
                    BigDecimal lowerBound)

TODO Review the utility of this constructor.

Parameters:

amount -

upperBound -

lowerBound -

Method Detail

getAmount

public BigDecimal getAmount()

Returns the numeric value.

Returns:

the value

See Also:

QuantityValue.getNumericValue()

setAmount

public void setAmount(BigDecimal amount)

Sets the numerical value to the given value. Only for use by Jackson during deserialization.

Parameters:

amount - new value

getUpperBound

public BigDecimal getUpperBound()

Returns the upper bound.

Returns:

the upper bound

See Also:

QuantityValue.getUpperBound()

setUpperBound

public void setUpperBound(BigDecimal upperBound)

Sets the upper bound to the given value. Only for use by Jackson during deserialization.

Parameters:

upperBound - new value

getLowerBound

public BigDecimal getLowerBound()

Returns the lower bound.

Returns:

the lower bound

See Also:

QuantityValue.getLowerBound()

setLowerBound

public void setLowerBound(BigDecimal lowerBound)

Sets the lower bound to the given value. Only for use by Jackson during deserialization.

Parameters:

lower - bound new value

getAmountAsString

public String getAmountAsString()

getUpperBoundAsString

public String getUpperBoundAsString()

getLowerBoundAsString

public String getLowerBoundAsString()

getUnit

public String getUnit()

Returns the string to use for the "unit" field in JSON. Units of mesurement are not supported yet, so this is a constant value of 1.

Returns:

unit string

equals

public boolean equals(Object o)

Overrides:

equals in class Object