org.urhl7.igor
Class LocationSpecification

java.lang.Object
  extended by org.urhl7.igor.LocationSpecification

public class LocationSpecification
extends Object

A data object that carries sufficient information to location a particular position in an HL7 message


Constructor Summary
LocationSpecification()
          Creates a blank LocationSpecification
 
Method Summary
 int getComponentPosition()
          Gets the component position (or -1 if not specified)
 int getFieldPosition()
          Gets the field position specified (or -1 if not specified)
 int getRepeatingFieldIndex()
          Gets the repeating field index (or -1 if not specified)
 String getSegmentName()
          Returns the segment name that was specified
 int getSegmentRepPosition()
          Gets the segment repetition position (or -1 if not specified)
 int getSubcomponentPosition()
          Gets the subcomponent position (or -1 not specified)
 boolean isSpecifiedFieldPosition()
          Returns if the specified field repetition position was set
 boolean isSpecifiedSegmentPosition()
          Returns if the segment repetition was set
 void setComponentPosition(int componentPosition)
          Sets the component position
 void setFieldPosition(int fieldPosition)
          Sets the field position
 void setRepeatingFieldIndex(int repeatingFieldIndex)
          Sets the repeating field index
 void setSegmentName(String segmentName)
          Sets the segment name of this LocationSpecification
 void setSegmentRepPosition(int segmentRepPosition)
          Sets the segment repetition position
 void setSpecifiedFieldPosition(boolean specifiedFieldPosition)
          Sets if the field position repetition position was set
 void setSpecifiedSegmentPosition(boolean specifiedSegmentPosition)
          Sets if the segment repetition was set
 void setSubcomponentPosition(int subcomponentPosition)
          Sets the subcomponent position
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocationSpecification

public LocationSpecification()
Creates a blank LocationSpecification

Method Detail

getSegmentName

public String getSegmentName()
Returns the segment name that was specified

Returns:
the segmentName

setSegmentName

public void setSegmentName(String segmentName)
Sets the segment name of this LocationSpecification

Parameters:
segmentName - the segmentName to set

getFieldPosition

public int getFieldPosition()
Gets the field position specified (or -1 if not specified)

Returns:
the fieldPosition

setFieldPosition

public void setFieldPosition(int fieldPosition)
Sets the field position

Parameters:
fieldPosition - the fieldPosition to set

getRepeatingFieldIndex

public int getRepeatingFieldIndex()
Gets the repeating field index (or -1 if not specified)

Returns:
the repeatingFieldNumber

setRepeatingFieldIndex

public void setRepeatingFieldIndex(int repeatingFieldIndex)
Sets the repeating field index

Parameters:
repeatingFieldIndex - the repeatingFieldNumber to set

getComponentPosition

public int getComponentPosition()
Gets the component position (or -1 if not specified)

Returns:
the componentPosition

setComponentPosition

public void setComponentPosition(int componentPosition)
Sets the component position

Parameters:
componentPosition - the componentPosition to set

getSubcomponentPosition

public int getSubcomponentPosition()
Gets the subcomponent position (or -1 not specified)

Returns:
the subcomponentPosition

setSubcomponentPosition

public void setSubcomponentPosition(int subcomponentPosition)
Sets the subcomponent position

Parameters:
subcomponentPosition - the subcomponentPosition to set

getSegmentRepPosition

public int getSegmentRepPosition()
Gets the segment repetition position (or -1 if not specified)

Returns:
the segmentRepPosition

setSegmentRepPosition

public void setSegmentRepPosition(int segmentRepPosition)
Sets the segment repetition position

Parameters:
segmentRepPosition - the segmentRepPosition to set

isSpecifiedSegmentPosition

public boolean isSpecifiedSegmentPosition()
Returns if the segment repetition was set

Returns:
the specifiedSegmentPosition

setSpecifiedSegmentPosition

public void setSpecifiedSegmentPosition(boolean specifiedSegmentPosition)
Sets if the segment repetition was set

Parameters:
specifiedSegmentPosition - the specifiedSegmentPosition to set

isSpecifiedFieldPosition

public boolean isSpecifiedFieldPosition()
Returns if the specified field repetition position was set

Returns:
the specifiedFieldPosition

setSpecifiedFieldPosition

public void setSpecifiedFieldPosition(boolean specifiedFieldPosition)
Sets if the field position repetition position was set

Parameters:
specifiedFieldPosition - the specifiedFieldPosition to set