| Modifier and Type | Class and Description |
|---|---|
class |
UndefinedTableException
Deprecated.
should be moved to sourcegen
|
class |
UnknownValueException
Deprecated.
should be moved to sourcegen
|
| Modifier and Type | Method and Description |
|---|---|
void |
HL7Exception.populate(Segment errorSegment,
String theJdbcUrl)
Populates the given error segment with information from this Exception.
|
| Modifier and Type | Method and Description |
|---|---|
Connection |
ConnectionHub.attach(ca.uhn.hl7v2.app.ConnectionData data) |
Connection |
ConnectionHub.attach(String host,
int outboundPort,
int inboundPort,
Parser parser,
Class<? extends LowerLayerProtocol> llpClass) |
Connection |
ConnectionHub.attach(String host,
int outboundPort,
int inboundPort,
Parser parser,
Class<? extends LowerLayerProtocol> llpClass,
boolean tls) |
Connection |
ConnectionHub.attach(String host,
int outboundPort,
int inboundPort,
Parser parser,
LowerLayerProtocol llp,
boolean tls) |
Connection |
ConnectionHub.attach(String host,
int port,
Parser parser,
Class<? extends LowerLayerProtocol> llpClass)
Returns a Connection to the given address, opening this Connection if
necessary.
|
Connection |
ConnectionHub.attach(String host,
int port,
Parser parser,
Class<? extends LowerLayerProtocol> llpClass,
boolean tls) |
Connection |
ConnectionHub.attach(String host,
int port,
Parser parser,
LowerLayerProtocol llp,
boolean tls) |
void |
TestPanel.encodeInbound()
Deprecated.
Encodes the message that is currently displayed in the tree into a
traditionally encoded message string and displays in the inbound message
text box.
|
void |
TestPanel.encodeOutbound()
Deprecated.
Encodes the message that is currently displayed in the outbound tree into
a traditionally encoded message string and displays in a new window.
|
static void |
DefaultApplication.fillResponseHeader(Segment inbound,
Segment outbound)
Populates certain required fields in a response message header, using
information from the corresponding inbound message.
|
void |
HL7Service.loadApplicationsFromFile(File f)
A convenience method for registering applications (using
registerApplication()
) with this service. |
static String |
Responder.logAndMakeErrorMessage(Exception e,
Segment inHeader,
Parser p,
String encoding)
Logs the given exception and creates an error message to send to the
remote system.
|
static Message |
DefaultApplication.makeACK(Message message)
Creates an ACK message with the minimum required information from an
inbound message.
|
static Message |
DefaultApplication.makeACK(Segment inboundHeader) |
void |
TestPanel.parseOutbound()
Deprecated.
Attempts to parse the contents of the outbound message text box into a
message object and display in the outbound message tree.
|
String |
MessageTypeRouter.processException(String incomingMessage,
String outgoingMessage,
Exception e)
Forwards the given exception to all Applications.
|
String |
ApplicationExceptionHandler.processException(String incomingMessage,
String outgoingMessage,
Exception e)
Process an exception.
|
Message |
Application.processMessage(Message in)
Uses the contents of the message for whatever purpose the Application
has for this message, and returns an appropriate response message.
|
protected String |
Responder.processMessage(String incomingMessageString)
Processes an incoming message string and returns the response message
string.
|
Message |
Initiator.sendAndReceive(Message out)
Sends a message to a responder system, receives the reply, and returns
the reply as a Message object.
|
| Constructor and Description |
|---|
TestPanel()
Deprecated.
Creates a new instance of TestPanel
|
| Modifier and Type | Class and Description |
|---|---|
class |
ProfileNotFollowedException
An exception indicating that some message contents don't reflect a static profile.
|
class |
ProfileNotHL7CompliantException
An exception indicating that a static profile doesn't correspond to HL7 rules.
|
class |
XElementPresentException
An element that a profile defines as "not used" (X) is present in the
message.
|
| Modifier and Type | Method and Description |
|---|---|
protected HL7Exception |
DefaultValidator.testCardinality(int reps,
int min,
int max,
String usage,
String name)
Checks cardinality and creates an appropriate exception if out
of bounds.
|
HL7Exception[] |
DefaultValidator.testComponent(Type type,
Component profile,
String profileID) |
HL7Exception[] |
DefaultValidator.testField(Type type,
Field profile,
boolean escape,
String profileID) |
HL7Exception[] |
DefaultValidator.testGroup(Group group,
AbstractSegmentContainer profile,
String profileID)
Tests a group against a group section of a profile.
|
HL7Exception |
DefaultValidator.testLength(Type type,
int maxLength)
Tests whether the given type falls within a maximum length.
|
HL7Exception[] |
DefaultValidator.testSegment(Segment segment,
Seg profile,
String profileID)
Tests a segment against a segment section of a profile.
|
HL7Exception[] |
DefaultValidator.testStructure(Structure s,
ProfileStructure profile,
String profileID)
Tests a structure (segment or group) against the corresponding part of a profile.
|
HL7Exception[] |
DefaultValidator.testType(Type type,
AbstractComponent profile,
String encoded,
String profileID)
Tests a Type against the corresponding section of a profile.
|
HL7Exception[] |
Validator.validate(Message message,
StaticDef profile)
Validates the given message against the given static definition from
a conformance profile.
|
HL7Exception[] |
DefaultValidator.validate(Message message,
StaticDef profile) |
| Modifier and Type | Method and Description |
|---|---|
HL7Exception[] |
Validator.validate(Message message,
StaticDef profile)
Validates the given message against the given static definition from
a conformance profile.
|
HL7Exception[] |
DefaultValidator.validate(Message message,
StaticDef profile) |
| Modifier and Type | Class and Description |
|---|---|
class |
DataTypeException
Represents a problem with the validity of a data type, such as an attempt
to set the value of a primitive type to something invalid for that type.
|
| Modifier and Type | Method and Description |
|---|---|
Message |
Message.generateACK(String theAcknowldegementCode,
HL7Exception theException)
Generates and returns an ACK message which would be used to
acknowledge this message successfully.
|
Message |
AbstractMessage.generateACK(String theAcknowledgementCode,
HL7Exception theException)
Generates and returns an ACK message which would be used to
acknowledge this message successfully.
|
| Modifier and Type | Method and Description |
|---|---|
protected String |
AbstractGroup.add(Class<? extends Structure> c,
boolean required,
boolean repeating)
Adds a new Structure (group or segment) to this Group.
|
protected String |
AbstractGroup.add(Class<? extends Structure> c,
boolean required,
boolean repeating,
int index)
Adds a new Structure (group or segment) to this Group.
|
protected void |
AbstractSegment.add(Class<? extends Type> c,
boolean required,
int maxReps,
int length,
Object[] constructorArgs)
Deprecated.
|
protected void |
AbstractSegment.add(Class<? extends Type> c,
boolean required,
int maxReps,
int length,
Object[] constructorArgs,
String name)
Adds a field to the segment.
|
String |
Group.addNonstandardSegment(String name)
Expands the group definition to include a segment that is not
defined by HL7 to be part of this group (eg an unregistered Z segment).
|
String |
AbstractGroup.addNonstandardSegment(String name)
Expands the group definition to include a segment that is not defined by
HL7 to be part of this group (eg an unregistered Z segment).
|
String |
Group.addNonstandardSegment(String name,
int theIndex)
Expands the group definition to include a segment that is not
defined by HL7 to be part of this group (eg an unregistered Z segment).
|
String |
AbstractGroup.addNonstandardSegment(String theName,
int theIndex) |
int |
AbstractGroup.currentReps(String name)
Returns the number of existing repetitions of the named structure.
|
String |
Varies.encode()
Encodes this type using HL7 encoding.
|
String |
Type.encode()
Encodes this type using HL7 encoding.
|
String |
Segment.encode()
Encodes this message using the parser returned by
Message.getParser() |
String |
Message.encode()
Encodes this message using the parser returned by
Message.getParser() |
String |
AbstractType.encode()
Encodes this type using HL7 encoding.
|
String |
AbstractSegment.encode()
Encodes this message using the parser returned by
Message.getParser() |
String |
AbstractPrimitive.encode()
Encodes this type using HL7 encoding.
|
String |
AbstractMessage.encode()
Encodes this message using the parser returned by
Message.getParser() |
static void |
Varies.fixOBX5(Segment segment,
ModelClassFactory factory)
Sets the data type of field 5 in the given OBX segment to the value of OBX-2.
|
static void |
Varies.fixOBX5(Segment segment,
ModelClassFactory factory,
ParserConfiguration parserConfiguration)
Sets the data type of field 5 in the given OBX segment to the value of OBX-2.
|
Message |
Message.generateACK()
Generates and returns an ACK message which would be used to
acknowledge this message successfully, with an MSA-1 code of "AA".
|
Message |
AbstractMessage.generateACK()
Generates and returns an ACK message which would be used to
acknowledge this message successfully, with an MSA-1 code of "AA".
|
Message |
Message.generateACK(String theAcknowldegementCode,
HL7Exception theException)
Generates and returns an ACK message which would be used to
acknowledge this message successfully.
|
Message |
AbstractMessage.generateACK(String theAcknowledgementCode,
HL7Exception theException)
Generates and returns an ACK message which would be used to
acknowledge this message successfully.
|
Structure |
Group.get(String name)
Returns the named structure.
|
Structure |
AbstractGroup.get(String name)
Returns the named structure.
|
Structure |
Group.get(String name,
int rep)
Returns a particular repetition of the named Structure.
|
Structure |
AbstractGroup.get(String name,
int rep)
Returns a particular repetition of the named Structure.
|
Structure[] |
Group.getAll(String name)
Returns an array of Structure objects by name.
|
Structure[] |
AbstractGroup.getAll(String name)
Returns an array of Structure objects by name.
|
protected <T extends Structure> |
AbstractGroup.getAllAsList(String name,
Class<T> theType)
Returns a list containing all existing repetitions of the structure
identified by name
|
String |
Message.getEncodingCharactersValue()
Convenience method which retrieves the encoding characters value from the second field of the first segment.
|
String |
AbstractMessage.getEncodingCharactersValue()
Convenience method which retrieves the encoding characters value from the second field of the first segment.
|
Type[] |
Segment.getField(int number)
Returns the array of Fields at the specified index.
|
Type[] |
AbstractSegment.getField(int number)
Returns an array of Field objects at the specified location in the
segment.
|
Type |
Segment.getField(int number,
int rep)
Returns a specific repetition of field at the specified index.
|
Type |
AbstractSegment.getField(int number,
int rep)
Returns a specific repetition of field at the specified index.
|
int |
AbstractGroup.getFieldNumForName(String name)
Given a child structure name, returns the child index (which is 1-indexed, meaning
that the first child is at index 1
|
Character |
Message.getFieldSeparatorValue()
Convenience method which retrieves the field separator value from the first field of the first segment.
|
Character |
AbstractMessage.getFieldSeparatorValue()
Convenience method which retrieves the field separator value from the first field of the first segment.
|
int |
Segment.getLength(int number)
Returns the maximum length of the field at the given index, in characters.
|
int |
AbstractSegment.getLength(int number)
Returns the maximum length of the field at the given index, in characters
- fields are numbered from 1.
|
int |
Segment.getMaxCardinality(int number)
Returns the maximum number of repetitions of this field that are allowed.
|
int |
AbstractSegment.getMaxCardinality(int number)
Returns the number of repetitions of this field that are allowed.
|
void |
AbstractMessage.initQuickstart(String messageCode,
String messageTriggerEvent,
String processingId)
Quickly initializes this message with common values in the first (MSH) segment.
|
protected String |
AbstractGroup.insert(Class<? extends Structure> c,
boolean required,
boolean repeating,
int index,
String name)
Inserts the given structure into this group, at the indicated index
number.
|
protected Type |
AbstractSegment.insertRepetition(int fieldNum,
int index)
Inserts a repetition of a given Field into repetitions of that field by
name.
|
Structure |
AbstractGroup.insertRepetition(String name,
int index)
Inserts a repetition of a given Structure into repetitions of that
structure by name.
|
protected void |
AbstractGroup.insertRepetition(String name,
Structure structure,
int index)
Inserts a repetition of a given Structure into repetitions of that
structure by name.
|
boolean |
Group.isGroup(String name)
Returns true if the named structure is a group.
|
boolean |
AbstractGroup.isGroup(String name)
Returns true if the named structure is a group
|
boolean |
Group.isRepeating(String name)
Returns true if the named structure is repeating.
|
boolean |
AbstractGroup.isRepeating(String name)
Returns true if the named structure is required.
|
boolean |
Segment.isRequired(int number)
Returns true if the field at the given index is required, false otherwise.
|
boolean |
AbstractSegment.isRequired(int number)
Returns true if the given field is required in this segment - fields are
numbered from 1.
|
boolean |
Group.isRequired(String name)
Returns true if the named structure is required.
|
boolean |
AbstractGroup.isRequired(String name)
Returns true if the named structure is required.
|
void |
Varies.parse(String string)
Parses the string into this type and replaces the current contents with
the parsed value.
|
void |
Type.parse(String string)
Parses the string into this type and replaces the current contents with
the parsed value.
|
void |
Segment.parse(String string)
Parses the string into this segment using the parser returned by
Message.getParser() |
void |
Message.parse(String string)
Parses the string into this message using the parser returned by
Message.getParser() |
void |
AbstractType.parse(String string)
Parses the string into this type and replaces the current contents with
the parsed value.
|
void |
AbstractSegment.parse(String string)
Parses the string into this segment using the parser returned by
Message.getParser() |
void |
AbstractPrimitive.parse(String string)
Parses the string into this type and replaces the current contents with
the parsed value.
|
void |
AbstractMessage.parse(String string)
Parses the string into this message using the parser returned by
Message.getParser() |
String |
Message.printStructure()
Prints a summary of the contents and structure of this message.
|
String |
AbstractMessage.printStructure()
Prints a summary of the contents and structure of this message.
|
protected Type |
AbstractSegment.removeRepetition(int fieldNum,
int index)
Removes a repetition of a given field by name.
|
Structure |
AbstractGroup.removeRepetition(String name,
int index)
Removes a repetition of a given Structure objects by name.
|
protected Structure |
AbstractGroup.tryToInstantiateStructure(Class<? extends Structure> c,
String name)
Attempts to create an instance of the given class and return it as a
Structure.
|
| Modifier and Type | Class and Description |
|---|---|
class |
EncodingNotSupportedException
Represents a problem where a Parser does not support a particular HL7 encoding.
|
| Modifier and Type | Method and Description |
|---|---|
protected String |
XMLParser.doEncode(Message source)
Formats a Message object into an HL7 message string using this parser's
default encoding (XML encoding).
|
protected String |
PipeParser.doEncode(Message source)
Formats a Message object into an HL7 message string using this parser's
default encoding ("VB").
|
protected abstract String |
Parser.doEncode(Message source)
Called by encode(Message) to perform implementation-specific encoding work.
|
protected String |
OldPipeParser.doEncode(Message source)
Deprecated.
Formats a Message object into an HL7 message string using this parser's
default encoding ("VB").
|
protected String |
GenericParser.doEncode(Message source)
Formats a Message object into an HL7 message string using this parser's
default encoding.
|
protected String |
FastParser.doEncode(Message source)
Deprecated.
|
protected String |
XMLParser.doEncode(Message source,
String encoding)
Formats a Message object into an HL7 message string using the given
encoding.
|
protected String |
PipeParser.doEncode(Message source,
String encoding)
Formats a Message object into an HL7 message string using the given
encoding.
|
protected abstract String |
Parser.doEncode(Message source,
String encoding)
Called by encode(Message, String) to perform implementation-specific encoding work.
|
protected String |
OldPipeParser.doEncode(Message source,
String encoding)
Deprecated.
Formats a Message object into an HL7 message string using the given
encoding.
|
protected String |
GenericParser.doEncode(Message source,
String encoding)
Formats a Message object into an HL7 message string using the given
encoding.
|
protected String |
FastParser.doEncode(Message source,
String encoding)
Deprecated.
|
String |
XMLParser.doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Throws unsupported operation exception
|
String |
PipeParser.doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Encodes a particular segment and returns the encoded structure
|
abstract String |
Parser.doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Encodes a particular segment and returns the encoded structure
|
String |
OldPipeParser.doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Deprecated.
Encodes a particular segment and returns the encoded structure
|
String |
GenericParser.doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Encodes a particular segment and returns the encoded structure
|
String |
FastParser.doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Deprecated.
Not supported, throws UnsupportedOperationException
|
String |
XMLParser.doEncode(Type type,
EncodingCharacters encodingCharacters)
Throws unsupported operation exception
|
String |
PipeParser.doEncode(Type type,
EncodingCharacters encodingCharacters)
Encodes a particular type and returns the encoded structure
|
abstract String |
Parser.doEncode(Type type,
EncodingCharacters encodingCharacters)
Encodes a particular type and returns the encoded structure
|
String |
OldPipeParser.doEncode(Type type,
EncodingCharacters encodingCharacters)
Deprecated.
Encodes a particular type and returns the encoded structure
|
String |
GenericParser.doEncode(Type type,
EncodingCharacters encodingCharacters)
Encodes a particular type and returns the encoded structure
|
String |
FastParser.doEncode(Type type,
EncodingCharacters encodingCharacters)
Deprecated.
Not supported, throws UnsupportedOperationException
|
protected Message |
XMLParser.doParse(String message,
String version)
Parses a message string and returns the corresponding Message
object.
|
protected Message |
PipeParser.doParse(String message,
String version)
Parses a message string and returns the corresponding Message object.
|
protected abstract Message |
Parser.doParse(String message,
String version)
Called by parse() to perform implementation-specific parsing work.
|
protected Message |
OldPipeParser.doParse(String message,
String version)
Deprecated.
Parses a message string and returns the corresponding Message
object.
|
protected Message |
GenericParser.doParse(String message,
String version)
Parses a message string and returns the corresponding Message
object.
|
protected Message |
FastParser.doParse(String message,
String version)
Deprecated.
|
protected Message |
XMLParser.doParseForSpecificPackage(String theMessage,
String theVersion,
String thePackageName)
Throws unsupported operation exception
|
protected Message |
PipeParser.doParseForSpecificPackage(String message,
String version,
String packageName)
Attempt the parse a message using a specific model package
|
protected abstract Message |
Parser.doParseForSpecificPackage(String message,
String version,
String packageName)
Attempt the parse a message using a specific model package
|
protected Message |
OldPipeParser.doParseForSpecificPackage(String theMessage,
String theVersion,
String thePackageName)
Deprecated.
Throws unsupported operation exception
|
protected Message |
GenericParser.doParseForSpecificPackage(String theMessage,
String theVersion,
String thePackageName) |
protected Message |
FastParser.doParseForSpecificPackage(String theMessage,
String theVersion,
String thePackageName)
Deprecated.
Throws unsupported operation exception
|
static String |
PipeParser.encode(Group source,
EncodingCharacters encodingChars)
Returns given group serialized as a pipe-encoded string - this method is
called by encode(Message source, String encoding).
|
static String |
OldPipeParser.encode(Group source,
EncodingCharacters encodingChars)
Deprecated.
Returns given group serialized as a pipe-encoded string - this method is called
by encode(Message source, String encoding).
|
String |
PipeParser.encode(Message source)
Formats a Message object into an HL7 message string using this parser's
default encoding.
|
String |
Parser.encode(Message source)
Formats a Message object into an HL7 message string using this parser's
default encoding.
|
String |
Parser.encode(Message source,
String encoding)
Formats a Message object into an HL7 message string using the given
encoding.
|
boolean |
XMLParser.encode(Segment segmentObject,
Element segmentElement)
Populates the given Element with data from the given Segment, by inserting
Elements corresponding to the Segment's fields, their components, etc.
|
abstract Document |
XMLParser.encodeDocument(Message source)
Creates an XML Document that corresponds to the given Message object.
|
Document |
DefaultXMLParser.encodeDocument(Message source)
Creates an XML Document that corresponds to the given Message object.
|
protected Class<?> |
CustomModelClassFactory.findClass(String subpackage,
String name,
String version)
Finds appropriate classes to be loaded for the given structure/type
|
Segment |
XMLParser.getCriticalResponseData(String message)
Returns a minimal amount of data from a message string, including only the
data needed to send a response to the remote system.
|
Segment |
PipeParser.getCriticalResponseData(String message)
Returns a minimal amount of data from a message string, including only
the data needed to send a response to the remote system.
|
abstract Segment |
Parser.getCriticalResponseData(String message)
Returns a minimal amount of data from a message string, including only the
data needed to send a response to the remote system.
|
Segment |
OldPipeParser.getCriticalResponseData(String message)
Deprecated.
Returns a minimal amount of data from a message string, including only the
data needed to send a response to the remote system.
|
Segment |
GenericParser.getCriticalResponseData(String message)
Returns a minimal amount of data from a message string, including only the
data needed to send a response to the remote system.
|
Segment |
FastParser.getCriticalResponseData(String message)
Deprecated.
|
Class<? extends Group> |
ModelClassFactory.getGroupClass(String theName,
String theVersion) |
Class<? extends Group> |
DefaultModelClassFactory.getGroupClass(String theName,
String theVersion) |
Class<? extends Group> |
CustomModelClassFactory.getGroupClass(String name,
String version) |
Class<? extends Group> |
CanonicalModelClassFactory.getGroupClass(String theName,
String theVersion) |
static EncodingCharacters |
EncodingCharacters.getInstance(Message message)
Returns an instance using the MSH-1 and MSH-2 values of the given message
|
Class<? extends Message> |
ModelClassFactory.getMessageClass(String theName,
String theVersion,
boolean isExplicit) |
Class<? extends Message> |
DefaultModelClassFactory.getMessageClass(String theName,
String theVersion,
boolean isExplicit)
Attempts to return the message class corresponding to the given name, by
searching through default and user-defined (as per packageList()) packages.
|
Class<? extends Message> |
CustomModelClassFactory.getMessageClass(String name,
String version,
boolean isExplicit) |
Class<? extends Message> |
CanonicalModelClassFactory.getMessageClass(String theName,
String theVersion,
boolean theIsExplicit)
Attempts to return the message class corresponding to the given name, by
searching through default and user-defined (as per packageList()) packages.
|
Class<? extends Message> |
ModelClassFactory.getMessageClassInASpecificPackage(String theName,
String theVersion,
boolean isExplicit,
String packageName)
Retrieves and instantiates a message class by looking in a specific java package for the
message type.
|
Class<? extends Message> |
DefaultModelClassFactory.getMessageClassInASpecificPackage(String theName,
String theVersion,
boolean isExplicit,
String packageName)
Retrieves and instantiates a message class by looking in a specific java package for the
message type.
|
Class<? extends Message> |
CustomModelClassFactory.getMessageClassInASpecificPackage(String theName,
String theVersion,
boolean theIsExplicit,
String thePackageName)
|
String |
PipeParser.getMessageStructure(String message)
Deprecated.
this method should not be public
|
String |
OldPipeParser.getMessageStructure(String message)
Deprecated.
this method should not be public
|
static String |
Parser.getMessageStructureForEvent(String name,
String version)
Given a concatenation of message type and event (e.g.
|
Class<? extends Segment> |
ModelClassFactory.getSegmentClass(String theName,
String theVersion) |
Class<? extends Segment> |
DefaultModelClassFactory.getSegmentClass(String theName,
String theVersion) |
Class<? extends Segment> |
CustomModelClassFactory.getSegmentClass(String name,
String version) |
Class<? extends Segment> |
CanonicalModelClassFactory.getSegmentClass(String theName,
String theVersion) |
Class<? extends Type> |
ModelClassFactory.getTypeClass(String theName,
String theVersion) |
Class<? extends Type> |
DefaultModelClassFactory.getTypeClass(String theName,
String theVersion) |
Class<? extends Type> |
CustomModelClassFactory.getTypeClass(String name,
String version) |
Class<? extends Type> |
CanonicalModelClassFactory.getTypeClass(String theName,
String theVersion) |
String |
XMLParser.getVersion(String message) |
String |
PipeParser.getVersion(String message)
Returns the version ID (MSH-12) from the given message, without fully
parsing the message.
|
abstract String |
Parser.getVersion(String message)
Returns the version ID (MSH-12) from the given message, without fully parsing the message.
|
String |
OldPipeParser.getVersion(String message)
Deprecated.
Returns the version ID (MSH-12) from the given message, without fully parsing the message.
|
String |
GenericParser.getVersion(String message)
Returns the version ID (MSH-12) from the given message, without fully parsing the message.
|
String |
FastParser.getVersion(String message)
Deprecated.
|
static String |
DefaultModelClassFactory.getVersionPackageName(String ver)
Returns the package name for model elements of the given version - e.g.
|
static String |
DefaultModelClassFactory.getVersionPackagePath(String ver)
Returns the path to the base package for model elements of the given version
- e.g.
|
protected Message |
Parser.instantiateMessage(String theName,
String theVersion,
boolean isExplicit)
Note that the validation context of the resulting message is set to this parser's validation
context.
|
protected Message |
Parser.instantiateMessageInASpecificPackage(String theName,
String theVersion,
boolean isExplicit,
String packageName)
Instantiate a message type using a specific package name
|
static Map<Object,FastParser.StructRef> |
FastParser.loadEventGuideMap(URL theMapURL)
Deprecated.
Loads a parsing guide map (as required for FastParser instantiation).
|
static void |
GenericParser.main(String[] args) |
static Segment |
Parser.makeControlMSH(String version,
ModelClassFactory factory)
Creates a version-specific MSH object and returns it as a version-independent
MSH interface.
|
static String[] |
DefaultModelClassFactory.packageList(String version)
Lists all the packages (user-definable) where classes for standard and custom
messages may be found.
|
void |
PipeParser.parse(Message message,
String string) |
abstract void |
Parser.parse(Message message,
String string)
Parses a particular message and returns the encoded structure
|
void |
OldPipeParser.parse(Message message,
String string)
Deprecated.
|
void |
GenericParser.parse(Message message,
String string) |
void |
FastParser.parse(Message message,
String string)
Deprecated.
Not supported, throws UnsupportedOperationException
|
void |
DefaultXMLParser.parse(Message theMessage,
String theString)
Parses a particular message and returns the encoded structure
|
void |
XMLParser.parse(Segment segmentObject,
Element segmentElement)
Populates the given Segment object with data from the given XML Element.
|
void |
XMLParser.parse(Segment segment,
String string,
EncodingCharacters encodingCharacters)
Throws unsupported operation exception
|
void |
PipeParser.parse(Segment destination,
String segment,
EncodingCharacters encodingChars)
Parses a segment string and populates the given Segment object.
|
abstract void |
Parser.parse(Segment segment,
String string,
EncodingCharacters encodingCharacters)
Parses a particular segment and returns the encoded structure
|
void |
OldPipeParser.parse(Segment destination,
String segment,
EncodingCharacters encodingChars)
Deprecated.
Parses a segment string and populates the given Segment object.
|
void |
GenericParser.parse(Segment segment,
String string,
EncodingCharacters encodingCharacters)
Parses a particular segment and returns the encoded structure
|
void |
FastParser.parse(Segment segment,
String string,
EncodingCharacters encodingCharacters)
Deprecated.
Not supported, throws UnsupportedOperationException
|
void |
PipeParser.parse(Segment destination,
String segment,
EncodingCharacters encodingChars,
Integer theRepetition)
Parses a segment string and populates the given Segment object.
|
Message |
PipeParser.parse(String message)
Parses a message string and returns the corresponding Message object.
|
Message |
Parser.parse(String message)
Parses a message string and returns the corresponding Message object.
|
void |
XMLParser.parse(Type type,
String string,
EncodingCharacters encodingCharacters)
Throws unsupported operation exception
|
void |
PipeParser.parse(Type destinationField,
String data,
EncodingCharacters encodingCharacters)
Fills a field with values from an unparsed string representing the field.
|
abstract void |
Parser.parse(Type type,
String string,
EncodingCharacters encodingCharacters)
Parses a particular type and returns the encoded structure
|
void |
OldPipeParser.parse(Type destinationField,
String data,
EncodingCharacters encodingCharacters)
Deprecated.
Fills a field with values from an unparsed string representing the field.
|
void |
GenericParser.parse(Type type,
String string,
EncodingCharacters encodingCharacters)
Parses a particular type and returns the encoded structure
|
void |
FastParser.parse(Type type,
String string,
EncodingCharacters encodingCharacters)
Deprecated.
Not supported, throws UnsupportedOperationException
|
abstract Message |
XMLParser.parseDocument(Document XMLMessage,
String version)
Creates and populates a Message object from an XML Document that contains an XML-encoded HL7 message.
|
Message |
DefaultXMLParser.parseDocument(Document XMLMessage,
String version)
Creates and populates a Message object from an XML Document that contains an XML-encoded HL7 message.
|
Message |
Parser.parseForSpecificPackage(String message,
String packageName)
Parse a message using a specific model package instead of the default, using
ModelClassFactory.getMessageClassInASpecificPackage(String, String, boolean, String). |
protected String |
XMLParser.parseLeaf(String message,
String tagName,
int startAt)
Attempts to retrieve the value of a leaf tag without using DOM or SAX.
|
protected Document |
XMLParser.parseStringIntoDocument(String message)
Parses a string containing an XML document into a Document object.
|
int |
MessagePointer.setSegment(String segment)
Deprecated.
Parses the given String, which must contain a single traditionally encoded
message segment, by forwarding it to child GroupPointers and SegmentPointers
until one of them succeeds.
|
int |
SegmentPointer.setSegment(String segment,
boolean correctOrder)
Deprecated.
Parses the given String, which must contain a single traditionally encoded
message segment, into the current repetition of the message Structure
underlying this Pointer.
|
abstract int |
Pointer.setSegment(String segment,
boolean correctOrder)
Deprecated.
Parses the given String, which must contain a single traditionally encoded
message segment, into the current repetition of the message Structure
underlying this Pointer.
|
int |
GroupPointer.setSegment(String segment,
boolean orderedCorrectly)
Deprecated.
Parses the given String, which must contain a single traditionally encoded
message segment, into the current repetition of the message Group
underlying this Pointer by forwarding it to each of it's children until
one of them succeeds.
|
| Constructor and Description |
|---|
GroupPointer(PipeParser parser,
Group parent,
int position,
EncodingCharacters encodingChars)
Deprecated.
Creates new GroupPointer
|
MessagePointer(PipeParser parser,
Message message,
EncodingCharacters encodingChars)
Deprecated.
Creates new GroupPointer
|
SegmentPointer(PipeParser parser,
Group parent,
int position,
EncodingCharacters encodingChars)
Deprecated.
Creates new SegmentPointer
|
| Modifier and Type | Method and Description |
|---|---|
static String[] |
PreParser.getFields(String theMessageText,
String... thePathSpecs)
Extracts selected fields from a message.
|
static boolean |
XML.parseMessage(Properties props,
String message,
Collection<DatumPath> msgMask)
parse message according to our HL7 XML handler, and dump the data found
to props.
|
| Modifier and Type | Class and Description |
|---|---|
class |
TransportException
Represents a problem that has occured during transport of a
message string to / from some other server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Processor.cycle(boolean expectingAck)
Performs a single iteration of the receiving-side
of the HL7 original mode or enhanced mode processing rules
(see HL7 Standard v2.5 Chapter 2; the choice of rules
is determined by message values).
|
void |
SafeStorage.discard(Transportable theMessage)
If the given message exists in the store, it is removed.
|
Message |
ReceivingApplication.processMessage(Message theMessage,
Map<String,Object> theMetadata)
Uses the contents of the message for whatever purpose the application
has for this message, and returns an appropriate response message.
|
Transportable |
ApplicationRouter.processMessage(Transportable theMessage)
Attempts to route the given message to the associated
Application
and obtain a response. |
Transportable |
Processor.receive(String theAckId,
long theTimeoutMillis)
Gets the message with the given acknowledgement ID from
the incoming message list.
|
Transportable[] |
SafeStorage.restore()
Returns all messages that have been stored.
|
void |
Processor.send(Transportable theMessage,
int maxRetries,
long retryIntervalMillis)
Sends a message to a remote system via an underlying
TransportLayer. |
Message |
Initiator.sendAndReceive(Message theMessage)
Encodes a message, sends it to a remote system, awaits the response,
parses it, and returns it.
|
void |
SafeStorage.store(Transportable theMessage)
Stores a message so that it can be reliably retrieved and sent to
the proper application, even if this service is restarted in the mean
time.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
ParseChecker.checkParse(String originalMessageText,
Message parsedMessage,
Parser parser)
Encodes the given message and compares it to the given string.
|
void |
ProcessorImpl.cycle(boolean expectingAck) |
void |
NullSafeStorage.discard(Transportable theMessage)
Does nothing.
|
static Map<String,String> |
MetadataExtractor.getFields(Message theMessage,
List<String> theTerserPaths) |
static void |
ApplicationLoader.loadApplications(ApplicationRouter theRouter,
URL theSource)
A convenience method for binding applications to an
ApplicationRouter
Information about bindings is read from a file at a specified URL. |
Message |
AppWrapper.processMessage(Message theMessage,
Map<String,Object> theMetadata) |
Transportable |
ApplicationRouterImpl.processMessage(Transportable theMessage) |
Transportable |
ProcessorImpl.receive(String theAckId,
long theTimeoutMillis) |
Transportable[] |
NullSafeStorage.restore()
Returns an empty array.
|
void |
ProcessorImpl.send(Transportable theMessage,
int maxRetries,
long retryIntervalMillis) |
Message |
InitiatorImpl.sendAndReceive(Message theMessage) |
void |
NullSafeStorage.store(Transportable theMessage)
Does nothing.
|
static AcceptAcknowledger.AcceptACK |
AcceptAcknowledger.validate(ProcessorContext theContext,
Transportable theMessage)
Validates the given message against our accept validators, attempts to commit
the message to safe storage, and returns an ACK message indicating acceptance
or rejection at the accept level (see enhanced mode processing rules in HL7
chapter 2, v2.5).
|
| Modifier and Type | Method and Description |
|---|---|
static HL7Exception |
ParseTester.parsesCorrectly(String context,
String message)
Deprecated.
Checks whether the given message parses correctly with a GenericParser.
|
HL7Exception[] |
ParseTester.testAll()
Deprecated.
Tests all remaining messages available from the currrent source.
|
HL7Exception[] |
ParseTester.testAll(File source)
Deprecated.
Sets the source reader to point to the given file, and tests
all the messages therein (if a directory, processes all contained
files recursively).
|
| Modifier and Type | Method and Description |
|---|---|
static void |
DeepCopy.copy(Segment from,
Segment to)
Copies contents from the source segment to the destination segment.
|
void |
MessageNavigator.drillDown(int rep)
Drills down into the group at the CURRENT location.
|
void |
MessageNavigator.drillDown(int childNumber,
int rep)
Drills down into the group at the given index within the current
group -- ie sets the location pointer to the first structure within the child
|
static boolean |
EncodedMessageComparator.equivalent(String message1,
String message2)
Compares two HL7 messages to see if they are equivalent (in terms of their
HL7 meaning).
|
Group |
SegmentFinder.findGroup(String namePattern,
int rep)
As findSegment(), but will only return a group.
|
Segment |
SegmentFinder.findSegment(String namePattern,
int rep)
Returns the first segment with a name that matches the given pattern, in a depth-first search.
|
static String |
Terser.get(Segment segment,
int field,
int rep,
int component,
int subcomponent)
Returns the string value of the Primitive at the given location.
|
String |
Terser.get(String spec)
Gets the string value of the field specified.
|
Structure[] |
MessageNavigator.getCurrentChildReps()
Returns the array of structures at the current location.
|
Structure |
MessageNavigator.getCurrentStructure(int rep)
Returns the given rep of the structure at the current location.
|
Group |
SegmentFinder.getGroup(String namePattern,
int rep)
As getSegment() but will only return a group.
|
static int[] |
Terser.getIndices(String spec)
Given a Terser path, returns an array containing field num, field rep,
component, and subcomponent.
|
static CodeMapper |
CodeMapper.getInstance()
Returns a singleton instance of CodeMapper.
|
static String |
CodeMapper.getInt(String interfaceName,
int hl7Table,
String localCode)
A convenience method that returns an interface code from an underlying
CodeMapper instance by calling
CodeMapper.getInstance().getInterfaceCode(...) |
String |
FileCodeMapper.getInterfaceCode(String interfaceName,
int hl7Table,
String localCode)
Returns the interface code for the given local code, for use in the context
of the given interface.
|
abstract String |
CodeMapper.getInterfaceCode(String interfaceName,
int hl7Table,
String localCode)
Returns the interface code for the given local code, for use in the context
of the given interface.
|
static String |
CodeMapper.getLocal(String interfaceName,
int hl7Table,
String interfaceCode)
A convenience method that returns a local code from an underlying
CodeMapper instance by calling
CodeMapper.getInstance().getLocalCode(...) |
String |
FileCodeMapper.getLocalCode(String interfaceName,
int hl7Table,
String interfaceCode)
Returns the local code for the given interface code as it appears in
the given interface.
|
abstract String |
CodeMapper.getLocalCode(String interfaceName,
int hl7Table,
String interfaceCode)
Returns the local code for the given interface code as it appears in
the given interface.
|
Segment |
Terser.getSegment(String segSpec)
Returns the segment specified in the given segment_path_spec.
|
Segment |
SegmentFinder.getSegment(String namePattern,
int rep)
Returns the first segment with a name matching the given pattern that is a sibling of
the structure at the current location.
|
static Message |
ReflectionUtil.instantiateMessage(Class<? extends Message> theType,
ModelClassFactory theModelClassFactory) |
void |
MessageNavigator.iterate(boolean segmentsOnly,
boolean loop)
Iterates through the message tree to the next segment/group location (regardless
of whether an instance of the segment exists).
|
static boolean |
MessageIterator.matchExistsAfterPosition(MessageIterator.Position pos,
String name,
boolean firstDescendentsOnly,
boolean upToFirstRequired)
A match exists for the given name somewhere after the given position (in the
normal serialization order).
|
boolean |
MessageQuery.Result.next()
Advances to the next "row" of data if one is available.
|
void |
MessageNavigator.nextChild()
Moves to the next sibling of the current location.
|
void |
FileCodeMapper.refreshCache()
If values are cached in such a way that they are not guaranteed to be current, a call
to this method refreshes the values.
|
abstract void |
CodeMapper.refreshCache()
If values are cached in such a way that they are not guaranteed to be current, a call
to this method refreshes the values.
|
static void |
Terser.set(Segment segment,
int field,
int rep,
int component,
int subcomponent,
String value)
Sets the string value of the Primitive at the given location.
|
void |
Terser.set(String spec,
String value)
Sets the string value of the field specified.
|
void |
MessageNavigator.toChild(int child)
Moves to the sibling of the current location at the specified index.
|
| Constructor and Description |
|---|
FileCodeMapper()
Creates a new instance of FileCodeMapper.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
MessageValidator.validate(Message message) |
boolean |
MessageValidator.validate(String message,
boolean isXML,
String version) |
| Modifier and Type | Method and Description |
|---|---|
abstract HL7Exception[] |
TestApplication.test(Message in)
Deprecated.
Tests the message in some way (as defined by implementing class).
|
HL7Exception[] |
ProfileTestApplication.test(Message in)
Deprecated.
Tests the message against a profile or profiles.
|
HL7Exception[] |
MultiTestApplication.test(Message in)
Deprecated.
Tests the message by passing it to all test apps that have been registered
using addTest().
|
| Modifier and Type | Method and Description |
|---|---|
Message |
TestApplication.processMessage(Message in)
Deprecated.
Calls test(Message in), routes resulting exceptions to configured destinations, and
returns an ack (which should not normally be used since the test app is intended
to operate in parallel with system-to-system communication).
|
abstract HL7Exception[] |
TestApplication.test(Message in)
Deprecated.
Tests the message in some way (as defined by implementing class).
|
HL7Exception[] |
ProfileTestApplication.test(Message in)
Deprecated.
Tests the message against a profile or profiles.
|
HL7Exception[] |
MultiTestApplication.test(Message in)
Deprecated.
Tests the message by passing it to all test apps that have been registered
using addTest().
|
Copyright © 2001-2012 University Health Network. All Rights Reserved.