Dimension Class

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Warehouse.CloneableItem
    Microsoft.TeamFoundation.Warehouse.NamedItem
      Microsoft.TeamFoundation.Warehouse.ContainerItem
        Microsoft.TeamFoundation.Warehouse.Dimension

Namespace:  Microsoft.TeamFoundation.Warehouse
Assembly:  Microsoft.TeamFoundation.Warehouse (in Microsoft.TeamFoundation.Warehouse.dll)

Syntax

'Declaration
Public Class Dimension _
    Inherits ContainerItem
public class Dimension : ContainerItem
public ref class Dimension : public ContainerItem
type Dimension =  
    class 
        inherit ContainerItem 
    end
public class Dimension extends ContainerItem

The Dimension type exposes the following members.

Constructors

  Name Description
Public method Dimension

Top

Properties

  Name Description
Public property AttributeHierarchyEnabledDefault
Public property CompressKeyField Whether page compression should be applied to the key field. (Inherited from ContainerItem.)
Public property CompressSurrogateKeyField Whether page compression should be applied to the surrogate key field. (Inherited from ContainerItem.)
Public property DimensionUses (Inherited from ContainerItem.)
Public property Fields (Inherited from ContainerItem.)
Public property FriendlyName The Friendly Name. (Inherited from NamedItem.)
Public property GenerateAnalysisSchema Whether to generate / update analysis database schema based on this metadata. (Inherited from ContainerItem.)
Public property GenerateETL Should this item be included in the auto-generated ETL for the relational warehouse? If it is not included a stored procedure will not be generated to populate this item. (Inherited from ContainerItem.)
Public property GenerateWarehouseSchema Whether to generate warehouse schema based on this metadata. (Inherited from ContainerItem.)
Public property HandleDuplicateKeys Whether the logic for adding entries to the database should expect entries with duplicate keys and handle them in some appropriate way. (Inherited from ContainerItem.)
Public property IncludeUpdatesInIncrementalCubeProcessing Whether to mark this object as updated for incremental cube processing when an existing row is updated, *other* than to set its initial values if it was originally inserted as an early-arriving entry. Setting this false means that added rows will still propagate to the cube, but updates (except updates to early-arriving entries) will not propagate until the next Full cube process. This is tactically useful when this object, or objects that depend on it, are large enough that we want to avoid Analysis Services ProcessUpdate / ProcessFull which query all rows from the warehouse. Note: We do not support this attribute that has dimensions that reference area / iteration and use area/iteration forwarding, because it wasn't needed and to be conservative in Ask mode. Currently the only such dimension is DimWorkItem, which is not in metadata but may be in the future.
Public property KeyField (Inherited from ContainerItem.)
Public property KeyFieldName (Inherited from ContainerItem.)
Public property Levels
Public property Name (Inherited from NamedItem.)
Public property NameFieldName Name of field that contains main display name for entity, such as for building paths. Currently required only if PathFieldName is set.
Public property NamingTemplate Optional naming template to use for this dimension in the cube. This is only useful for hierarchies. Format: {Level 0};{Level 1};...
Public property OrderByField
Public property ParentField
Public property ParentFieldName Name of field that contains business / op store key of parent entity. Currently, this value does not have to be persisted in the dimension, but is used to pass the parent key to the sproc, in order to set the parent surrogate key.
Public property ParentIdFriendlyName
Public property ParentSurrogateKeyFieldName
Public property PathFieldName Optional name of field that should be set to the hierarchical path of the entity, by concatenating name values.
Public property PerformUpdateChecks Whether to perform an equality check on all fields before deciding to update them. Uses the database collation when it compares string fields, which uses case-insensitive for TFS. Therefore, will usually *not* propagate case changes. (Inherited from ContainerItem.)
Public property PerformUpdateChecksCaseSensitive Whether to perform an equality check on all fields before deciding to update them, and use case-sensitive checks on string fields so case changes are propagated. (Inherited from ContainerItem.)
Public property SurrogateKeyAdjustTimeZone
Public property SurrogateKeyField (Inherited from ContainerItem.)
Public property SurrogateKeyFieldName Name of field that stores warehouse-specific ("surrogate") key. Defaults to "__ID" for backward compatibility, although in new metadata we expect it to always be set explicitly. (Inherited from ContainerItem.)
Public property SurrogateKeyFieldType Database type of surrogate key, uses INT by default.
Public property Translation (Inherited from NamedItem.)

Top

Methods

  Name Description
Public method AddField (Inherited from ContainerItem.)
Public method Clone (Inherited from CloneableItem.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetField (Inherited from ContainerItem.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsWellFormed (Overrides ContainerItem.IsWellFormed().)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ShouldSerializeDimensionUses (Inherited from ContainerItem.)
Public method ShouldSerializeFields (Inherited from ContainerItem.)
Public method ShouldSerializeLevels
Public method ShouldSerializeTranslation (Inherited from NamedItem.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryRemoveField Remove the field that has the specified name. (Inherited from ContainerItem.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Warehouse Namespace