com.merge.HL7.v260.fields
Class HL7FieldCD

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v260.fields.HL7FieldCD

public class HL7FieldCD
extends HL7Field

This data type is used for labeling of digital waveform data. It defines a recording channel, which is associated with one of the values in each time sample of waveform data. Each channel has a number (which generally defines its position in a multichannel display) and an optional name or label (also used in displays). One or two named waveform sources may also be associated with a channel (providing for the use of differential amplifiers with two inputs). The other components of the channel definition data type are optional. The individual components are defined as follows:

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

HL7FieldCD()
Creates an empty HL7 CD type field object.

Method Summary

HL7FieldCCP	getChannelCalibrationParameters() Gets the Channel Calibration Parameters component of this field.
java.lang.String	getChannelCalibrationParametersValue() Gets the Channel Calibration Parameters component of this field.
HL7FieldWVI	getChannelIdentifier() Gets the Channel Identifier component of this field.
java.lang.String	getChannelIdentifierValue() Gets the Channel Identifier component of this field.
java.lang.String	getChannelSamplingFrequency() Gets the Channel Sampling Frequency component of this field.
HL7FieldCSU	getChannelSensitivityandUnits() Gets the Channel Sensitivity and Units component of this field.
java.lang.String	getChannelSensitivityandUnitsValue() Gets the Channel Sensitivity and Units component of this field.
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.
HL7FieldNR	getMinimumandMaximumDataValues() Gets the Minimum and Maximum Data Values component of this field.
java.lang.String	getMinimumandMaximumDataValuesValue() Gets the Minimum and Maximum Data Values component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
HL7FieldWVS	getWaveformSource() Gets the Waveform Source component of this field.
java.lang.String	getWaveformSourceValue() Gets the Waveform Source component of this field.
boolean	isChannelCalibrationParametersEmpty() Tells whether the Channel Calibration Parameters component has been specified.
boolean	isChannelCalibrationParametersNull() Tells whether the Channel Calibration Parameters component has a has Null value as defined by HL7.
boolean	isChannelIdentifierEmpty() Tells whether the Channel Identifier component has been specified.
boolean	isChannelIdentifierNull() Tells whether the Channel Identifier component has a has Null value as defined by HL7.
boolean	isChannelSamplingFrequencyEmpty() Tells whether the Channel Sampling Frequency component has been specified.
boolean	isChannelSamplingFrequencyNull() Tells whether the Channel Sampling Frequency component has a has Null value as defined by HL7.
boolean	isChannelSensitivityandUnitsEmpty() Tells whether the Channel Sensitivity and Units component has been specified.
boolean	isChannelSensitivityandUnitsNull() Tells whether the Channel Sensitivity and Units component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isMinimumandMaximumDataValuesEmpty() Tells whether the Minimum and Maximum Data Values component has been specified.
boolean	isMinimumandMaximumDataValuesNull() Tells whether the Minimum and Maximum Data Values component has a has Null value as defined by HL7.
boolean	isWaveformSourceEmpty() Tells whether the Waveform Source component has been specified.
boolean	isWaveformSourceNull() Tells whether the Waveform Source component has a has Null value as defined by HL7.
void	setChannelCalibrationParameters(HL7FieldCCP val) Sets the Channel Calibration Parameters component of this field.
void	setChannelCalibrationParametersValue(java.lang.String val) Sets the Channel Calibration Parameters from a string.
void	setChannelIdentifier(HL7FieldWVI val) Sets the Channel Identifier component of this field.
void	setChannelIdentifierValue(java.lang.String val) Sets the Channel Identifier from a string.
void	setChannelSamplingFrequency(java.lang.String val) Sets the Channel Sampling Frequency from a string.
void	setChannelSensitivityandUnits(HL7FieldCSU val) Sets the Channel Sensitivity and Units component of this field.
void	setChannelSensitivityandUnitsValue(java.lang.String val) Sets the Channel Sensitivity and Units from a string.
void	setMinimumandMaximumDataValues(HL7FieldNR val) Sets the Minimum and Maximum Data Values component of this field.
void	setMinimumandMaximumDataValuesValue(java.lang.String val) Sets the Minimum and Maximum Data Values from a string.
void	setWaveformSource(HL7FieldWVS val) Sets the Waveform Source component of this field.
void	setWaveformSourceValue(java.lang.String val) Sets the Waveform Source 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

HL7FieldCD

public HL7FieldCD()

Creates an empty HL7 CD 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.

getChannelIdentifierValue

public java.lang.String getChannelIdentifierValue()

Gets the Channel Identifier component of this field.

Returns:

the Channel Identifier value

setChannelIdentifierValue

public void setChannelIdentifierValue(java.lang.String val)

Sets the Channel Identifier from a string.

Parameters:

val - The value to set for Channel Identifier

getChannelIdentifier

public HL7FieldWVI getChannelIdentifier()

Gets the Channel Identifier component of this field.

Returns:

An HL7FieldWVI object representing Channel Identifier

setChannelIdentifier

public void setChannelIdentifier(HL7FieldWVI val)

Sets the Channel Identifier component of this field.

Parameters:

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

isChannelIdentifierEmpty

public boolean isChannelIdentifierEmpty()

Tells whether the Channel Identifier component has been specified.

Returns:

true if the component is empty.

isChannelIdentifierNull

public boolean isChannelIdentifierNull()

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

Returns:

true if the component has the HL7 Null value.

getWaveformSourceValue

public java.lang.String getWaveformSourceValue()

Gets the Waveform Source component of this field.

Returns:

the Waveform Source value

setWaveformSourceValue

public void setWaveformSourceValue(java.lang.String val)

Sets the Waveform Source from a string.

Parameters:

val - The value to set for Waveform Source

getWaveformSource

public HL7FieldWVS getWaveformSource()

Gets the Waveform Source component of this field.

Returns:

An HL7FieldWVS object representing Waveform Source

setWaveformSource

public void setWaveformSource(HL7FieldWVS val)

Sets the Waveform Source component of this field.

Parameters:

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

isWaveformSourceEmpty

public boolean isWaveformSourceEmpty()

Tells whether the Waveform Source component has been specified.

Returns:

true if the component is empty.

isWaveformSourceNull

public boolean isWaveformSourceNull()

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

Returns:

true if the component has the HL7 Null value.

getChannelSensitivityandUnitsValue

public java.lang.String getChannelSensitivityandUnitsValue()

Gets the Channel Sensitivity and Units component of this field.

Returns:

the Channel Sensitivity and Units value

setChannelSensitivityandUnitsValue

public void setChannelSensitivityandUnitsValue(java.lang.String val)

Sets the Channel Sensitivity and Units from a string.

Parameters:

val - The value to set for Channel Sensitivity and Units

getChannelSensitivityandUnits

public HL7FieldCSU getChannelSensitivityandUnits()

Gets the Channel Sensitivity and Units component of this field.

Returns:

An HL7FieldCSU object representing Channel Sensitivity and Units

setChannelSensitivityandUnits

public void setChannelSensitivityandUnits(HL7FieldCSU val)

Sets the Channel Sensitivity and Units component of this field.

Parameters:

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

isChannelSensitivityandUnitsEmpty

public boolean isChannelSensitivityandUnitsEmpty()

Tells whether the Channel Sensitivity and Units component has been specified.

Returns:

true if the component is empty.

isChannelSensitivityandUnitsNull

public boolean isChannelSensitivityandUnitsNull()

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

Returns:

true if the component has the HL7 Null value.

getChannelCalibrationParametersValue

public java.lang.String getChannelCalibrationParametersValue()

Gets the Channel Calibration Parameters component of this field.

Returns:

the Channel Calibration Parameters value

setChannelCalibrationParametersValue

public void setChannelCalibrationParametersValue(java.lang.String val)

Sets the Channel Calibration Parameters from a string.

Parameters:

val - The value to set for Channel Calibration Parameters

getChannelCalibrationParameters

public HL7FieldCCP getChannelCalibrationParameters()

Gets the Channel Calibration Parameters component of this field.

Returns:

An HL7FieldCCP object representing Channel Calibration Parameters

setChannelCalibrationParameters

public void setChannelCalibrationParameters(HL7FieldCCP val)

Sets the Channel Calibration Parameters component of this field.

Parameters:

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

isChannelCalibrationParametersEmpty

public boolean isChannelCalibrationParametersEmpty()

Tells whether the Channel Calibration Parameters component has been specified.

Returns:

true if the component is empty.

isChannelCalibrationParametersNull

public boolean isChannelCalibrationParametersNull()

Tells whether the Channel Calibration Parameters component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getChannelSamplingFrequency

public java.lang.String getChannelSamplingFrequency()

Gets the Channel Sampling Frequency component of this field.

Returns:

the Channel Sampling Frequency value

setChannelSamplingFrequency

public void setChannelSamplingFrequency(java.lang.String val)

Sets the Channel Sampling Frequency from a string.

Parameters:

val - The value to set for Channel Sampling Frequency

isChannelSamplingFrequencyEmpty

public boolean isChannelSamplingFrequencyEmpty()

Tells whether the Channel Sampling Frequency component has been specified.

Returns:

true if the component is empty.

isChannelSamplingFrequencyNull

public boolean isChannelSamplingFrequencyNull()

Tells whether the Channel Sampling Frequency component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getMinimumandMaximumDataValuesValue

public java.lang.String getMinimumandMaximumDataValuesValue()

Gets the Minimum and Maximum Data Values component of this field.

Returns:

the Minimum and Maximum Data Values value

setMinimumandMaximumDataValuesValue

public void setMinimumandMaximumDataValuesValue(java.lang.String val)

Sets the Minimum and Maximum Data Values from a string.

Parameters:

val - The value to set for Minimum and Maximum Data Values

getMinimumandMaximumDataValues

public HL7FieldNR getMinimumandMaximumDataValues()

Gets the Minimum and Maximum Data Values component of this field.

Returns:

An HL7FieldNR object representing Minimum and Maximum Data Values

setMinimumandMaximumDataValues

public void setMinimumandMaximumDataValues(HL7FieldNR val)

Sets the Minimum and Maximum Data Values component of this field.

Parameters:

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

isMinimumandMaximumDataValuesEmpty

public boolean isMinimumandMaximumDataValuesEmpty()

Tells whether the Minimum and Maximum Data Values component has been specified.

Returns:

true if the component is empty.

isMinimumandMaximumDataValuesNull

public boolean isMinimumandMaximumDataValuesNull()

Tells whether the Minimum and Maximum Data Values component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.