FileBasedTranslationMemory Class

Represents a bilingual file-based translation memory.

Inheritance Hierarchy

SystemObject
Sdl.LanguagePlatform.TranslationMemoryApiAbstractLocalTranslationMemory
Sdl.LanguagePlatform.TranslationMemoryApiFileBasedTranslationMemory

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi
Assembly: Sdl.LanguagePlatform.TranslationMemoryApi (in Sdl.LanguagePlatform.TranslationMemoryApi.dll) Version: 1.6.0.0 (1.14.4157.0)

Syntax

C++

Copy

public class FileBasedTranslationMemory : AbstractLocalTranslationMemory, 
	IAlignableTranslationMemory, ITranslationMemory2015, ITranslationMemory, ITranslationProvider

Public Class FileBasedTranslationMemory
	Inherits AbstractLocalTranslationMemory
	Implements IAlignableTranslationMemory, ITranslationMemory2015, ITranslationMemory, ITranslationProvider

public ref class FileBasedTranslationMemory : public AbstractLocalTranslationMemory, 
	IAlignableTranslationMemory, ITranslationMemory2015, ITranslationMemory, ITranslationProvider

type FileBasedTranslationMemory =  
    class
        inherit AbstractLocalTranslationMemory
        interface IAlignableTranslationMemory
        interface ITranslationMemory2015
        interface ITranslationMemory
        interface ITranslationProvider
    end

The FileBasedTranslationMemory type exposes the following members.

Constructors

	Name	Description
	FileBasedTranslationMemory(String)	Opens an existing file-based translation memory.
	FileBasedTranslationMemory(Uri)	Opens an existing file-based translation memory given the Uri for a FileBasedTranslationMemory class.
	FileBasedTranslationMemory(String, String)	Opens an existing file-based translation memory and unlocks it with the specified password.
	FileBasedTranslationMemory(String, String, CultureInfo, CultureInfo, FuzzyIndexes, BuiltinRecognizers, TokenizerFlags, WordCountFlags)	Creates a new file-based translation memory.
	FileBasedTranslationMemory(String, String, CultureInfo, CultureInfo, FuzzyIndexes, BuiltinRecognizers, TokenizerFlags, WordCountFlags, Boolean)	Creates a new file-based translation memory.

Top

Properties

	Name	Description
	AlignedPredatedTranslationUnitCount	Gets the number of TUs that were added after the model used to align them was built, but before the latest model was built.
	AlignerDefinition	Gets the AlignerDefinition that has been set for this TM, or null if there is none
	CanBuildModel	Indicates whether the TM has enough data for the translation model associated with it to be built
	Copyright	Gets or sets the copyright string for this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	CreationDate	Gets the creation date of this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	CreationUserName	Gets the creation user of this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	Description	Gets or sets a general description of the translation memory. (Inherited from AbstractLocalTranslationMemory.)
	ExpirationDate	Gets or sets the expiration date for this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	FGASupport	Returns the status of fine-grained-alignment support for the TM
	FieldDefinitions	Gets the custom fields defined for this TM. (Inherited from AbstractLocalTranslationMemory.)
	FilePath	Gets the file path.
	FuzzyIndexes	Gets or sets the set of fuzzy indices defined on this TM. (Inherited from AbstractLocalTranslationMemory.)
	FuzzyIndexStatisticsRecomputedAt	Gets the time of the last fuzzy index statistics recomputation of this TM, if available. (Inherited from AbstractLocalTranslationMemory.)
	FuzzyIndexStatisticsSize	Gets the size of the TM at the point of the last fuzzy index statistics recomputation, if available. (Inherited from AbstractLocalTranslationMemory.)
	FuzzyIndexTuningSettings	Gets or sets the fuzzy index tuning settings for the TM. (Inherited from AbstractLocalTranslationMemory.)
	HasAdministratorPassword	Gets a value indicating whether this instance has an administrator password.
	HasMaintenancePassword	Gets a value indicating whether this instance has maintenance password.
	HasReadOnlyPassword	Gets a value indicating whether this instance has read only password.
	HasReadWritePassword	Gets a value indicating whether this instance has read write password.
	IsProtected	Gets a value indicating whether this instance is protected one or more passwords.
	IsReadOnly	IsReadOnly. (Inherited from AbstractLocalTranslationMemory.)
	IsUnlockedWithSufficientPermissions	Determines whether the file based translation memory has been unlocked with sufficient permissions to be deemed available. When null, no attempt has been made to unlock the file based translation memory and obtain sufficient permission. When false, an attempt has been made to unlock the file based translation memory and obtain sufficient permission that failed. When true, an attempt has been made to unlock the file based translation memory and obtain sufficient permission that succeeded. If this is false then StatusInfo. Available will be false with a message "Not unlocked with sufficient permissions." This property should be set by the calling code after the user has been challenged.
	LanguageDirection	Gets the one language direction contained in this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	LanguageResourceBundles	Gets the language resources which are associated with this TM. (Inherited from AbstractLocalTranslationMemory.)
	ModelDetails	Provides details of the translation model associated with this file-based TM
	Name	Gets the name of the translation memory. (Inherited from AbstractLocalTranslationMemory.)
	Recognizers	Gets or sets the recognizers which are enabled for this TM. Remarks Note that changing recognizers may require reindexing. In addition, in some cases duplicate TUs may be in the TM if recognizers are enabled which have been disabled before. (Inherited from AbstractLocalTranslationMemory.)
	ShouldAlign	Indicates whether 'quick' alignment (i.e. alignment of any unaligned TUs, plus postdated TUs for which a newer model is now available) is recommended
	ShouldBuildModel	Indicates whether a build (or rebuild) of the translation model is recommended
	StatusInfo	Gets the status info for the translation memory. A file-based translation memory is considered available if the translation memory file exists and if the translation memory has been unlocked by calling Unlock(String) (in case the translation memory) is password protected. (Overrides AbstractLocalTranslationMemoryStatusInfo.)
	SupportedLanguageDirections	Gets the list of language directions which are supported by this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	SupportsConcordanceSearch	SupportsConcordanceSearch. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsDocumentSearches	SupportsDocumentSearches. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsFilters	SupportsFilters. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsFuzzySearch	SupportsFuzzySearch. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsMultipleResults	SupportsMultipleResults. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsPenalties	SupportsPenalties. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsPlaceables	SupportsPlaceables. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsScoring	SupportsScoring. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsSearchForTranslationUnits	SupportsSearchForTranslationUnits. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsSourceConcordanceSearch	SupportsSourceConcordanceSearch. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsStructureContext	SupportsStructureContext. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsTaggedInput	SupportsTaggedInput. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsTargetConcordanceSearch	SupportsTargetConcordanceSearch. Returns Copy true if this translation memory has a word-based fuzzy index for the target language (see FuzzyIndexes). (Inherited from AbstractLocalTranslationMemory.)
	SupportsTranslation	SupportsTranslation. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsUpdate	SupportsUpdate. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	SupportsWordCounts	SupportsWordCounts. Always true for TMs. (Inherited from AbstractLocalTranslationMemory.)
	TokenizerFlags	Gets or sets the flags affecting tokenizer behaviour for this TM. Remarks Note that changing tokenizer flags may require reindexing.
	TranslationMethod	TranslationMethod. Always returns TranslationMemory (Inherited from AbstractLocalTranslationMemory.)
	TranslationUnitNewerThanModelCount	Gets the number of TUs that have been added subsequent to the date of the translation model
	UnalignedTranslationUnitCount	Gets the number of TUs that do not have fine-grained alignment information.
	Uri	Gets a URI which uniquely identifies this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	UserName	Sets the user name on the container to override the default windows user ID
	WordCountFlags	Gets or sets the flags affecting word count behaviour for this TM.

Top

Methods

	Name	Description
	AlignTranslationUnits(Boolean, Boolean, RegularIterator)	Performs fine-grained alignment on translation units
	AlignTranslationUnits(Boolean, Boolean, CancellationToken, IProgressInt32)	Performs bulk fine-grained alignment on translation units in a TM
	BuildModel	Builds the translation model associated with this file-based TM
	ClearAlignmentData	Deletes any fine-grained alignment data from the TM
	ClearFuzzyCache	Clear the fuzzy cache of the TM (Inherited from AbstractLocalTranslationMemory.)
	ClearModel
	CreateFileBasedTranslationMemoryLanguageDirection	(Inherited from AbstractLocalTranslationMemory.)
	Delete	Deletes this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	Equals	Determines whether the specified Object is equal to this instance. (Overrides ObjectEquals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetFileBasedTranslationMemoryFilePath	Gets the file-based translation memory file path from the given Uri.
	GetFileBasedTranslationMemoryName	Gets the file-based translation memory file name (excluding the path) from the given Uri.
	GetFileBasedTranslationMemoryScheme	Gets the file-based translation memory scheme.
	GetFileBasedTranslationMemoryUri	Gets the file-based translation memory Uri from the given file path.
	GetHashCode	Returns a hash code for this instance. (Overrides ObjectGetHashCode.)
	GetLanguageDirection	Gets a specified translation memory language direction. (Inherited from AbstractLocalTranslationMemory.)
	GetTranslationUnitCount	Gets the total translation unit count for all language directions in this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValidAccessModes	Returns the list of access modes that are valid for the given permission. So if the password is set for one of the returned access modes, the specified permission will be granted. For example, if the permission is "batchedittu", the valid access modes would be Maintenance and Administrator.
	HasAccessModePermission	Returns true if permission is granted to access the TM with the specified access mode.
	HasPermission	Checks whether the current user has the specified permission on this translation memory. (Overrides AbstractLocalTranslationMemoryHasPermission(String).)
	IsFileBasedTranslationMemory	Determines whether the given Uri represents a file-based translation memory.
	IsPasswordSet	Determines whether a specified password is already in use on the TM.
	LoadState	Loads previously serialized state information into this translation provider instance. (Inherited from AbstractLocalTranslationMemory.)
	MeasureModelFitness	Measures how well the model 'fits' the TM content, by counting out-of-vocabulary words
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnProgress(TranslationModelProgressEventArgs)
	OnProgress(Object, TranslationModelProgressEventArgs)
	RecomputeFuzzyIndexStatistics	Synchronously recomputes the fuzzy index statistics of the TM. (Inherited from AbstractLocalTranslationMemory.)
	Refresh	Enforces the currently stored setup information to be refreshed. Note that this may initiate a full server/database roundtrip. (Inherited from AbstractLocalTranslationMemory.)
	RefreshStatusInfo	Refreshes the current status information. (Overrides AbstractLocalTranslationMemoryRefreshStatusInfo.)
	Save	Saves changes made to properties of this translation memory. (Inherited from AbstractLocalTranslationMemory.)
	SerializeState	Serializes any meaningful state information for this translation provider that can be stored in projects and sent around the supply chain. (Inherited from AbstractLocalTranslationMemory.)
	SetAdministratorPassword	Sets the administrator password and unlocks the TM so the TM is open in administrator mode.
	SetMaintenancePassword	Sets the maintenance password.
	SetReadOnlyPassword	Sets the read only password.
	SetReadWritePassword	Sets the read write password.
	ShouldRecomputeFuzzyIndexStatistics	Gets a flag which indicates whether it is recommended to recompute the fuzzy index statistics (see RecomputeFuzzyIndexStatistics). (Inherited from AbstractLocalTranslationMemory.)
	SupportsLanguageDirection	Checks whether this translation provider supports the specified language direction. (Inherited from AbstractLocalTranslationMemory.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unlock	Unlocks the translation memory with the specified password.

Top

Events

	Name	Description
	TranslationModelProgress	Reports the progress of building a translation model

Top

Reference

Sdl.LanguagePlatform.TranslationMemoryApi Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/