org.vmdb.hl7
Class CEElement

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7Element
              |
              +--org.vmdb.hl7.CEElement

public class CEElement

extends HL7Element

Coded Element (CE) Element.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

Constructor Summary

CEElement()
Construct a Coded Element using the default name and type constants at the default level FIELD.

CEElement(CEElement ceIn)
Copy constructor to clone away const'ness when using constant value CEs

CEElement(int iLevel)
Construct a Coded Element using the default name and type constants.

CEElement(java.lang.String sIdentifier, java.lang.String sText, java.lang.String sSystem)
Construct a Coded Element setting its value.

CEElement(java.lang.String sIdentifier, java.lang.String sText, java.lang.String sSystem, java.lang.String sAltIdentifier, java.lang.String sAltText, java.lang.String sAltSystem)
Construct a Coded Element setting its value.

Method Summary

java.lang.Object	clone()
CEElement	Clone()
boolean	equals(CEElement ce2) Does this CEElement code the same thing as the second?
java.lang.String	getAltCodingSystem() Get the alternate coding system used in an existing Coded Element.
java.lang.String	getAltIdentifier() Get the alternate coded value of an existing Coded Element.
java.lang.String	getAltText() Get the alternate text value of an existing Coded Element.
java.lang.String	getCodingSystem() Get the coding system used in an existing Coded Element.
java.lang.String	getIdentifier() Get the coded value of an existing Coded Element.
java.lang.String	getText() Get the text value of an existing Coded Element.
void	setAltCodingSystem(java.lang.String sAltSystem) Set the alternate coding system used in an existing Coded Element.
void	setAltIdentifier(java.lang.String sAltId) Set the alternate coded value of an existing Coded Element.
void	setAltText(java.lang.String sAltText) Set the alternate text value of an existing Coded Element.
void	setCodingSystem(java.lang.String sCodeSystem) Set the coding system used in an existing Coded Element.
void	setIdentifier(java.lang.String sIdentifier) Set the coded value of an existing Coded Element.
void	setText(java.lang.String sText) Set the text value of an existing Coded Element.

Methods inherited from class org.vmdb.hl7.HL7Element

clear, empty, getComponent, getLevel, getType, getValue, initialize, iterator, makeElement, setComponent, setLevel, setType, setValue, size, toHL7String, toString, toXML

Methods inherited from class org.vmdb.hl7.HL7Object

getRule

Methods inherited from class java.lang.Object

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

Constructor Detail

CEElement

public CEElement(int iLevel)

Construct a Coded Element using the default name and type constants.

Parameters:

iLevel - One of the constants for specifying level as FIELD, COMPONENT, or SUBCOMPONENT. Default FIELD.

CEElement

public CEElement()

Construct a Coded Element using the default name and type constants at the default level FIELD.

CEElement

public CEElement(java.lang.String sIdentifier,
                 java.lang.String sText,
                 java.lang.String sSystem)

Construct a Coded Element setting its value.

Uses the default name and type constants at the default level FIELD

Parameters:

sIdentifier - String with the code for the value.

sText - String with the value spelled out as English text.

sSystem - String with the name of the coding system abbreviated.

CEElement

public CEElement(java.lang.String sIdentifier,
                 java.lang.String sText,
                 java.lang.String sSystem,
                 java.lang.String sAltIdentifier,
                 java.lang.String sAltText,
                 java.lang.String sAltSystem)

Construct a Coded Element setting its value.

Uses the default name and type constants at the default level FIELD

Parameters:

sIdentifier - String with the code for the value.

sText - String with the value spelled out as English text.

sSystem - String with the name of the coding system abbreviated.

sAltIdentifier - String with the code for the value.

sAltText - String with the value spelled out as English text.

sAltSystem - String with the name of the coding system abbreviated.

CEElement

public CEElement(CEElement ceIn)

Copy constructor to clone away const'ness when using constant value CEs

Method Detail

Clone

public CEElement Clone()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(CEElement ce2)

Does this CEElement code the same thing as the second?

Returns:

boolean true if the two match on identifier plus code system for either main or alternate identifier

setIdentifier

public void setIdentifier(java.lang.String sIdentifier)

Set the coded value of an existing Coded Element.

Parameters:

sIdentifier - String with the code for the value.

getIdentifier

public java.lang.String getIdentifier()

Get the coded value of an existing Coded Element.

Returns:

String with the code for the value.

setText

public void setText(java.lang.String sText)

Set the text value of an existing Coded Element.

Parameters:

sText - String with the value spelled out as English text.

getText

public java.lang.String getText()

Get the text value of an existing Coded Element.

Returns:

String with the value spelled out as English text.

setCodingSystem

public void setCodingSystem(java.lang.String sCodeSystem)

Set the coding system used in an existing Coded Element.

getCodingSystem

public java.lang.String getCodingSystem()

Get the coding system used in an existing Coded Element.

Returns:

String with the name of the coding system abbreviated.

setAltIdentifier

public void setAltIdentifier(java.lang.String sAltId)

Set the alternate coded value of an existing Coded Element.

The alternate code is a different way of coding the same meaning. If a second concept is to be sent, it belongs in a different element, not in the alternate identifier.

Parameters:

sAltId - String with the code for the value.

getAltIdentifier

public java.lang.String getAltIdentifier()

Get the alternate coded value of an existing Coded Element.

Returns:

String with the code for the value.

setAltText

public void setAltText(java.lang.String sAltText)

Set the alternate text value of an existing Coded Element.

If this component is left blank, it is assumed that the description text is the same as the primary.

Parameters:

sAltText - String with the value spelled out as English text.

getAltText

public java.lang.String getAltText()

Get the alternate text value of an existing Coded Element.

Returns:

String with the value spelled out as English text.

setAltCodingSystem

public void setAltCodingSystem(java.lang.String sAltSystem)

Set the alternate coding system used in an existing Coded Element.

If this component is left blank, it is assumed that the alternate coding system is a local code.

Parameters:

sAltSystem - String with the name of the coding system abbreviated.

getAltCodingSystem

public java.lang.String getAltCodingSystem()

Get the alternate coding system used in an existing Coded Element.

Returns:

String with the name of the coding system abbreviated.