Class AbstractNativeFileTypeComponent

Convenient base class for implementing file type components.

Holds data members that are supplied by the framework during initialization.

Inheritance

object

AbstractNativeFileTypeComponent

AbstractNativeExtractionContentProcessor

AbstractNativeExtractionGenerationContentProcessor

AbstractNativeFileParser

AbstractNativeGenerationContentProcessor

Implements

INativeFileTypeComponent

INativeContentStreamMessageReporter

IBasicMessageReporter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SdlSdl.FileTypeSupportFrameworkNativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public abstract class AbstractNativeFileTypeComponent : INativeFileTypeComponent, INativeContentStreamMessageReporter, IBasicMessageReporter

Remarks

For convenience, implements INativeContentStreamMessageReporter, the implementation relays calls to the MessageReporter property if it is not null.

Constructors

AbstractNativeFileTypeComponent()

Protected default constructor, should only be called by derived classes.

Declaration

protected AbstractNativeFileTypeComponent()

Properties

MessageReporter

The message reporter to be used for reporting non-critical issues.

Declaration

public virtual INativeContentStreamMessageReporter MessageReporter { get; set; }

Property Value

Type	Description
INativeContentStreamMessageReporter

Remarks

Critical issues should throw exceptions.

PropertiesFactory

The factory used to create native properties objects

Declaration

public virtual IPropertiesFactory PropertiesFactory { get; set; }

Property Value

Type	Description
IPropertiesFactory

Methods

ReportMessage(object, string, ErrorLevel, string, LocationMarkerId, LocationMarkerId)

Calls the corresponding method on the message reporter property.

Declaration

public void ReportMessage(object source, string origin, ErrorLevel level, string message, LocationMarkerId fromLocation, LocationMarkerId uptoLocation)

Parameters

Type	Name	Description
object	source
string	origin	The description of the action/component from which this message originates.
ErrorLevel	level
string	message
LocationMarkerId	fromLocation
LocationMarkerId	uptoLocation

ReportMessage(object, string, ErrorLevel, string, string)

Calls the corresponding method on the message reporter property.

Declaration

public void ReportMessage(object source, string origin, ErrorLevel level, string message, string locationDescription)

Parameters

Type	Name	Description
object	source
string	origin	The description of the action/component from which this message originates.
ErrorLevel	level
string	message
string	locationDescription

Implements

INativeFileTypeComponent

INativeContentStreamMessageReporter

IBasicMessageReporter