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

java.lang.Object
  ca.uhn.hl7v2.conf.spec.message.Seg

All Implemented Interfaces:

ProfileStructure

public class Seg
extends 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(PropertyChangeListener l) Adds a PropertyChangeListener to the listener list.
void	addVetoableChangeListener(VetoableChangeListener l) Adds a VetoableChangeListener to the listener list.
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
String	getImpNote() Getter for property impNote.
String	getLongName() Getter for property longName.
short	getMax() Getter for property max.
short	getMin() Getter for property min.
String	getName() Getter for property name.
String	getPredicate() Getter for property predicate.
String	getReference() Getter for property reference.
String	getUsage() Getter for property usage.
void	removePropertyChangeListener(PropertyChangeListener l) Removes a PropertyChangeListener from the listener list.
void	removeVetoableChangeListener(VetoableChangeListener l) Removes a VetoableChangeListener from the listener list.
void	setDescription(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(String impNote) Setter for property impNote.
void	setLongName(String longName) Setter for property longName.
void	setMax(short max) Setter for property max.
void	setMin(short min) Setter for property min.
void	setName(String name) Setter for property name.
void	setPredicate(String predicate) Setter for property predicate.
void	setReference(String reference) Setter for property reference.
void	setUsage(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(PropertyChangeListener l)

Adds a PropertyChangeListener to the listener list.

Parameters:

l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Removes a PropertyChangeListener from the listener list.

Parameters:

l - The listener to remove.

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener l)

Adds a VetoableChangeListener to the listener list.

Parameters:

l - The listener to add.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener l)

Removes a VetoableChangeListener from the listener list.

Parameters:

l - The listener to remove.

getImpNote

public String getImpNote()

Getter for property impNote.

Specified by:

getImpNote in interface ProfileStructure

Returns:

Value of property impNote.

setImpNote

public void setImpNote(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 String getDescription()

Getter for property description.

Specified by:

getDescription in interface ProfileStructure

Returns:

Value of property description.

setDescription

public void setDescription(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 String getReference()

Getter for property reference.

Specified by:

getReference in interface ProfileStructure

Returns:

Value of property reference.

setReference

public void setReference(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 String getPredicate()

Getter for property predicate.

Specified by:

getPredicate in interface ProfileStructure

Returns:

Value of property predicate.

setPredicate

public void setPredicate(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 String getName()

Getter for property name.

Specified by:

getName in interface ProfileStructure

Returns:

Value of property name.

setName

public void setName(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 String getLongName()

Getter for property longName.

Specified by:

getLongName in interface ProfileStructure

Returns:

Value of property longName.

setLongName

public void setLongName(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 String getUsage()

Getter for property usage.

Specified by:

getUsage in interface ProfileStructure

Returns:

Value of property usage.

setUsage

public void setUsage(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