com.illcode.hl7

Class Segment.FieldValue

java.lang.Object

com.illcode.hl7.Segment.FieldValue

Enclosing class:

Segment

public static class Segment.FieldValue
extends java.lang.Object

The value of a field (scalar or composite). The value is either text contained in the node itself (if it is a field with no components, or a component with no subcomponents, or is a subcomponent), or it is the list of the values of its children.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Segment.FieldValue>	children Sub-values of this FieldValue.
java.lang.String	value Scalar value of this FieldValue.

Constructor Summary

Constructors

Constructor and Description
Segment.FieldValue() Construct a null-value FieldValue
Segment.FieldValue(java.util.List<Segment.FieldValue> children) Construct a composite FieldValue
Segment.FieldValue(java.lang.String value) Construct a scalar FieldValue (no children)

Method Summary

Methods

Modifier and Type	Method and Description
static Segment.FieldValue	composite(java.lang.Object... vals) Create a composite FieldValue, whose children are passed as arguments.
static Segment.FieldValue	copyOf(Segment.FieldValue v) Returns a new FieldValue that is a deep copy of the given argument.
static Segment.FieldValue	indexed(java.lang.Object... indexedVals) Creates and returns a composite FieldValue whose children are specified by the indexedVals argument as a sequence of index, value pairs.
boolean	isScalar() Returns true if this is a scalar FieldValue, i.e.
static Segment.FieldValue	scalar(java.lang.String value) Create and return a scalar FieldValue, whose String value is given as an argument.

Methods inherited from class java.lang.Object

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

Field Detail

value

public java.lang.String value

Scalar value of this FieldValue. May be null if the FieldValue has a null-value.

children

public java.util.List<Segment.FieldValue> children

Sub-values of this FieldValue. Null if the value is scalar.

Constructor Detail

Segment.FieldValue

public Segment.FieldValue()

Construct a null-value FieldValue

Segment.FieldValue

public Segment.FieldValue(java.lang.String value)

Construct a scalar FieldValue (no children)

Parameters:

value - textual value, or null.

Segment.FieldValue

public Segment.FieldValue(java.util.List<Segment.FieldValue> children)

Construct a composite FieldValue

Parameters:

children - (sub)components of the field value

Method Detail

isScalar

public boolean isScalar()

Returns true if this is a scalar FieldValue, i.e. that is has no children.

copyOf

public static Segment.FieldValue copyOf(Segment.FieldValue v)

Returns a new FieldValue that is a deep copy of the given argument.

scalar

public static Segment.FieldValue scalar(java.lang.String value)

Create and return a scalar FieldValue, whose String value is given as an argument.

composite

public static Segment.FieldValue composite(java.lang.Object... vals)

Create a composite FieldValue, whose children are passed as arguments.

Parameters:

vals - String arguments will be converted to scalar FieldValueS, while FieldValue arguments will be used as-is. All other types will be converted to null-value FieldValueS.

Returns:

a new composite FieldValue

indexed

public static Segment.FieldValue indexed(java.lang.Object... indexedVals)

Creates and returns a composite FieldValue whose children are specified by the indexedVals argument as a sequence of index, value pairs. For instance,

FieldValue v = indexed(2, "Hello",
                           5, composite("Sub1", "Sub2"));
 

yields a composite FieldValue with five children: the second child being a scalar with value "Hello", the fifth child a composite with two children (themselves scalars), and the first, third, and fourth children having null values. A values may be given as a String, in which case it's wrapped into a scalar FieldValue, or as a FieldValue, in which case it's used unchanged.
This method is useful for constructing field values to be passed to Segment.addFieldValue(int, com.illcode.hl7.Segment.FieldValue) when programmatically assembling HL7 messages.

Parameters:

indexedVals - index,value pairs

Returns:

composite FieldValue