Hl7PlusFileAnalyzer

FileMessageCount

Integer

The number of HL7 messages in SourceFileName.

NOTE: This property must be queried AFTER you call AnalyzeHL7File().

IsBusy

Boolean

Tells you whether the object is currently busy performing an analysis operation.

LastErrorType

EHFA_ErrorType

The ENUM describing the last error state of the object.

MaximumMessagesToLoad

Integer

Tells the object when (or if) it should stop discovering HL7 messages in SourceFileName when AnalyzeHL7File() is called. The default value is the MAX value of an integer so you can set this property to a lower value if you want to limit the scope or only want to retrieve the top <nn> messages from a very large data file.

ParentHL7Controller

HL7PlusController

The HL7PlusController used to create the file analyzer object (See Implementation above)

SourceFileExtension

String

The file extension portion of SourceFileName

SourceFileFolder

String

The Folder portion of SourceFileName including a trailing backslash.

SourceFileName

String

The full path / file name passed to the AnalyzeHL7File() method

SourceFileTitle

String

The File Title portion of SourceFileName including the FileExtension.

Tag

String

A general purpose String Tag value for your use.

Method:

AnalyzeHL7File(strFileName)

Paramters:

1: strFileName (String) the path/filename to analyze for HL7 messages

Return Value:

EHFA_ErrorType

Description:

Analyzes strFileName and maps all HL7 messages contained therein.

Method:

Clear()

Paramters:

None

Return Value:

Boolean

Description:

Clears the object for reuse with another file. Open files are closed and any current analysis functions are canceled.

Method:

GetHL7PlusMessage(nIndex)

Paramters:

1: nIndex(Int32) The Index (ordinal position starting with 1) of the HL7 message you wish to retrieve.

Return Value:

HL7PlusMessage (or Nothing if there is no message at nIndex).

Description:

AFTER a call to AnalyzeHL7File() call GetHL7PlusMessage() to retrieve a specific HL7PlusMessage within the file.

NOTE: The HL7PlusMessage object returned will have the SourceFileName and SourceFileIndex properties set.

Method:

GetHL7PlusMessages(Optional nStartingIndex = 1, Optional nEndingIndex = 0)

Paramters:

1: nStartingIndex (Int32) OPTIONAL Default = 1. The starting ordinal message you want to retrieve.

2: nEndingIndex (Int32) OPTIONAL Default = 0. The ending ordinal message you want to retrieve 0 = All (or MaximumMessagesToLoad)

Return Value:

List (of HL7PlusMessage)

Description:

AFTER a call to AnalyzeHL7File() call GetHL7PlusMessages() to retrieve a list of the HL7PlusMessage objects in the file.

NOTE: An EMPTY List object is returned if the file contains no HL7 messages within the range specified.

Method:

GetHL7PlusMessageString(nIndex)

Paramters:

1: nIndex(Int32) The Index (ordinal position starting with 1) of the HL7 message you wish to retrieve.

Return Value:

String

Description:

Works exactly like GetHL7PlusMessage() except the return value is the HL7 message as a String.

Method:

GetHL7PlusMessageStrings(Optional nStartingIndex = 1, Optional nEndingIndex = 0)

Paramters:

1: nStartingIndex (Int32) OPTIONAL Default = 1. The starting ordinal message you want to retrieve.

2: nEndingIndex (Int32) OPTIONAL Default = 0. The ending ordinal message you want to retrieve 0 = All (or MaximumMessagesToLoad)

Return Value:

List (of String)

Description:

Works exactly like GetHL7PlusMessages() except the return value is a List (of String).

NOTE: An EMPTY List object is returned if the file contains no HL7 messages within the range specified.

Method:

KillHL7File()

Paramters:

None

Return Value:

Boolean

Description:

Attempts to permanently delete SourceFileName.

Event:

AnalysisCompleted (enCompletionError)

Paramters:

1: enCompletionError (EHFA_ErrorType) - The error state when it completed the analysis.

Condition:

This event is fired when AnalyzeHL7File() completes or is canceled.

Event:

AnalyzingFile (blnCancelOperation = False, nPercentComplete)

Paramters:

1: blnCancelOperation (Boolean) - Will be False, set to True if you wish to cancel the analysis.

2: nPercentComplete (Int32) - Percentage completed of the analysis operation so far.

Condition:

This event is fired periodically as AnalyzeHL7File() is working. Note that this event may not be fired on very small data files.

Event:

GeneralErrorEvent()

Paramters:

None

Condition:

This event is fired if a system or other unexpected error occurs during an analysis or retrieval operation. Check the LastError and LastException property to get details of what the error actually is.

Event:

HL7PlusMessageDetected (blnCancelOperation = False, nMessageIndex)

Paramters:

1: blnCancelOperation (Boolean) - Will be False, set to True if you wish to cancel the analysis.

2: nMessageIndex (Int32) - Ordinal index of the message in the file.

Condition:

This event is fired periodically as AnalyzeHL7File() is working and a message is detected in the file.

Event:

LoadingHL7Messages (blnCancelOperation = False, nPercentComplete)

Paramters:

1: blnCancelOperation (Boolean) - Will be False, set to True if you wish to cancel the retrieval.

2: nPercentComplete (Int32) - Percentage completed of the retrieval operation

Condition:

This event is fired when you call GetHL7PlusMessages() in files with many messages to retrieve.