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

Class JacksonInnerQuantity

java.lang.Object

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

public class JacksonInnerQuantity
extends java.lang.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	Description
JacksonInnerQuantity()	Constructor.
JacksonInnerQuantity(java.math.BigDecimal amount, java.math.BigDecimal upperBound, java.math.BigDecimal lowerBound, java.lang.String unit)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.math.BigDecimal	getAmount()	Returns the numeric value.
java.lang.String	getAmountAsString()
java.lang.String	getJsonUnit()	Returns the string to use for the "unit" field in JSON.
java.math.BigDecimal	getLowerBound()	Returns the lower bound.
java.lang.String	getLowerBoundAsString()
java.lang.String	getUnit()	Returns the unit to be used, converting JSON-specific encodings of "no unit" to the one used in WDTK.
java.math.BigDecimal	getUpperBound()	Returns the upper bound.
java.lang.String	getUpperBoundAsString()
void	setAmount(java.math.BigDecimal amount)	Sets the numerical value to the given value.
void	setJsonUnit(java.lang.String unit)	Sets the lower bound to the given value.
void	setLowerBound(java.math.BigDecimal lowerBound)	Sets the lower bound to the given value.
void	setUpperBound(java.math.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(java.math.BigDecimal amount,
                            java.math.BigDecimal upperBound,
                            java.math.BigDecimal lowerBound,
                            java.lang.String unit)

Constructor. The unit given here is a unit string as used in WDTK, with the empty string meaning "no unit".

Parameters:

amount -

upperBound -

lowerBound -

unit -

Method Detail

getAmount

public java.math.BigDecimal getAmount()

Returns the numeric value.

Returns:

the value

See Also:

QuantityValue.getNumericValue()

setAmount

public void setAmount(java.math.BigDecimal amount)

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

Parameters:

amount - new value

getUpperBound

public java.math.BigDecimal getUpperBound()

Returns the upper bound.

Returns:

the upper bound

See Also:

QuantityValue.getUpperBound()

setUpperBound

public void setUpperBound(java.math.BigDecimal upperBound)

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

Parameters:

upperBound - new value

getLowerBound

public java.math.BigDecimal getLowerBound()

Returns the lower bound.

Returns:

the lower bound

See Also:

QuantityValue.getLowerBound()

setLowerBound

public void setLowerBound(java.math.BigDecimal lowerBound)

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

Parameters:

lowerBound - bound new value

getAmountAsString

public java.lang.String getAmountAsString()

getUpperBoundAsString

public java.lang.String getUpperBoundAsString()

getLowerBoundAsString

public java.lang.String getLowerBoundAsString()

getJsonUnit

public java.lang.String getJsonUnit()

Returns the string to use for the "unit" field in JSON. The value "1" is used to denote "no unit"; otherwise an IRI is used to denote specific units.

Returns:

unit string

setJsonUnit

public void setJsonUnit(java.lang.String unit)

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

Parameters:

unit - new unit value, the string "1" is used in JSON to denote that there is no unit for a quantity

getUnit

public java.lang.String getUnit()

Returns the unit to be used, converting JSON-specific encodings of "no unit" to the one used in WDTK.

Returns:

unit string

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object