Interface INativeExtractor

Manages the Parser used to process the native file as well as a set of INativeExtractionContentProcessor components that processes the output of the parser.

The result of the processing consists of calls to the Output.

Namespace: Sdl.FileTypeSupport.Framework.NativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface INativeExtractor

Remarks

Used together with other components in a IFileExtractor to extract content from a native file.

Properties

ContentProcessors

The content processors currently in use, in the order in which they will be invoked.

Use AddProcessor(INativeExtractionContentProcessor), InsertProcessor(int, INativeExtractionContentProcessor) and RemoveProcessor(INativeExtractionContentProcessor) to modify the collection.

Declaration

IEnumerable<INativeExtractionContentProcessor> ContentProcessors { get; }

Property Value

Type	Description
IEnumerable<INativeExtractionContentProcessor>

Output

The output from the extractor (i.e. the parser and the native processors) will be passed to this component.

Declaration

INativeExtractionContentHandler Output { get; set; }

Property Value

Type	Description
INativeExtractionContentHandler

Parser

The file parser that will read the input file

Declaration

INativeFileParser Parser { get; set; }

Property Value

Type	Description
INativeFileParser

Remarks

The output from the parser is processed in sequence by each native content processor before being passed to the Output.

Methods

AddProcessor(INativeExtractionContentProcessor)

Appends a content processor that will be invoked to process the output of the parser.

Declaration

void AddProcessor(INativeExtractionContentProcessor processor)

Parameters

Type	Name	Description
INativeExtractionContentProcessor	processor

InsertProcessor(int, INativeExtractionContentProcessor)

Inserts a content processor at the specified index in the list of content processors that will be invoked to process the output from the parser. The processors are invoked in the order in which they appear in the list.

Declaration

void InsertProcessor(int index, INativeExtractionContentProcessor processor)

Parameters

Type	Name	Description
int	index
INativeExtractionContentProcessor	processor

RemoveProcessor(INativeExtractionContentProcessor)

Removes a content processor from the list. Does not do anything if the processor is not in the list.

Declaration

bool RemoveProcessor(INativeExtractionContentProcessor processor)

Parameters

Type	Name	Description
INativeExtractionContentProcessor	processor

Returns

Type	Description
bool