Package com.ibm.fhir.path

Class FHIRPathQuantityValue

java.lang.Object

com.ibm.fhir.path.FHIRPathAbstractNode

com.ibm.fhir.path.FHIRPathQuantityValue

All Implemented Interfaces:

FHIRPathNode, FHIRPathSystemValue, Comparable<FHIRPathNode>

public class FHIRPathQuantityValue
extends FHIRPathAbstractNode
implements FHIRPathSystemValue

A FHIRPathSystemValue that wraps a BigDecimal value and String unit

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FHIRPathQuantityValue.Builder

Field Summary

Fields inherited from class com.ibm.fhir.path.FHIRPathAbstractNode

children, name, path, type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FHIRPathQuantityValue(FHIRPathQuantityValue.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	accept(FHIRPathNodeVisitor visitor)	A method for accepting a FHIRPathNodeVisitor
FHIRPathQuantityValue	add(FHIRPathQuantityValue quantityValue)	Add this FHIRPathQuantityValue to another FHIRPathQuantityValue
static FHIRPathQuantityValue.Builder	builder(BigDecimal value, String unit)	Static factory method for creating builder instances from a BigDecimal value and String unit
int	compareTo(FHIRPathNode other)	Compare the quantity value wrapped by this FHIRPathQuantityValue to the parameter
boolean	equals(Object obj)	Indicates whether the BigDecimal value and String unit wrapped by this FHIRPathQuantityValue is equal the parameter (or its primitive value)
int	hashCode()
boolean	isComparableTo(FHIRPathNode other)	Indicates whether this FHIRPathQuantityValue is comparable to the parameter
boolean	isQuantityValue()	Indicates whether this FHIRPathSystemValue is type compatible with FHIRPathQuantityValue
static FHIRPathQuantityValue	quantityValue(Quantity quantity)	Static factory method for creating FHIRPathQuantityValue instances from a Quantity value
static FHIRPathQuantityValue	quantityValue(BigDecimal value, String unit)	Static factory method for creating FHIRPathQuantityValue instances from a BigDecimal value and String unit
FHIRPathQuantityValue	subtract(FHIRPathQuantityValue quantityValue)	Subtract another FHIRPathQuantityValue from this FHIRPathQuantityValue
FHIRPathQuantityValue.Builder	toBuilder()	Convert this FHIRPathNode instance into a FHIRPathNode.Builder instance
String	toString()
String	unit()	The String unit wrapped by this FHIRPathQuantityValue
BigDecimal	value()	The BigDecimal value wrapped by this FHIRPathQuantityValue

Methods inherited from class com.ibm.fhir.path.FHIRPathAbstractNode

as, children, descendants, getValue, hasValue, is, name, path, stream, type

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.path.FHIRPathNode

as, asElementNode, asResourceNode, asSystemValue, asTermServiceNode, asTypeInfoNode, children, descendants, getValue, is, isElementNode, isResourceNode, isTermServiceNode, isTypeInfoNode, name, path, stream, type

Methods inherited from interface com.ibm.fhir.path.FHIRPathSystemValue

asBooleanValue, asNumberValue, asQuantityValue, asStringValue, asTemporalValue, hasValue, isBooleanValue, isNumberValue, isStringValue, isSystemValue, isTemporalValue

Constructor Detail

FHIRPathQuantityValue

protected FHIRPathQuantityValue(FHIRPathQuantityValue.Builder builder)

Method Detail

isQuantityValue

public boolean isQuantityValue()

Description copied from interface: FHIRPathSystemValue

Indicates whether this FHIRPathSystemValue is type compatible with FHIRPathQuantityValue

Specified by:

isQuantityValue in interface FHIRPathSystemValue

Returns:

true if this FHIRPathSystemValue is type compatible with FHIRPathQuantityValue, otherwise false

value

public BigDecimal value()

The BigDecimal value wrapped by this FHIRPathQuantityValue

Returns:

the BigDecimal value wrapped by this FHIRPathQuantityValue

unit

public String unit()

The String unit wrapped by this FHIRPathQuantityValue

Returns:

the String unit wrapped by this FHIRPathQuantityValue

quantityValue

public static FHIRPathQuantityValue quantityValue(Quantity quantity)

Static factory method for creating FHIRPathQuantityValue instances from a Quantity value

Parameters:

quantity - the Quantity value

Returns:

a new FHIRPathQuantityValue instance

quantityValue

public static FHIRPathQuantityValue quantityValue(BigDecimal value,
                                                  String unit)

Static factory method for creating FHIRPathQuantityValue instances from a BigDecimal value and String unit

Parameters:

value - the BigDecimal value

unit - the String unit

Returns:

a new FHIRPathQuantityValue instance

toBuilder

public FHIRPathQuantityValue.Builder toBuilder()

Description copied from class: FHIRPathAbstractNode

Convert this FHIRPathNode instance into a FHIRPathNode.Builder instance

Specified by:

toBuilder in class FHIRPathAbstractNode

Returns:

a new FHIRPathNode.Builder instance containing the fields from this FHIRPathNode instance

builder

public static FHIRPathQuantityValue.Builder builder(BigDecimal value,
                                                    String unit)

Static factory method for creating builder instances from a BigDecimal value and String unit

Parameters:

value - the BigDecimal value

unit - the String unit

Returns:

a new builder for building FHIRPathQuantityValue instances

add

public FHIRPathQuantityValue add(FHIRPathQuantityValue quantityValue)

Add this FHIRPathQuantityValue to another FHIRPathQuantityValue

Parameters:

quantityValue - the other FHIRPathQuantityValue

Returns:

the result of adding this FHIRPathQuantityValue to another FHIRPathQuantityValue

subtract

public FHIRPathQuantityValue subtract(FHIRPathQuantityValue quantityValue)

Subtract another FHIRPathQuantityValue from this FHIRPathQuantityValue

Parameters:

quantityValue - the other FHIRPathQuantityValue

Returns:

the result of subtracting another FHIRPathQuantityValue from this FHIRPathQuantityValue

isComparableTo

public boolean isComparableTo(FHIRPathNode other)

Indicates whether this FHIRPathQuantityValue is comparable to the parameter

Specified by:

isComparableTo in interface FHIRPathNode

Parameters:

other - the other FHIRPathNode

Returns:

true if the parameter or its primitive value is a FHIRPathQuantityValue or a , otherwise false

compareTo

public int compareTo(FHIRPathNode other)

Compare the quantity value wrapped by this FHIRPathQuantityValue to the parameter

Specified by:

compareTo in interface Comparable<FHIRPathNode>

Parameters:

other - the other FHIRPathNode

Returns:

0 if the quantity value wrapped by this FHIRPathQuantityValue is equal to the parameter; a positive value if this FHIRPathQuantityValue is greater than the parameter; and a negative value if this FHIRPathQuantityValue is less than the parameter

equals

public boolean equals(Object obj)

Indicates whether the BigDecimal value and String unit wrapped by this FHIRPathQuantityValue is equal the parameter (or its primitive value)

Overrides:

equals in class Object

Parameters:

obj - the other Object

Returns:

true if the BigDecimal value and String unit wrapped by this FHIRPathQuantityValue node is equal the parameter (or its primitive value), otherwise false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

accept

public void accept(FHIRPathNodeVisitor visitor)

Description copied from interface: FHIRPathNode

A method for accepting a FHIRPathNodeVisitor

Specified by:

accept in interface FHIRPathNode

Parameters:

visitor - the FHIRPathNodeVisitor that this FHIRPathNode is accepting