com.merge.HL7.v240.fields
Class HL7FieldCQ

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v240.fields.HL7FieldCQ

public class HL7FieldCQ
extends HL7Field

CQ cannot be legally expressed when embedded within another data type. Its use is constrained to a segment field.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldCQ()
Creates an empty HL7 CQ type field object.

Method Summary

java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getQuantity() Gets the Quantity component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
HL7FieldCE	getUnits() Gets the Units component of this field.
java.lang.String	getUnitsValue() Gets the Units component of this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isQuantityEmpty() Tells whether the Quantity component has been specified.
boolean	isQuantityNull() Tells whether the Quantity component has a has Null value as defined by HL7.
boolean	isUnitsEmpty() Tells whether the Units component has been specified.
boolean	isUnitsNull() Tells whether the Units component has a has Null value as defined by HL7.
void	setQuantity(java.lang.String val) Sets the Quantity from a string.
void	setUnits(HL7FieldCE val) Sets the Units component of this field.
void	setUnitsValue(java.lang.String val) Sets the Units from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldCQ

public HL7FieldCQ()

Creates an empty HL7 CQ type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getQuantity

public java.lang.String getQuantity()

Gets the Quantity component of this field.

Returns:

the Quantity value

setQuantity

public void setQuantity(java.lang.String val)

Sets the Quantity from a string.

Parameters:

val - The value to set for Quantity

isQuantityEmpty

public boolean isQuantityEmpty()

Tells whether the Quantity component has been specified.

Returns:

true if the component is empty.

isQuantityNull

public boolean isQuantityNull()

Tells whether the Quantity component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getUnitsValue

public java.lang.String getUnitsValue()

Gets the Units component of this field.

Returns:

the Units value

setUnitsValue

public void setUnitsValue(java.lang.String val)

Sets the Units from a string.

Parameters:

val - The value to set for Units

getUnits

public HL7FieldCE getUnits()

Gets the Units component of this field.

Returns:

An HL7FieldCE object representing Units

setUnits

public void setUnits(HL7FieldCE val)

Sets the Units component of this field.

Parameters:

val - An HL7FieldCE object containing the value to be set.

isUnitsEmpty

public boolean isUnitsEmpty()

Tells whether the Units component has been specified.

Returns:

true if the component is empty.

isUnitsNull

public boolean isUnitsNull()

Tells whether the Units component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.