Skip to main content

Class AstMeasureNode

AstMeasureNode corresponds directly to a measure in an Analysis Services cube measure group.

Namespace: Varigence.Languages.Biml.Fact

Assembly: Biml.dll

C#


public class AstMeasureNode : AstNamedNode, IBindableItem, IGetJsonProvider, INamedNode, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem, IDataflowItem

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
AstMeasureNode(IFrameworkItem)Initializes a new instance of the AstMeasureNode class with the specified parent node.

Fields

FieldsDescription
ScopedNamePrefixBackingStore
IsScopeImported

Properties

PropertiesDescription
AggregateColumnIn cases where a custom MDX expression is not supplied for the measure, an aggregate column is selected to supply the measure value from the underlying data source. Whichever aggregate column is selected will undergo the operation specified by the Aggregate Function property when the measure value is computed for a given query.
AggregateFunctionIn cases where a custom MDX expression is not supplied for the measure, an Aggregate Function is the operation that will be applied to the column specified by the Aggregate Column property when the measure value is computed for a given query.
AggregateFunctionDefaultValueGets the default value for the AggregateFunction property
BackColorExpressionThis value specifies the color-related display properties of the measure. Arbitrary MDX expressions can be used, and this information is sent to the OLAP client (such as Microsoft Excel) for rendering. It is up to the OLAP client to respect these settings.
BackColorExpressionDefaultValueGets the default value for the BackColorExpression property
CollationThis value specifies which collation method is used by the measure.
CollationDefaultValueGets the default value for the Collation property
DataFormatThis value specifies the formatting requirements of the DataItem element. For the current versions of SQL Server Analysis Services (SSAS), only whitespace trimming is offered as an option. Future versions reserve the right to offer additional DataFormat options. The default setting is None.
DataFormatDefaultValueGets the default value for the DataFormat property
DataMimeTypeThis value, where applicable, specifies the Multipurpose Internet Mail Extensions (MIME) type of the data represented by the DataItem element.
DataMimeTypeDefaultValueGets the default value for the DataMimeType property
DisplayFolderThis 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.
DisplayFolderDefaultValueGets the default value for the DisplayFolder property
ExpressionThis value specifies the value of the measure. A Multidimensional Expressions (MDX) expression is used.
ExpressionDefaultValueGets the default value for the Expression property
FontFlagsExpressionThis value specifies the font-related display characteristics of the measure, such as font weight and style. Arbitrary MDX expressions can be used, and this information is sent to the OLAP client (such as Microsoft Excel) for rendering. It is up to the OLAP client to respect these settings.
FontFlagsExpressionDefaultValueGets the default value for the FontFlagsExpression property
FontSizeExpressionThis value specifies the font name to be used for the measure. Arbitrary MDX expressions can be used, and this information is sent to the OLAP client (such as Microsoft Excel) for rendering. It is up to the OLAP client to respect these settings.
FontSizeExpressionDefaultValueGets the default value for the FontSizeExpression property
ForeColorExpressionThis value specifies the color-related display properties of the measure. Arbitrary MDX expressions can be used, and this information is sent to the OLAP client (such as Microsoft Excel) for rendering. It is up to the OLAP client to respect these settings.
ForeColorExpressionDefaultValueGets the default value for the ForeColorExpression property
FriendlyTypeNameStaticGets the friendly name of the type of this node
HasAggregateColumnIndicates if the measure is defined using an aggregate column, as opposed to an expression
HasExpressionIndicates if the measure is defined using an expression, as opposed to an aggregate column
InvalidXmlCharacterProcessingThis value determines how invalid XML characters in the source data are handled.
InvalidXmlCharacterProcessingDefaultValueGets the default value for the InvalidXmlCharacterProcessing property
MeasureFormatThis value specifies the format string to be used for displaying data in the OLAP client, such as Microsoft Excel. While any Microsoft format string can be provided, several common format strings are offered for convenience.
MeasureFormatDefaultValueGets the default value for the MeasureFormat property
NullProcessingThis value specifies how null values are processed. The default value is Automatic.
NullProcessingDefaultValueGets the default value for the NullProcessing property
QualifiedNameGets the fully qualified name for this measure in MDX
SsasDataTypeThis value specifies the type of the measure using the SQL Server Analysis Services (SSAS) type system. Note that this type may differ from the type of the aggregate column in the underlying data source or the value computed by the specified expression. In those cases, a type cast will automatically be performed on the basis of this property setting when the types are compatible.
SsasDataTypeDefaultValueGets the default value for the SsasDataType property
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.
TrimmingThis value specifies how data from the data source is trimmed. The default setting is Right.
TrimmingDefaultValueGets the default value for the Trimming property
VisibleThis value specifies whether the parent element measure is visible. The default value is True.
VisibleDefaultValueGets the default value for the Visible 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
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)