com.merge.HL7.v251.fields
Class HL7FieldCSU

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v251.fields.HL7FieldCSU

public class HL7FieldCSU
extends HL7Field

This data type defines the channel sensitivity (gain) and the units in which it is measured in a waveform result.

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

HL7FieldCSU()
Creates an empty HL7 CSU type field object.

Method Summary

java.lang.String	getAlternateUnitOfMeasureCodingSystem() Gets the Alternate Unit of Measure Coding System component of this field.
java.lang.String	getAlternateUnitOfMeasureDescription() Gets the Alternate Unit of Measure Description component of this field.
java.lang.String	getAlternateUnitOfMeasureIdentifier() Gets the Alternate Unit of Measure Identifier component of this field.
java.lang.String	getChannelSensitivity() Gets the Channel Sensitivity 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.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
java.lang.String	getUnitOfMeasureCodingSystem() Gets the Unit of Measure Coding System component of this field.
java.lang.String	getUnitOfMeasureDescription() Gets the Unit of Measure Description component of this field.
java.lang.String	getUnitOfMeasureIdentifier() Gets the Unit of Measure Identifier component of this field.
boolean	isAlternateUnitOfMeasureCodingSystemEmpty() Tells whether the Alternate Unit of Measure Coding System component has been specified.
boolean	isAlternateUnitOfMeasureCodingSystemNull() Tells whether the Alternate Unit of Measure Coding System component has a has Null value as defined by HL7.
boolean	isAlternateUnitOfMeasureDescriptionEmpty() Tells whether the Alternate Unit of Measure Description component has been specified.
boolean	isAlternateUnitOfMeasureDescriptionNull() Tells whether the Alternate Unit of Measure Description component has a has Null value as defined by HL7.
boolean	isAlternateUnitOfMeasureIdentifierEmpty() Tells whether the Alternate Unit of Measure Identifier component has been specified.
boolean	isAlternateUnitOfMeasureIdentifierNull() Tells whether the Alternate Unit of Measure Identifier component has a has Null value as defined by HL7.
boolean	isChannelSensitivityEmpty() Tells whether the Channel Sensitivity component has been specified.
boolean	isChannelSensitivityNull() Tells whether the Channel Sensitivity component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isUnitOfMeasureCodingSystemEmpty() Tells whether the Unit of Measure Coding System component has been specified.
boolean	isUnitOfMeasureCodingSystemNull() Tells whether the Unit of Measure Coding System component has a has Null value as defined by HL7.
boolean	isUnitOfMeasureDescriptionEmpty() Tells whether the Unit of Measure Description component has been specified.
boolean	isUnitOfMeasureDescriptionNull() Tells whether the Unit of Measure Description component has a has Null value as defined by HL7.
boolean	isUnitOfMeasureIdentifierEmpty() Tells whether the Unit of Measure Identifier component has been specified.
boolean	isUnitOfMeasureIdentifierNull() Tells whether the Unit of Measure Identifier component has a has Null value as defined by HL7.
void	setAlternateUnitOfMeasureCodingSystem(java.lang.String val) Sets the Alternate Unit of Measure Coding System from a string.
void	setAlternateUnitOfMeasureDescription(java.lang.String val) Sets the Alternate Unit of Measure Description from a string.
void	setAlternateUnitOfMeasureIdentifier(java.lang.String val) Sets the Alternate Unit of Measure Identifier from a string.
void	setChannelSensitivity(java.lang.String val) Sets the Channel Sensitivity from a string.
void	setUnitOfMeasureCodingSystem(java.lang.String val) Sets the Unit of Measure Coding System from a string.
void	setUnitOfMeasureDescription(java.lang.String val) Sets the Unit of Measure Description from a string.
void	setUnitOfMeasureIdentifier(java.lang.String val) Sets the Unit of Measure Identifier 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

HL7FieldCSU

public HL7FieldCSU()

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

getChannelSensitivity

public java.lang.String getChannelSensitivity()

Gets the Channel Sensitivity component of this field.

Returns:

the Channel Sensitivity value

setChannelSensitivity

public void setChannelSensitivity(java.lang.String val)

Sets the Channel Sensitivity from a string.

Parameters:

val - The value to set for Channel Sensitivity

isChannelSensitivityEmpty

public boolean isChannelSensitivityEmpty()

Tells whether the Channel Sensitivity component has been specified.

Returns:

true if the component is empty.

isChannelSensitivityNull

public boolean isChannelSensitivityNull()

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

Returns:

true if the component has the HL7 Null value.

getUnitOfMeasureIdentifier

public java.lang.String getUnitOfMeasureIdentifier()

Gets the Unit of Measure Identifier component of this field.

Returns:

the Unit of Measure Identifier value

setUnitOfMeasureIdentifier

public void setUnitOfMeasureIdentifier(java.lang.String val)

Sets the Unit of Measure Identifier from a string.

Parameters:

val - The value to set for Unit of Measure Identifier

isUnitOfMeasureIdentifierEmpty

public boolean isUnitOfMeasureIdentifierEmpty()

Tells whether the Unit of Measure Identifier component has been specified.

Returns:

true if the component is empty.

isUnitOfMeasureIdentifierNull

public boolean isUnitOfMeasureIdentifierNull()

Tells whether the Unit of Measure Identifier component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getUnitOfMeasureDescription

public java.lang.String getUnitOfMeasureDescription()

Gets the Unit of Measure Description component of this field.

Returns:

the Unit of Measure Description value

setUnitOfMeasureDescription

public void setUnitOfMeasureDescription(java.lang.String val)

Sets the Unit of Measure Description from a string.

Parameters:

val - The value to set for Unit of Measure Description

isUnitOfMeasureDescriptionEmpty

public boolean isUnitOfMeasureDescriptionEmpty()

Tells whether the Unit of Measure Description component has been specified.

Returns:

true if the component is empty.

isUnitOfMeasureDescriptionNull

public boolean isUnitOfMeasureDescriptionNull()

Tells whether the Unit of Measure Description component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getUnitOfMeasureCodingSystem

public java.lang.String getUnitOfMeasureCodingSystem()

Gets the Unit of Measure Coding System component of this field.

Returns:

the Unit of Measure Coding System value

setUnitOfMeasureCodingSystem

public void setUnitOfMeasureCodingSystem(java.lang.String val)

Sets the Unit of Measure Coding System from a string.

Parameters:

val - The value to set for Unit of Measure Coding System

isUnitOfMeasureCodingSystemEmpty

public boolean isUnitOfMeasureCodingSystemEmpty()

Tells whether the Unit of Measure Coding System component has been specified.

Returns:

true if the component is empty.

isUnitOfMeasureCodingSystemNull

public boolean isUnitOfMeasureCodingSystemNull()

Tells whether the Unit of Measure Coding System component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAlternateUnitOfMeasureIdentifier

public java.lang.String getAlternateUnitOfMeasureIdentifier()

Gets the Alternate Unit of Measure Identifier component of this field.

Returns:

the Alternate Unit of Measure Identifier value

setAlternateUnitOfMeasureIdentifier

public void setAlternateUnitOfMeasureIdentifier(java.lang.String val)

Sets the Alternate Unit of Measure Identifier from a string.

Parameters:

val - The value to set for Alternate Unit of Measure Identifier

isAlternateUnitOfMeasureIdentifierEmpty

public boolean isAlternateUnitOfMeasureIdentifierEmpty()

Tells whether the Alternate Unit of Measure Identifier component has been specified.

Returns:

true if the component is empty.

isAlternateUnitOfMeasureIdentifierNull

public boolean isAlternateUnitOfMeasureIdentifierNull()

Tells whether the Alternate Unit of Measure Identifier component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAlternateUnitOfMeasureDescription

public java.lang.String getAlternateUnitOfMeasureDescription()

Gets the Alternate Unit of Measure Description component of this field.

Returns:

the Alternate Unit of Measure Description value

setAlternateUnitOfMeasureDescription

public void setAlternateUnitOfMeasureDescription(java.lang.String val)

Sets the Alternate Unit of Measure Description from a string.

Parameters:

val - The value to set for Alternate Unit of Measure Description

isAlternateUnitOfMeasureDescriptionEmpty

public boolean isAlternateUnitOfMeasureDescriptionEmpty()

Tells whether the Alternate Unit of Measure Description component has been specified.

Returns:

true if the component is empty.

isAlternateUnitOfMeasureDescriptionNull

public boolean isAlternateUnitOfMeasureDescriptionNull()

Tells whether the Alternate Unit of Measure Description component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAlternateUnitOfMeasureCodingSystem

public java.lang.String getAlternateUnitOfMeasureCodingSystem()

Gets the Alternate Unit of Measure Coding System component of this field.

Returns:

the Alternate Unit of Measure Coding System value

setAlternateUnitOfMeasureCodingSystem

public void setAlternateUnitOfMeasureCodingSystem(java.lang.String val)

Sets the Alternate Unit of Measure Coding System from a string.

Parameters:

val - The value to set for Alternate Unit of Measure Coding System

isAlternateUnitOfMeasureCodingSystemEmpty

public boolean isAlternateUnitOfMeasureCodingSystemEmpty()

Tells whether the Alternate Unit of Measure Coding System component has been specified.

Returns:

true if the component is empty.

isAlternateUnitOfMeasureCodingSystemNull

public boolean isAlternateUnitOfMeasureCodingSystemNull()

Tells whether the Alternate Unit of Measure Coding System component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.