|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectca.uhn.hl7v2.parser.Parser
ca.uhn.hl7v2.parser.OldPipeParser
public class OldPipeParser
This is a legacy implementation of the PipeParser and should not be used for new projects. In version 1.0 of HAPI, a behaviour was corrected where unexpected segments would be placed at the tail end of the first segment group encountered. Any legacy code which still depends on previous behaviour can use this implementation.
Constructor Summary | |
---|---|
OldPipeParser()
Deprecated. Creates a new PipeParser |
|
OldPipeParser(ModelClassFactory theFactory)
Deprecated. Creates a new PipeParser |
Method Summary | |
---|---|
protected java.lang.String |
doEncode(Message source)
Deprecated. Formats a Message object into an HL7 message string using this parser's default encoding ("VB"). |
protected java.lang.String |
doEncode(Message source,
java.lang.String encoding)
Deprecated. Formats a Message object into an HL7 message string using the given encoding. |
java.lang.String |
doEncode(Segment structure,
EncodingCharacters encodingCharacters)
Deprecated. Encodes a particular segment and returns the encoded structure |
java.lang.String |
doEncode(Type type,
EncodingCharacters encodingCharacters)
Deprecated. Encodes a particular type and returns the encoded structure |
protected Message |
doParse(java.lang.String message,
java.lang.String version)
Deprecated. Parses a message string and returns the corresponding Message object. |
static java.lang.String |
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). |
static java.lang.String |
encode(Segment source,
EncodingCharacters encodingChars)
Deprecated. |
static java.lang.String |
encode(Type source,
EncodingCharacters encodingChars)
Deprecated. Encodes the given Type, using the given encoding characters. |
java.lang.String |
getAckID(java.lang.String message)
Deprecated. For response messages, returns the value of MSA-2 (the message ID of the message sent by the sending system). |
Segment |
getCriticalResponseData(java.lang.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. |
java.lang.String |
getDefaultEncoding()
Deprecated. |
java.lang.String |
getEncoding(java.lang.String message)
Deprecated. Returns a String representing the encoding of the given message, if the encoding is recognized. |
java.lang.String |
getMessageStructure(java.lang.String message)
Deprecated. this method should not be public |
java.lang.String |
getVersion(java.lang.String message)
Deprecated. Returns the version ID (MSH-12) from the given message, without fully parsing the message. |
void |
parse(Message message,
java.lang.String string)
Deprecated. Parses a particular message and returns the encoded structure |
void |
parse(Segment destination,
java.lang.String segment,
EncodingCharacters encodingChars)
Deprecated. Parses a segment string and populates the given Segment object. |
void |
parse(Type destinationField,
java.lang.String data,
EncodingCharacters encodingCharacters)
Deprecated. Fills a field with values from an unparsed string representing the field. |
static java.lang.String[] |
split(java.lang.String composite,
java.lang.String delim)
Deprecated. Splits the given composite string into an array of components using the given delimiter. |
static java.lang.String |
stripLeadingWhitespace(java.lang.String in)
Deprecated. Removes leading whitespace from the given string. |
boolean |
supportsEncoding(java.lang.String encoding)
Deprecated. Returns true if and only if the given encoding is supported by this Parser. |
Methods inherited from class ca.uhn.hl7v2.parser.Parser |
---|
encode, encode, getFactory, getMessageStructureForEvent, getMessageStructures, getValidationContext, getValidVersions, instantiateMessage, makeControlMSH, parse, setValidationContext, validVersion |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OldPipeParser()
public OldPipeParser(ModelClassFactory theFactory)
theFactory
- custom factory to use for model class lookupMethod Detail |
---|
public java.lang.String getEncoding(java.lang.String message)
getEncoding
in class Parser
public java.lang.String getDefaultEncoding()
getDefaultEncoding
in class Parser
public boolean supportsEncoding(java.lang.String encoding)
supportsEncoding
in class Parser
public java.lang.String getMessageStructure(java.lang.String message) throws HL7Exception, EncodingNotSupportedException
message
-
HL7Exception
EncodingNotSupportedException
protected Message doParse(java.lang.String message, java.lang.String version) throws HL7Exception, EncodingNotSupportedException
doParse
in class Parser
message
- a String that contains an HL7 messageversion
- the name of the HL7 version to which the message belongs (eg "2.5")
HL7Exception
- if the message is not correctly formatted.
EncodingNotSupportedException
- if the message encoded
is not supported by this parser.public void parse(Segment destination, java.lang.String segment, EncodingCharacters encodingChars) throws HL7Exception
parse
in class Parser
destination
- The segment to encodesegment
- The string to parseencodingChars
- The encoding characters
HL7Exception
- if the given string does not contain the
given segment or if the string is not encoded properlypublic void parse(Type destinationField, java.lang.String data, EncodingCharacters encodingCharacters) throws HL7Exception
parse
in class Parser
destinationField
- the field Typedata
- the field string (including all components and subcomponents; not including field delimiters)encodingCharacters
- the encoding characters used in the message
HL7Exception
- If there is a problem encodingpublic static java.lang.String[] split(java.lang.String composite, java.lang.String delim)
public static java.lang.String encode(Type source, EncodingCharacters encodingChars)
protected java.lang.String doEncode(Message source, java.lang.String encoding) throws HL7Exception, EncodingNotSupportedException
doEncode
in class Parser
source
- a Message object from which to construct an encoded message stringencoding
- the name of the HL7 encoding to use (eg "XML"; most implementations support only
one encoding)
HL7Exception
- if the data fields in the message do not permit encoding
(e.g. required fields are null)
EncodingNotSupportedException
- if the requested encoding is not
supported by this parser.protected java.lang.String doEncode(Message source) throws HL7Exception
doEncode
in class Parser
source
- a Message object from which to construct an encoded message string
HL7Exception
- if the data fields in the message do not permit encoding
(e.g. required fields are null)public static java.lang.String encode(Group source, EncodingCharacters encodingChars) throws HL7Exception
HL7Exception
public static java.lang.String encode(Segment source, EncodingCharacters encodingChars)
public static java.lang.String stripLeadingWhitespace(java.lang.String in)
public Segment getCriticalResponseData(java.lang.String message) throws HL7Exception
Returns a minimal amount of data from a message string, including only the data needed to send a response to the remote system. This includes the following fields:
getCriticalResponseData
in class Parser
HL7Exception
public java.lang.String getAckID(java.lang.String message)
getAckID
in class Parser
public java.lang.String getVersion(java.lang.String message) throws HL7Exception
getVersion
in class Parser
HL7Exception
- if the version field can not be found.public java.lang.String doEncode(Segment structure, EncodingCharacters encodingCharacters) throws HL7Exception
doEncode
in class Parser
structure
- The structure to encodeencodingCharacters
- The encoding characters
HL7Exception
- If there is a problem encodingpublic java.lang.String doEncode(Type type, EncodingCharacters encodingCharacters) throws HL7Exception
doEncode
in class Parser
type
- The type to encodeencodingCharacters
- The encoding characters
HL7Exception
- If there is a problem encodingpublic void parse(Message message, java.lang.String string) throws HL7Exception
Parser
parse
in class Parser
message
- The message to encodestring
- The string to parse
HL7Exception
- If there is a problem encoding
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |