| IMultiFileConverter Interface |
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
The IMultiFileConverter type exposes the following members.
| Name | Description | |
|---|---|---|
| AddBilingualProcessor |
Appends a bilingual content processor to the container.
(Inherited from IBilingualProcessorContainer.) | |
| AddExtractor |
Adds another file converter to be used. The converter should be initialized properly.
| |
| ApplyDocumentPropertiesToExtractors |
Updates the file properties for each of the extractors to use the source and target languages specified in the document
properties.
| |
| GetBilingualProcessors |
The content processors, in the order in which they will be invoked
(Inherited from IBilingualProcessorContainer.) | |
| InsertBilingualProcessor |
Inserts a bilingual processor at a specified position in the container.
Any item that is currently occupying that position will - after this operation - appear after the inserted processor.
(Inherited from IBilingualProcessorContainer.) | |
| InsertExtractor |
Inserts a file converter to be used at a specific index. The converter should be
initialized properly.
| |
| Parse |
Initializes the file type components and repeatedly invokes the ParseNext method on the parser until all content has been processed.
If there is a native parser, it will be used. Otherwise ,if there is a bilingual parser, that parser will be used.
If no parser has been specified, an exception will be thrown.
| |
| ParseNext |
Invokes the ParseNext() method on the appropriate parser, causing a chunk of content to be processed.
Ensures that the the parser components are initialized before parsing commences for the first time.
| |
| RemoveBilingualProcessor | (Inherited from IBilingualProcessorContainer.) | |
| RemoveExtractor |
Removes the specified converter.
| |
| SetDocumentInfo |
Set document properties, optionally updating source and target languages for each of the extractors.
| |
| SynchronizeDocumentProperties |
Properly synchronizes document properties between the converter and its extractors.
If document properties are available from a bilingual parser, they will be used. Otherwise,
the document properties will be deducted by querying existing extractors for languages.
| |
| UpdateDocumentPropertiesFromExtractors |
Set source and target languages of the document properties from the properties detected by the file sniffers
associated with the extractors. If different extractors have detected differing languages with certainty, this method does not change
the document properties and returns false. If different languages are detected with a detection level less then certain, the language with
the highest detection level will be used. If there is more than one language, the first one will take precedence.
If a target language has been set in the document properties, but no target language has been detected in the extractors, the target language of the document properties will be set to an uninitialized value. |
| Name | Description | |
|---|---|---|
| BilingualDocumentGenerator |
The purpose of a bilingual generator is to serialize all bilingual content (potentially
from different native files) into a single bilingual output (e.g. an XLIFF file) that will act as
a persistent storage for the bilingual content, from which it can be fully de-serialized.
| |
| BilingualDocumentOutputProperties |
After saving a bilingual document, this property provides access to the output
properties that were used. This can be used to find the file name of the created
output file and to determine which dependency files are referenced (linked) to
the file rather than embedded inside the file.
| |
| BilingualDocumentOutputPropertiesProvider |
When writing bilingual document files (e.g. SDL XLIFF), this property must be set.
The delegate is called by the converter to determine the
file name of the bilingual document to be created.
| |
| BilingualVerifiersProvider |
In order to add the file specific verifiers into the processing chain,
we can specify a BilingualVerifiersProvider. A default implementation
is provided by the FileTypeManager. If no bilingual
verification is required, this property should be left null.
| |
| DependencyFileLocator |
When parsing intermediate bilingual documents this property may be set
to provide assistance in locating missing linked dependency files.
The provided delegate will be passed to any bilingual document parsers
before they are used for processing.
| |
| DetectedLanguagesCorrespondToDocumentProperties | True if the source and target languages in the DocumentInfo correspond
to the languages detected by the file sniffers for each of the extractors.
False if any of the extractors is certain that its file is using a different source or target language.
| |
| DetectedSourceLanguage |
The source language for all extractors, or null if conflicting source languages have been determined with certainty. The detection level
that is returned is the highest detection level for the source language provided by the extractors.
| |
| DetectedTargetLanguage |
The target language for all extractors, or null if conflicting target languages have been determined with certainty. The detection level
that is returned is the highest detection level for the target language provided by the extractors.
| |
| DocumentInfo |
Common properties communicated to all bilingual processing components
| |
| Extractors |
Read-only access to the file extractors used for reading files.
| |
| FileRestriction |
This delegate will be invoked for each file to be processed.
If the delegate returns true, the file
will be processed as normal, but if it returns false,
the file will be skipped.
(Inherited from IBilingualProcessorContainer.) | |
| ItemFactory |
The bilingual content model item factory that will be used by the converters and bilingual file type components
| |
| NativeGeneratorProvider |
When converting to native format, this property represents the
provider that will attempt to create IFileGenerator instances,
and provide output settings when needed by the framework.
This property should be null if not converting to native format.
| |
| OutputPropertiesProvider |
When converting to native format, this property must be set.
This delegate is called by the converter to set the output
filename, encoding, language, etc. for each native file produced.
| |
| ParagraphUnitRestriction |
If set, this delegate will be invoked for each paragraph unit to be processed.
If the delegate returns true, the paragraph unit will be processed as normal. If it returns false,
the paragraph unit will be skipped.
(Inherited from IBilingualProcessorContainer.) | |
| PropertiesFactory |
Convenience getter for the properties factory that will be used by the converters and file type components.
The implementation should return the properties factory from the document item factory, or null if none.
| |
| SharedObjects |
The shared objects that will be communicated across all components
that are used in content processing. Components that implement ISharedObjectsAware will
receive this interface via the SetSharedObjects(ISharedObjects) method before
they are used for content processing.
|
| Name | Description | |
|---|---|---|
| Message |
Raised when a message is reported from a file type component.
| |
| Progress |
This event is fired when any of the the native or bilingual parser fires progress events.
The reported progress constitutes the computed total progress for all files being processed. |