com.merge.HL7.v231.fields
Class HL7FieldCP

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v231.fields.HL7FieldCP

public class HL7FieldCP
extends HL7Field

This data type is often used to define a repeating field within a given segment.

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

HL7FieldCP()
Creates an empty HL7 CP 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.
java.lang.String	getFromValue() Gets the From Value component of this field.
int	getMaxSize() Gets the number of components defined for this field.
HL7FieldMO	getPrice() Gets the Price component of this field.
java.lang.String	getPriceType() Gets the Price Type component of this field.
java.lang.String	getPriceValue() Gets the Price component of this field.
java.lang.String	getRangeType() Gets the Range Type component of this field.
HL7FieldCE	getRangeUnits() Gets the Range Units component of this field.
java.lang.String	getRangeUnitsValue() Gets the Range Units component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
java.lang.String	getToValue() Gets the To Value component of this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isFromValueEmpty() Tells whether the From Value component has been specified.
boolean	isFromValueNull() Tells whether the From Value component has a has Null value as defined by HL7.
boolean	isPriceEmpty() Tells whether the Price component has been specified.
boolean	isPriceNull() Tells whether the Price component has a has Null value as defined by HL7.
boolean	isPriceTypeEmpty() Tells whether the Price Type component has been specified.
boolean	isPriceTypeNull() Tells whether the Price Type component has a has Null value as defined by HL7.
boolean	isRangeTypeEmpty() Tells whether the Range Type component has been specified.
boolean	isRangeTypeNull() Tells whether the Range Type component has a has Null value as defined by HL7.
boolean	isRangeUnitsEmpty() Tells whether the Range Units component has been specified.
boolean	isRangeUnitsNull() Tells whether the Range Units component has a has Null value as defined by HL7.
boolean	isToValueEmpty() Tells whether the To Value component has been specified.
boolean	isToValueNull() Tells whether the To Value component has a has Null value as defined by HL7.
void	setFromValue(java.lang.String val) Sets the From Value from a string.
void	setPrice(HL7FieldMO val) Sets the Price component of this field.
void	setPriceType(java.lang.String val) Sets the Price Type from a string.
void	setPriceValue(java.lang.String val) Sets the Price from a string.
void	setRangeType(java.lang.String val) Sets the Range Type from a string.
void	setRangeUnits(HL7FieldCE val) Sets the Range Units component of this field.
void	setRangeUnitsValue(java.lang.String val) Sets the Range Units from a string.
void	setToValue(java.lang.String val) Sets the To Value 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

HL7FieldCP

public HL7FieldCP()

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

getPriceValue

public java.lang.String getPriceValue()

Gets the Price component of this field.

Returns:

the Price value

setPriceValue

public void setPriceValue(java.lang.String val)

Sets the Price from a string.

Parameters:

val - The value to set for Price

getPrice

public HL7FieldMO getPrice()

Gets the Price component of this field.

Returns:

An HL7FieldMO object representing Price

setPrice

public void setPrice(HL7FieldMO val)

Sets the Price component of this field.

Parameters:

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

isPriceEmpty

public boolean isPriceEmpty()

Tells whether the Price component has been specified.

Returns:

true if the component is empty.

isPriceNull

public boolean isPriceNull()

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

Returns:

true if the component has the HL7 Null value.

getPriceType

public java.lang.String getPriceType()

Gets the Price Type component of this field.

Returns:

the Price Type value

setPriceType

public void setPriceType(java.lang.String val)

Sets the Price Type from a string.

Parameters:

val - The value to set for Price Type

isPriceTypeEmpty

public boolean isPriceTypeEmpty()

Tells whether the Price Type component has been specified.

Returns:

true if the component is empty.

isPriceTypeNull

public boolean isPriceTypeNull()

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

Returns:

true if the component has the HL7 Null value.

getFromValue

public java.lang.String getFromValue()

Gets the From Value component of this field.

Returns:

the From Value value

setFromValue

public void setFromValue(java.lang.String val)

Sets the From Value from a string.

Parameters:

val - The value to set for From Value

isFromValueEmpty

public boolean isFromValueEmpty()

Tells whether the From Value component has been specified.

Returns:

true if the component is empty.

isFromValueNull

public boolean isFromValueNull()

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

Returns:

true if the component has the HL7 Null value.

getToValue

public java.lang.String getToValue()

Gets the To Value component of this field.

Returns:

the To Value value

setToValue

public void setToValue(java.lang.String val)

Sets the To Value from a string.

Parameters:

val - The value to set for To Value

isToValueEmpty

public boolean isToValueEmpty()

Tells whether the To Value component has been specified.

Returns:

true if the component is empty.

isToValueNull

public boolean isToValueNull()

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

Returns:

true if the component has the HL7 Null value.

getRangeUnitsValue

public java.lang.String getRangeUnitsValue()

Gets the Range Units component of this field.

Returns:

the Range Units value

setRangeUnitsValue

public void setRangeUnitsValue(java.lang.String val)

Sets the Range Units from a string.

Parameters:

val - The value to set for Range Units

getRangeUnits

public HL7FieldCE getRangeUnits()

Gets the Range Units component of this field.

Returns:

An HL7FieldCE object representing Range Units

setRangeUnits

public void setRangeUnits(HL7FieldCE val)

Sets the Range Units component of this field.

Parameters:

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

isRangeUnitsEmpty

public boolean isRangeUnitsEmpty()

Tells whether the Range Units component has been specified.

Returns:

true if the component is empty.

isRangeUnitsNull

public boolean isRangeUnitsNull()

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

Returns:

true if the component has the HL7 Null value.

getRangeType

public java.lang.String getRangeType()

Gets the Range Type component of this field.

Returns:

the Range Type value

setRangeType

public void setRangeType(java.lang.String val)

Sets the Range Type from a string.

Parameters:

val - The value to set for Range Type

isRangeTypeEmpty

public boolean isRangeTypeEmpty()

Tells whether the Range Type component has been specified.

Returns:

true if the component is empty.

isRangeTypeNull

public boolean isRangeTypeNull()

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

Returns:

true if the component has the HL7 Null value.