Skip to main content

Class AstDimensionMetadataNode

Dimension metadata objects include all of the information necessary to use the parent table as the basis to create a Dimension in SQL Server Analysis Services (SSAS).

Namespace: Varigence.Languages.Biml.Dimension

Assembly: Biml.dll

C#


public class AstDimensionMetadataNode : AstAnalysisMetadataBaseNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem

Inheritance AstNode

  • Implements

    Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo, Varigence.Utility.Collections.IScopedNameIndexable,

Constructors

ConstructorsDescription
AstDimensionMetadataNode(IFrameworkItem)Initializes a new instance of the AstDimensionMetadataNode class with the specified parent node.

Fields

FieldsDescription
ScopedNamePrefixBackingStore
IsScopeImported

Properties

PropertiesDescription
AttributeAllMemberNameThis value specifies the All member attribute of the dimension.
AttributeAllMemberNameDefaultValueGets the default value for the AttributeAllMemberName property
AttributeAllMemberTranslationsThis value contains alternate language versions for the captions of the All member of the dimension.
AttributeHierarchiesThis is a container for definitions of the attribute hierarchies associated with the dimension.
AttributesThis is a container for definitions of the attributes associated with the dimension.
CollationThis value specifies the data sorting and comparison methods used by the dimension.
CollationDefaultValueGets the default value for the Collation property
CurrentStorageModeThis value specifies which storage mode the dimension uses.
CurrentStorageModeDefaultValueGets the default value for the CurrentStorageMode property
DimensionTypeThis value specifies the type of the dimension. This type information is passed to the OLAP client such as Microsoft Excel for presentation to the end-user.
DimensionTypeDefaultValueGets the default value for the DimensionType property
ErrorConfigurationThis value specifies the error configuration properties associated with the dimension. Error configuration includes error logging; null, duplicate, and unknown key handling; error actions; and other settings.
FriendlyTypeNameStaticGets the friendly name of the type of this node
LanguageThis value specifies the default language to be associated with the dimension.
LanguageDefaultValueGets the default value for the Language property
MdxMissingMemberModeThis value specifies how missing members are handled for Multidimensional Expressions (MDX) statements.
MdxMissingMemberModeDefaultValueGets the default value for the MdxMissingMemberMode property
ProactiveCachingThis value defines how proactive caching is performed for the dimension. Proactive caching enables a dimension to use a MOLAP-style multidimensional store for data but to update that store automatically to stay up-to-date with changes to the underlying relational store. This provides a compromise between MOLAP and ROLAP cube storage models.
ProcessingGroupThis value specifies the processing group for the dimension. The default value is ByAttribute.
ProcessingGroupDefaultValueGets the default value for the ProcessingGroup property
ProcessingModeThis value specifies when indexing and aggregating occur. The options are Regular, which means that indexing and aggregations occur during processing, or Lazy, which means that indexing aggregation occur after processing is completed.
ProcessingModeDefaultValueGets the default value for the ProcessingMode property
ProcessingPriorityThis value specifies the priority of background processing operations relative to query handling, other non-background functions, and other functions that have a priority specified. Lower integer values indicate lower priority. The default value is 0.
ProcessingPriorityDefaultValueGets the default value for the ProcessingPriority property
RelationshipsThis is a container for definitions of the attribute relationships associated with the dimension.
SsasNameGets the name of the table that should be used for SSAS emission, including DSVs and dimension/fact naming
StorageModeThis value specifies which storage mode the dimension will use.
StorageModeDefaultValueGets the default value for the StorageMode property
TableReturns the parent table of this object.
TranslationsThis value contains alternate language versions of measure groups, measures, cube dimension, perspectives, KPIs, actions, named sets, and calculated members associated with a dimension. These are used by client applications such as Microsoft Excel to show values for dimension metadata that are consistent with the language of the end-user.
UnknownMemberThis value specifies unknown member behavior for the dimension.
UnknownMemberDefaultValueGets the default value for the UnknownMember property
UnknownMemberNameThis value specifies captions for unknown members of the dimension.
UnknownMemberNameDefaultValueGets the default value for the UnknownMemberName property
WriteEnabledThis value specifies whether users are able to modify the contents of the dimension.
WriteEnabledDefaultValueGets the default value for the WriteEnabled property
LogicalDisplayFolderSpecifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.
LogicalDisplayFolderDefaultValueGets the default value for the LogicalDisplayFolder property
ScopedNameGets the scoped name which can be used to uniquely identify this object among other objects of its type
SymbolTableGets a reference to the symbol table that stores a reference to this and all other named objects in the project
SsisSafeScopedNameReturns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
SsisSafeNameReturns a version of the Name that has been cleaned of invalid characters for SSIS.
NameSpecifies the name of the object. This name can be used to reference this object from anywhere else in the program.
ReferencesGets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
NameDefaultValueGets the default value for the Name property
Guid
AnnotationsThis is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.
ObjectTagThis property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata.
BimlFileThis value specifies the BimlFile in which the Biml code that defines AstNode resides.
ItemLabelGets a label that can be used to identify this node
ParentItemThis value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node.

Methods

MethodsDescription
BindingScopeBoundaries()Retrieves the permitted scope boundaries to bind references from this node.
DefinedAstNodes()Retrieves a collection of nodes that have been defined as direct children of the current node.
Duplicate()Creates a duplicate of the current node
Duplicate(IFrameworkItem)Creates a duplicate of the current node with the specified parent item
GetAllItemsReferencedByDefinedSuccessors()Builds a list of all items referenced by this node and its successors.
Each tuple in the returned list represents a FrameworkItemReference.
The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem.
GetDefaultValue(String)Retrieves the default value for the property with the name propertyName
GetDefaultValue<T>(String)Retrieves the default value for the property with the name propertyName
StructureEquals(Object)Compares this node to the provided object to determine if all defined children and references are equal.
GetSchemaLocalName()Retrieves the local XML element name that corresponds to this node in Biml code.
ToString()Returns a string that represents the current object. In this case, it is the Name of the node.
OnScopedNameChanged(String, String)
OnItemLabelChanged(String, String)
OnNameChanging(String, String)
OnNameChanged(String, String)
AddScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>)Adds the scoped name changed event handler to the specified referenceable item.
RemoveScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>)Removes the scoped name changed event handler from the specified referenceable item.
FirstChildOfType<TChild>()Gets the first defined descendant node of the specified type
RemoveFromParent()Removes this node definition from its parent
GetJson()Generates a JavaScript Object Notation (JSON) representation of the current node
GetExternalJson()Generates a JavaScript Object Notation (JSON) representation of the current node
GetJson(Boolean, Boolean, Boolean, Boolean, Boolean)Generates a JavaScript Object Notation (JSON) representation of the current node
GetXObjectName()Gets the fully qualified XML element name for this node in the code document.
FirstParent<TAstNode>()Retrieves the first parent or ancestor node of the specified type
FirstParent<TAstNode>(Type)Retrieves the first parent or ancestor node of the specified type with the specified custom attribute type
FirstThisOrParent<TAstNode>()Retrieves the first parent or ancestor node of the specified type, including this node
IsDirectAncestor(IFrameworkItem)Retrieves a value indicating whether the specified node is a direct ancestor of this node.
AncestorDistance(IFrameworkItem)Retrieves the number of steps between this node and the nearest shared ancestor with the specified relative node.
FirstThisOrParent<TAstNode>(Type)Retrieves the first parent or ancestor node (including this node) of the specified type with the specified custom attribute type
AllDefinedSuccessors()Retrieves the collection of all nodes defined as a child of this or any successor node or the current node
AllDefinedSuccessors(Boolean)Retrieves the collection of all nodes defined as a child of this or any successor node or optionally the current node
OnNotificationTargetPropertyChanged(String)
OnScopeBoundaryChanged(IScopeBoundary, IScopeBoundary)
AddParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
RemoveParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
AddScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>)
RemoveScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>)
AddParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
RemoveParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
AddFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
RemoveFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
ParseSelf(XElement, ParserContext)
ParseNameValueMapping(XElement)
BindReference(SymbolTable, String, Boolean, String, Int32, Boolean)