PhysicalParser Class

Represents a parser which parses the physical structure of a PQDIF file.

Definition

Namespace: Gemstone.PQDIF.Physical
Assembly: Gemstone.PQDIF (in Gemstone.PQDIF.dll) Version: 1.0.110 -- Release Build+b4919315e8c742e443cd323c6bfaf3fcd0062dd8
public class PhysicalParser : IAsyncDisposable, 
	IDisposable
Inheritance
Object    PhysicalParser
Implements
IAsyncDisposable, IDisposable

Remarks

This class is used internally by the LogicalParser to read the physical structure of the PQDIF file. If your goal is to read data from a PQD file into an application, you probably do not want to instantiate the physical parser directly. Instead, the logical parser will apply the rules governing the logical structure of the PQDIF file to make the data more readily usable by an application that will be processing that data.

The following example of usage was adapted from the PQDIFDump utility, which represents a bare minimum level of effort to read an uncompressed PQDIF file and display its contents in a console application.

C#
string filePath = args[0];
await using PhysicalParser parser = new PhysicalParser(filePath);
await parser.OpenAsync();

while (parser.HasNextRecord())
{
    Record record = await parser.GetNextRecordAsync();
    Console.WriteLine(record);
    Console.WriteLine();
}

Constructors

PhysicalParser Creates a new instance of the PhysicalParser class.
PhysicalParser(String) Creates a new instance of the PhysicalParser class.

Properties

CompressionAlgorithm Gets or sets the compression algorithm used by the PQDIF file.
CompressionStyle Gets or sets the compression style used by the PQDIF file.
ExceptionList Gets all the exceptions encountered while parsing.
FileName Gets or sets the file path (not just the name) of the PQDIF file to be parsed. Obsolete in favor of FilePath.
Obsolete.
FilePath Gets or sets the file path of the PQDIF file to be parsed.
MaximumExceptionsAllowed Gets or sets the maximum number of exceptions in the exception list before parser will quit.
MaximumExceptionsReached Gets a value that indicates whether the maximum number of exceptions has been reached.

Methods

CloseAsync Closes the PQDIF file.
Dispose Releases all resources held by this parser.
DisposeAsync Releases all resources held by this parser.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetNextRecordAsync Reads the next record from the PQDIF file.
GetTypeGets the Type of the current instance.
(Inherited from Object)
HasNextRecord Returns true if this parser has not reached the end of the PQDIF file.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OpenAsync Opens the PQDIF file.
OpenAsync(Stream, Boolean) Opens a PQDIF file from a stream of data.
Reset Sets the parser back to the beginning of the file.
Seek Jumps in the file to the location of the record with the given header.
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also