Class AstKpiNode
The AstKpiNode type corresponds directly to a Key Performance Indicator (KPI) in SQL Server Analysis Services.
Namespace: Varigence.Languages.Biml.Cube
Assembly: Biml.dll
C#
public class AstKpiNode : AstNamedNode, IBindableItem, IGetJsonProvider, INamedNode, 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
| Constructors | Description |
|---|---|
| AstKpiNode(IFrameworkItem) | Initializes a new instance of the AstKpiNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| ScopedNamePrefixBackingStore | |
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| AssociatedMeasureGroup | This value specifies a direct reference to the measure group that with which this KPI will be associated. |
| CurrentTimeMember | This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the current time member for the KPI. |
| CurrentTimeMemberDefaultValue | Gets the default value for the CurrentTimeMember property |
| Description | This value specifies a description of the KPI. |
| DescriptionDefaultValue | Gets the default value for the Description property |
| DisplayFolder | This value specifies the folder in which the parent element is listed. The default setting is None. The display folder is used by the OLAP client, such as Microsoft Excel, to visualize the measure in context of the larger measure/dimension hierarchy. Display folders enable better organization of measures to ease the navigation of large cubes for end-user analysts. |
| DisplayFolderDefaultValue | Gets the default value for the DisplayFolder property |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| Goal | This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the goal for the parent KPI. |
| GoalDefaultValue | Gets the default value for the Goal property |
| ParentKpi | This value optionally specifies a direct reference to the parent KPI with which this KPI will be associated. |
| Status | This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the status of the parent KPI. |
| StatusDefaultValue | Gets the default value for the Status property |
| StatusGraphic | This value specifies the image collection that should be used by the client application to display the current KPI status. |
| StatusGraphicDefaultValue | Gets the default value for the StatusGraphic property |
| Translations | This 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. |
| Trend | This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the current trend of the parent KPI. |
| TrendDefaultValue | Gets the default value for the Trend property |
| TrendGraphic | This value specifies the image collection that should be used by the client application to display the current KPI trend. |
| TrendGraphicDefaultValue | Gets the default value for the TrendGraphic property |
| Value | This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the value of the parent KPI. |
| ValueDefaultValue | Gets the default value for the Value property |
| Weight | This value specifies a Multi-Dimensional Expression (MDX) statement that evaluates to the weight value associated with this KPI. |
| WeightDefaultValue | Gets the default value for the Weight property |
| ScopedName | Gets the scoped name which can be used to uniquely identify this object among other objects of its type |
| SymbolTable | Gets a reference to the symbol table that stores a reference to this and all other named objects in the project |
| SsisSafeScopedName | Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS. |
| SsisSafeName | Returns a version of the Name that has been cleaned of invalid characters for SSIS. |
| Name | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. |
| References | Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node. |
| NameDefaultValue | Gets the default value for the Name property |
| Guid | |
| Annotations | This 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. |
| ObjectTag | This 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. |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. |
| ItemLabel | Gets a label that can be used to identify this node |
| ParentItem | This 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
| Methods | Description |
|---|---|
| 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 |
| GetSchemaLocalName() | Retrieves the local XML element name that corresponds to this node in Biml code. |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| 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) |