ca.uhn.hl7v2.conf.spec.message
Class Seg

java.lang.Object
  extended by ca.uhn.hl7v2.conf.spec.message.Seg
All Implemented Interfaces:
ProfileStructure

public class Seg
extends java.lang.Object
implements ProfileStructure

A specification for a message segment in a conformance profile.

Author:
Bryan Tripp

Constructor Summary
Seg()
          Creates a new instance of Segment
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener l)
          Adds a PropertyChangeListener to the listener list.
 void addVetoableChangeListener(java.beans.VetoableChangeListener l)
          Adds a VetoableChangeListener to the listener list.
 java.lang.String getDescription()
          Getter for property description.
 Field getField(int index)
          Indexed getter for property field (index starts at 1 following HL7 convention).
 int getFields()
          Returns the number of fields in the segment
 java.lang.String getImpNote()
          Getter for property impNote.
 java.lang.String getLongName()
          Getter for property longName.
 short getMax()
          Getter for property max.
 short getMin()
          Getter for property min.
 java.lang.String getName()
          Getter for property name.
 java.lang.String getPredicate()
          Getter for property predicate.
 java.lang.String getReference()
          Getter for property reference.
 java.lang.String getUsage()
          Getter for property usage.
 void removePropertyChangeListener(java.beans.PropertyChangeListener l)
          Removes a PropertyChangeListener from the listener list.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener l)
          Removes a VetoableChangeListener from the listener list.
 void setDescription(java.lang.String description)
          Setter for property description.
 void setField(int index, Field field)
          Indexed setter for property field (index starts at 1 following HL7 convention).
 void setImpNote(java.lang.String impNote)
          Setter for property impNote.
 void setLongName(java.lang.String longName)
          Setter for property longName.
 void setMax(short max)
          Setter for property max.
 void setMin(short min)
          Setter for property min.
 void setName(java.lang.String name)
          Setter for property name.
 void setPredicate(java.lang.String predicate)
          Setter for property predicate.
 void setReference(java.lang.String reference)
          Setter for property reference.
 void setUsage(java.lang.String usage)
          Setter for property usage.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Seg

public Seg()
Creates a new instance of Segment

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
Adds a PropertyChangeListener to the listener list.

Parameters:
l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
Removes a PropertyChangeListener from the listener list.

Parameters:
l - The listener to remove.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener l)
Adds a VetoableChangeListener to the listener list.

Parameters:
l - The listener to add.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener l)
Removes a VetoableChangeListener from the listener list.

Parameters:
l - The listener to remove.

getImpNote

public java.lang.String getImpNote()
Getter for property impNote.

Specified by:
getImpNote in interface ProfileStructure
Returns:
Value of property impNote.

setImpNote

public void setImpNote(java.lang.String impNote)
                throws ProfileException
Setter for property impNote.

Specified by:
setImpNote in interface ProfileStructure
Parameters:
impNote - New value of property impNote.
Throws:
ProfileException

getDescription

public java.lang.String getDescription()
Getter for property description.

Specified by:
getDescription in interface ProfileStructure
Returns:
Value of property description.

setDescription

public void setDescription(java.lang.String description)
                    throws ProfileException
Setter for property description.

Specified by:
setDescription in interface ProfileStructure
Parameters:
description - New value of property description.
Throws:
ProfileException

getReference

public java.lang.String getReference()
Getter for property reference.

Specified by:
getReference in interface ProfileStructure
Returns:
Value of property reference.

setReference

public void setReference(java.lang.String reference)
                  throws ProfileException
Setter for property reference.

Specified by:
setReference in interface ProfileStructure
Parameters:
reference - New value of property reference.
Throws:
ProfileException

getPredicate

public java.lang.String getPredicate()
Getter for property predicate.

Specified by:
getPredicate in interface ProfileStructure
Returns:
Value of property predicate.

setPredicate

public void setPredicate(java.lang.String predicate)
                  throws ProfileException
Setter for property predicate.

Specified by:
setPredicate in interface ProfileStructure
Parameters:
predicate - New value of property predicate.
Throws:
ProfileException

getField

public Field getField(int index)
Indexed getter for property field (index starts at 1 following HL7 convention).

Parameters:
index - Index of the property (starts at 1 following HL7 convention).
Returns:
Value of the property at index.

setField

public void setField(int index,
                     Field field)
              throws ProfileException
Indexed setter for property field (index starts at 1 following HL7 convention).

Parameters:
index - Index of the property (starts at 1 following HL7 convention).
field - New value of the property at index.
Throws:
ProfileException

getName

public java.lang.String getName()
Getter for property name.

Specified by:
getName in interface ProfileStructure
Returns:
Value of property name.

setName

public void setName(java.lang.String name)
             throws ProfileException
Setter for property name.

Specified by:
setName in interface ProfileStructure
Parameters:
name - New value of property name.
Throws:
ProfileException

getLongName

public java.lang.String getLongName()
Getter for property longName.

Specified by:
getLongName in interface ProfileStructure
Returns:
Value of property longName.

setLongName

public void setLongName(java.lang.String longName)
                 throws ProfileException
Setter for property longName.

Specified by:
setLongName in interface ProfileStructure
Parameters:
longName - New value of property longName.
Throws:
ProfileException

getUsage

public java.lang.String getUsage()
Getter for property usage.

Specified by:
getUsage in interface ProfileStructure
Returns:
Value of property usage.

setUsage

public void setUsage(java.lang.String usage)
              throws ProfileException
Setter for property usage.

Specified by:
setUsage in interface ProfileStructure
Parameters:
optionality - New value of property usage.
Throws:
ProfileException

getMin

public short getMin()
Getter for property min.

Specified by:
getMin in interface ProfileStructure
Returns:
Value of property min.

setMin

public void setMin(short min)
            throws ProfileException
Setter for property min.

Specified by:
setMin in interface ProfileStructure
Parameters:
min - New value of property min.
Throws:
ProfileException

getMax

public short getMax()
Getter for property max.

Specified by:
getMax in interface ProfileStructure
Returns:
Value of property max.

setMax

public void setMax(short max)
            throws ProfileException
Setter for property max.

Specified by:
setMax in interface ProfileStructure
Parameters:
max - New value of property max.
Throws:
ProfileException

getFields

public int getFields()
Returns the number of fields in the segment



Copyright © 2001-2011 University Health Network. All Rights Reserved.