org.urhl7.igor
Class Igor

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

public class Igor
extends Object

Igor is the main class that will begin the creation and using of relevent objects.


Method Summary
static HL7FieldComponent component()
          Creates an empty generic, stand-alone HL7FieldComponent
static HL7FieldComponent component(char[] delims, String data)
          Creates an generic, stand-alone HL7FieldComponent populated with data using non-default delimiters
static HL7FieldComponent component(String data)
          Creates an generic, stand-alone HL7FieldComponent populated with data
static HL7Field field()
          Creates a generic, stand-alone, empty HL7Field
static HL7Field field(char[] delims, String data)
          Creates a stand-alone HL7Field using non-default delimiters, populated with data
static HL7Field field(String data)
          Creates a generic, stand-alone HL7Field with data populated
static HL7RepeatingField quickField()
          Creates a HL7Repeating field with a child field, with no data in it.
static HL7RepeatingField quickField(char[] delims, String data)
          Creates a HL7Repeating field with a child HL7Field with data populated.
static HL7RepeatingField quickField(String data)
          Creates a HL7Repeating field with a child HL7Field with data populated.
static HL7RepeatingField repeatingField()
          Creates a stand-alone generic HL7Repeating field.
static HL7Segment segment(char[] delims, String segmentName)
          Creates a new stand-alone abstract HL7 segment, based off the segment name.
static HL7Segment segment(char[] delims, String segmentName, int fieldCount)
          Creates a stand alone HL7Segment that has single cardinality, empty fields attached to it.
static HL7Segment segment(String segmentName)
          Creates a new stand-alone abstract HL7 segment, based off the segment name.
static HL7Segment segment(String segmentName, int fieldCount)
          Creates a stand alone HL7Segment that has single cardinality, empty fields attached to it.
static HL7Structure structure()
          Creates an empty HL7Structure using default delimiters.
static HL7Structure structure(char[] delims)
          Creates an empty HL7Structure with MSH[delims] defined.
static HL7Structure structure(String hl7data)
          Static factory method to return a instantiated HL7Structure object.
static HL7FieldSubcomponent subcomponent()
          Creates an empty generic, stand-alone HL7FieldSubcomponent
static HL7FieldSubcomponent subcomponent(char[] delims, String data)
          Creates a populated stand-alone, generic HL7FieldSubcomponent using a non-standard delimiter set.
static HL7FieldSubcomponent subcomponent(String data)
          Creates a populated stand-alone, generic HL7FieldSubcomponent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

structure

public static HL7Structure structure()
Creates an empty HL7Structure using default delimiters. MSH|^~\& is defined.

Returns:
a blank HL7Structure

structure

public static HL7Structure structure(char[] delims)
Creates an empty HL7Structure with MSH[delims] defined.

Parameters:
delims - the delimiters to use for the message.
Returns:
an empty HL7Structure

structure

public static HL7Structure structure(String hl7data)
Static factory method to return a instantiated HL7Structure object. The object will auto sense what the encoded delimiters are and parse based off that

Parameters:
hl7data - the String of data
Returns:
a newly created HL7Structure object

segment

public static HL7Segment segment(String segmentName)
Creates a new stand-alone abstract HL7 segment, based off the segment name.

Parameters:
segmentName - the name of the segment
Returns:
an HL7Segment object

segment

public static HL7Segment segment(char[] delims,
                                 String segmentName)
Creates a new stand-alone abstract HL7 segment, based off the segment name. Using non-default delimiters.

Parameters:
delims - the delimiter set to use
segmentName - the name of the segment
Returns:
an HL7Segment object

segment

public static HL7Segment segment(String segmentName,
                                 int fieldCount)
Creates a stand alone HL7Segment that has single cardinality, empty fields attached to it. Using default delimiters.

Parameters:
segmentName - Name of the segment
fieldCount - Number of fields to have in the segment
Returns:
a segment with single cardinality repeating fields with blank fields in them

segment

public static HL7Segment segment(char[] delims,
                                 String segmentName,
                                 int fieldCount)
Creates a stand alone HL7Segment that has single cardinality, empty fields attached to it. Using non-default delimiters.

Parameters:
delims - delimiter set to use
segmentName - Name of the segment
fieldCount - Number of fields to have in the segment
Returns:
a segment with single cardinality repeating fields with blank fields in them

repeatingField

public static HL7RepeatingField repeatingField()
Creates a stand-alone generic HL7Repeating field.

Returns:
a new HL7RepeatingField

quickField

public static HL7RepeatingField quickField()
Creates a HL7Repeating field with a child field, with no data in it.

Returns:
a blank HL7RepeatingField with a blank child HL7Field populated

quickField

public static HL7RepeatingField quickField(String data)
Creates a HL7Repeating field with a child HL7Field with data populated.

Parameters:
data - the data to populate the underlying HL7Field with
Returns:
a HL7RepeatingField with a child HL7Field populated with data

quickField

public static HL7RepeatingField quickField(char[] delims,
                                           String data)
Creates a HL7Repeating field with a child HL7Field with data populated. Non-default specified delimiters will be used.

Parameters:
delims - delimiter set to use for this structure
data - the data to populate the underlying HL7Field with
Returns:
a HL7RepeatingField with a child HL7Field populated with data using non-default delimiters

field

public static HL7Field field()
Creates a generic, stand-alone, empty HL7Field

Returns:
an HL7Field

field

public static HL7Field field(String data)
Creates a generic, stand-alone HL7Field with data populated

Parameters:
data - the data to populate the field with
Returns:
a populated HL7Field

field

public static HL7Field field(char[] delims,
                             String data)
Creates a stand-alone HL7Field using non-default delimiters, populated with data

Parameters:
delims - delimiter set to use
data - the data to populate the field with
Returns:
a populated, custom delimited HL7Field

component

public static HL7FieldComponent component()
Creates an empty generic, stand-alone HL7FieldComponent

Returns:
an empty generic HL7FieldComponent

component

public static HL7FieldComponent component(String data)
Creates an generic, stand-alone HL7FieldComponent populated with data

Parameters:
data - the data to populate the HL7FieldComponent with
Returns:
a populated generic HL7FieldComponent

component

public static HL7FieldComponent component(char[] delims,
                                          String data)
Creates an generic, stand-alone HL7FieldComponent populated with data using non-default delimiters

Parameters:
delims - the delimiter set to use
data - the data to populate the HL7FieldComponent with
Returns:
a populated HL7FieldComponent

subcomponent

public static HL7FieldSubcomponent subcomponent()
Creates an empty generic, stand-alone HL7FieldSubcomponent

Returns:
a generic, empty HL7FieldSubcomponent

subcomponent

public static HL7FieldSubcomponent subcomponent(String data)
Creates a populated stand-alone, generic HL7FieldSubcomponent

Parameters:
data - the data to populate with
Returns:
an HL7FieldSubcomponent

subcomponent

public static HL7FieldSubcomponent subcomponent(char[] delims,
                                                String data)
Creates a populated stand-alone, generic HL7FieldSubcomponent using a non-standard delimiter set.

Parameters:
delims - the delimiters to use
data - the data to populate with
Returns:
an HL7FieldSubcomponent