| AbstractNativeFileParser Class |
Abstract base class that provides boilerplate implementation
for native file parsers.
Deriving your file parser from this class will save you some
implementation work. Provides a default implementation of the
ParseNext method. You can override the BeforeParsing,
DuringParsing and AfterParsing in
your parser implementation in order to separate initialization and
clean-up code from the core parsing code.
Inheritance HierarchySystemObject
Sdl.FileTypeSupport.Framework.NativeApiAbstractNativeFileTypeComponent
Sdl.FileTypeSupport.Framework.NativeApiAbstractNativeFileParser
Sdl.FileTypeSupport.Framework.NativeApiAbstractNativeFileTypeComponent
Sdl.FileTypeSupport.Framework.NativeApiAbstractNativeFileParser
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
SyntaxThe AbstractNativeFileParser type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AbstractNativeFileParser |
Protected constructor that should only be called by derived classes
|
Properties| Name | Description | |
|---|---|---|
 | CurrentStage |
The stage of processing that the parser has reached
|
 | MessageReporter |
The message reporter to be used for reporting non-critical issues.
(Inherited from AbstractNativeFileTypeComponent.) |
| Output |
Default implementation of the Output property
|
| PropertiesFactory |
The factory used to create native properties objects
(Inherited from AbstractNativeFileTypeComponent.) |
Methods| Name | Description | |
|---|---|---|
| AfterParsing |
The implementation of ParseNext will call this method once, after parsing
has been completed (which is indicated by DuringParsing returning false).
Override this method to do clean-up work such as closing the file etc. once parsing is complete.
The default implementation does nothing.
|
| BeforeParsing |
The implementation of ParseNext will call this method
the very first time that ParseNext is called.
Override this method to perform setup work for the parsing such as
initializing the state, opening the file to be parsed, etc.
The default implementation of this method does nothing.
|
 | Dispose |
Implements IDisposable. Just calls Dispose saying that this is an explicit disposal and
tells the GC not to call the Finalizer.
|
| Dispose(Boolean) |
Last change for the Parser to dispose manage and unmanged objects.
It can be overriden by subclases.
|
| DuringParsing |
The implementation of ParseNext will call this method
to perform actual parsing of the file.
BeforeParsing will always be called before this method.
Override this method to perform the parsing in suitably small chunks.
Returns true as long as there is more content to be parsed.
Once this function returns false, the AfterParsing method
will be called once.
During parsing the implementation may call OnProgress(Object, ProgressEventArgs) to report the current progress.
The default implementation returns false.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
The distructor just calls Dispose with false parameter specifying this is a cakl from GC.
(Overrides ObjectFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnProgress(Byte) |
Helper method to set up the Progress event
|
| OnProgress(Object, ProgressEventArgs) |
Helper method to fire the Progress event
|
| OutputText |
Helper method to output plain text
|
| ParseNext |
Default implementation that takes care of dividing the parsing into
three stages, before parsing, during parsing, and after parsing, by calling
the methods BeforeParsing, DuringParsing, and AfterParsing
that derived classes should normally override to do the setup, parsing, and clean-up work.
Derived classes do not need to override this method unless they need to add additional functionality
outside of the three parsing implementation methods.
|
| ReportMessage(Object, String, ErrorLevel, String, String) |
Calls the corresponding method on the message reporter property.
(Inherited from AbstractNativeFileTypeComponent.) |
| ReportMessage(Object, String, ErrorLevel, String, LocationMarkerId, LocationMarkerId) |
Calls the corresponding method on the message reporter property.
(Inherited from AbstractNativeFileTypeComponent.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Progress |
Progress reporting events, typically attached to when a progress reporter is used
|
See AlsoCommunityComments