TranslationHelper Class

Class to provide objects translation interface ID - CodeName.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.TranslationHelper
    CMS.ContinuousIntegration.Internal.ContinuousIntegrationTranslationHelper

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public class TranslationHelper

The TranslationHelper type exposes the following members.

Constructors

	Name	Description
Public method	TranslationHelper()	Constructor.
Public method	TranslationHelper(DataTable)	Constructor. Creates the helper initialized with given translation table.

Fields

	Name	Description
Public field Static member	AUTO_PARENTID	Automatic parent ID.
Public field Static member	AUTO_SITEID	Automatic site ID
Public field Static member	AUTO_SITENAME	Automatic site name (Get by SiteIDs from DB).
Protected field	mConnection	Connection object used to access data.
Public field Static member	NO_SITE	No site condition for registering records.
Public field Static member	QUERY_OBJECT_TYPE_COLUMN	Name of the computed column that contains (real) object type of current row. Column is used in data query obtaining code names and other information based on ID and object type. Requested object type can differ from real object type when original and related object types are defined.
Public field Static member	RECORD_CLASS_NAME_COLUMN	Name of column with object's class name identifier in a record's DataRow.
Public field Static member	RECORD_CODE_NAME_COLUMN	Name of column with object's code name in a record's DataRow.
Public field Static member	RECORD_GROUP_ID_COLUMN	Name of column with object's group identifier in a record's DataRow.
Public field Static member	RECORD_GUID_COLUMN	Name of column with object's GUID in a record's DataRow.
Public field Static member	RECORD_ID_COLUMN	Name of column with object's identifier in a record's DataRow.
Public field Static member	RECORD_INFO_COLUMN	Name of column with object's additional information in a record's DataRow.
Public field Static member	RECORD_OBJECT_TYPE_COLUMN	Name of column with object's class name in a record's DataRow.
Public field Static member	RECORD_PARENT_ID_COLUMN	Name of column with object's parent identifier in a record DataRow.
Public field Static member	RECORD_SITE_NAME_COLUMN	Name of column with object's site name in a record's DataRow.
Public field Static member	TRANSLATION_TABLE	Name of translation table

Properties

	Name	Description
Public property	IDConversion	ID conversion table [objectType.ToLowerCSafe()] -> hash table [OldID -> NewID]
Public property	TranslationTable	Returns the translation table.
Public property	UseDisplayNameAsCodeName	If true, display name is used instead of the code name.

Methods

	Name	Description
Public method	AddIDTranslation	Adds the ID translation to the translation table.
Public method	ChangeCodeName	Changes the object code name in the table.
Public method	Clear	Clears the translation table.
Public method	FilterExistingRecords	Filters the existing records from the given array.
Public method	GetCodeName(String, Int32)	Returns the code name of the specified object.
Public method	GetCodeName(String, Int32, String)	Returns the code name of the specified object.
Public method	GetDefaultValue	Gets default value.
Public method Static member	GetEmptyTable	Returns empty translation table.
Public method	GetID	Returns the object ID for specified record.
Public method Static member	GetIDFromDB	Gets the object ID from the database.
Public method	GetIDWithFallback	Returns the object ID for specified record calling GetID(TranslationParameters). If record could not be found, method falls back to GetIDFromDB(GetIDParameters, String) and eventually registers DB object in the helper. If neither attempt results into valid object ID, 0 is returned.
Public method	GetNewID(String, Int32, String, Int32, String, String, String)	Gets the new ID for given old ID.
Public method	GetNewID(String, Int32, String, Int32, String, String, String, Boolean, Int32)	Gets the new ID for given old ID.
Public method	GetNewIDs	Gets the dictionary of new IDs for the given list of old IDs [oldId => [ newId, newGroupId ]] Caches the newly retrieved items in the conversion cache
Public method Static member	GetParentType	Gets the parent object type for specified object type.
Public method	GetRecord(TranslationParameters)	Gets the record specified by parameters.
Public method	GetRecord(String, Int32)	Gets the record by ID.
Public method Static member	GetSafeClassName	Gets the safe class name.
Public method	GetTranslationsXml	Gets the translations XML
Public method	HasRecords	Returns true if the helper contains some records.
Public method Static member	IsEmpty	Determines whether the given translation helper contains any translations or not.
Public method Static member	IsExcluded	Returns true of the column is excluded.
Public method	RecordExists	Returns true if specified record exists in translation table.
Public method	RegisterDynamicRecords	Registers the records from the given table.
Public method	RegisterRecord(BaseInfo)	Registers the record for object ID within given translation table.
Public method	RegisterRecord(Int32, TranslationParameters, String)	Registers the record within given translation table.
Public method	RegisterRecords(IList<Int32>, String, String, String[])	Registers the records from the given list.
Public method	RegisterRecords(String, IList<Int32>, String, String[])	Registers the records from the given ID list.
Public method	RegisterRecords(DataTable, String, String, String, String[])	Registers the records from the given table.
Public method	RemoveDefaultValue	Removes default value.
Public method	SetDefaultValue	Sets default value.
Public method	TranslateColumn(DataRow, String, String, Int32)	Translates the DataRow column.
Public method	TranslateColumn(GeneralizedInfo, String, String, Int32, Boolean, Boolean)	Translates the column value of the given info object.
Public method	TranslateColumn(IDataContainer, String, String, Int32, Boolean, Boolean)	Translates the column value of the given container.
Public method	TranslateColumns	Translates all reference object columns.
Public method	TranslateListColumn	Translates the column value with list of IDs of the given info object.

Extension Methods

	Name	Description
Public Extension Method	GetForeignID	Returns the ID of specified object. (Defined by TranslationHelperForeignKeyExtensions.)