com.merge.HL7.v231.fields
Class HL7FieldCD

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v231.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.

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

java.lang.String	getChannelCalibrationParameters() Gets the Channel Calibration Parameters component of this field.
java.lang.String	getChannelIdentifier() Gets the Channel Identifier component of this field.
java.lang.String	getChannelSamplingFrequency() Gets the Channel Sampling Frequency component of this field.
java.lang.String	getChannelSensitivityUnits() Gets the Channel Sensitivity/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.
java.lang.String	getElectrodeNames() Gets the Electrode Names component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getMinimumMaximumDataValues() Gets the Minimum/Maximum Data Values component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in 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	isChannelSensitivityUnitsEmpty() Tells whether the Channel Sensitivity/Units component has been specified.
boolean	isChannelSensitivityUnitsNull() Tells whether the Channel Sensitivity/Units component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isElectrodeNamesEmpty() Tells whether the Electrode Names component has been specified.
boolean	isElectrodeNamesNull() Tells whether the Electrode Names component has a has Null value as defined by HL7.
boolean	isMinimumMaximumDataValuesEmpty() Tells whether the Minimum/Maximum Data Values component has been specified.
boolean	isMinimumMaximumDataValuesNull() Tells whether the Minimum/Maximum Data Values component has a has Null value as defined by HL7.
void	setChannelCalibrationParameters(java.lang.String val) Sets the Channel Calibration Parameters from a string.
void	setChannelIdentifier(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	setChannelSensitivityUnits(java.lang.String val) Sets the Channel Sensitivity/Units from a string.
void	setElectrodeNames(java.lang.String val) Sets the Electrode Names from a string.
void	setMinimumMaximumDataValues(java.lang.String val) Sets the Minimum/Maximum Data Values 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.

getChannelIdentifier

public java.lang.String getChannelIdentifier()

Gets the Channel Identifier component of this field.

Returns:

the Channel Identifier value

setChannelIdentifier

public void setChannelIdentifier(java.lang.String val)

Sets the Channel Identifier from a string.

Parameters:

val - The value to set for Channel Identifier

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.

getElectrodeNames

public java.lang.String getElectrodeNames()

Gets the Electrode Names component of this field.

Returns:

the Electrode Names value

setElectrodeNames

public void setElectrodeNames(java.lang.String val)

Sets the Electrode Names from a string.

Parameters:

val - The value to set for Electrode Names

isElectrodeNamesEmpty

public boolean isElectrodeNamesEmpty()

Tells whether the Electrode Names component has been specified.

Returns:

true if the component is empty.

isElectrodeNamesNull

public boolean isElectrodeNamesNull()

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

Returns:

true if the component has the HL7 Null value.

getChannelSensitivityUnits

public java.lang.String getChannelSensitivityUnits()

Gets the Channel Sensitivity/Units component of this field.

Returns:

the Channel Sensitivity/Units value

setChannelSensitivityUnits

public void setChannelSensitivityUnits(java.lang.String val)

Sets the Channel Sensitivity/Units from a string.

Parameters:

val - The value to set for Channel Sensitivity/Units

isChannelSensitivityUnitsEmpty

public boolean isChannelSensitivityUnitsEmpty()

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

Returns:

true if the component is empty.

isChannelSensitivityUnitsNull

public boolean isChannelSensitivityUnitsNull()

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

Returns:

true if the component has the HL7 Null value.

getChannelCalibrationParameters

public java.lang.String getChannelCalibrationParameters()

Gets the Channel Calibration Parameters component of this field.

Returns:

the Channel Calibration Parameters value

setChannelCalibrationParameters

public void setChannelCalibrationParameters(java.lang.String val)

Sets the Channel Calibration Parameters from a string.

Parameters:

val - The value to set for Channel Calibration Parameters

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.

getMinimumMaximumDataValues

public java.lang.String getMinimumMaximumDataValues()

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

Returns:

the Minimum/Maximum Data Values value

setMinimumMaximumDataValues

public void setMinimumMaximumDataValues(java.lang.String val)

Sets the Minimum/Maximum Data Values from a string.

Parameters:

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

isMinimumMaximumDataValuesEmpty

public boolean isMinimumMaximumDataValuesEmpty()

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

Returns:

true if the component is empty.

isMinimumMaximumDataValuesNull

public boolean isMinimumMaximumDataValuesNull()

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

Returns:

true if the component has the HL7 Null value.