Class AstAttributeNode
AstAttributeNode corresponds directly to a SQL Server Analysis Services dimension attribute.
public class AstAttributeNode : AstDimensionNamedBaseNode, IBindableItem, IGetJsonProvider, INamedNode, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem, IDataflowItem
- Inheritance
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
| AstAttributeNode(IFrameworkItem) | Initializes a new instance of the AstAttributeNode class with the specified parent node. |
Fields
| ScopedNamePrefixBackingStore | |
| IsScopeImported |
Properties
| AttributeHierarchyDisplayFolder | This value specifies the folder in which the Attribute Hierarchy associate with this Attribute 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. |
| AttributeHierarchyDisplayFolderDefaultValue | Gets the default value for the AttributeHierarchyDisplayFolder property |
| AttributeHierarchyEnabled | This value indicates whether SQL Server Analysis Services will generate an attribute hierarchy. Attribute hierarchies are required for the attribute to participate in a user-defined hierarchy or to be referenced by Multidimensional Expressions (MDX) queries. |
| AttributeHierarchyEnabledDefaultValue | Gets the default value for the AttributeHierarchyEnabled property |
| AttributeHierarchyOptimizedState | This value indicates whether SQL Server Analysis Services is to index the attribute hierarchy to enhance query performance. The default setting is FullyOptimized. If the attribute hierarchy will not be queried, select the NotOptimized setting to prevent the generation of indexes for the attribute hierarchy, which can consume additional memory and cube processing time. |
| AttributeHierarchyOptimizedStateDefaultValue | Gets the default value for the AttributeHierarchyOptimizedState property |
| AttributeHierarchyOrdered | This value indicates whether the attribute hierarchy generated from this attribute is ordered. Ordering large attribute hierarchies can consume significant cube processing time. If the attribute hierarchy will not be used in user-visible query results, or if order does not matter, then ordering can be disabled. The default value is True. |
| AttributeHierarchyOrderedDefaultValue | Gets the default value for the AttributeHierarchyOrdered property |
| AttributeHierarchyVisible | Client applications such as Microsoft Excel can present only attribute hierarchies that have been configured with AttributeHierarchyVisible set to True. The default setting is True. If the attribute hierarchy will not be queried and does not need to be visible to analysts in the pivot table interface, then the setting should be changed to False in order to improve processing time. |
| AttributeHierarchyVisibleDefaultValue | Gets the default value for the AttributeHierarchyVisible property |
| AttributeType | This value specifies the type of the attribute, which can be selected from a large built-in list of types supplied by Microsoft SQL Server Analysis Services (SSAS). The type is used by the client application in cases where specific attribute types require or permit special handling. Examples of attribute types include those related to time, geography, customers, and accounts. |
| AttributeTypeDefaultValue | Gets the default value for the AttributeType property |
| AttributeUsage | This value specifies the role of the attribute relative to its parent dimension. The default setting is Regular. |
| AttributeUsageDefaultValue | Gets the default value for the AttributeUsage property |
| Columns | Gets a collection of the complete list of referenced columns, including name column, value column, and key columns |
| CustomRollupColumn | This value indicates which column contains the formula that specifies how member values contribute to their parent's values. |
| CustomRollupPropertiesColumn | This value indicates which column contains properties used by the formula that specifies how member values contribute to their parent's values. |
| DefaultMember | This value indicates the Multidimensional Expressions (MDX) value that specifies an attribute's default measure. |
| DefaultMemberDefaultValue | Gets the default value for the DefaultMember property |
| DiscretizationBucketCount | This value indicates how many buckets are used to discretize column values. |
| DiscretizationBucketCountDefaultValue | Gets the default value for the DiscretizationBucketCount property |
| DiscretizationMethod | This value specifies the method for data discretization. |
| DiscretizationMethodDefaultValue | Gets the default value for the DiscretizationMethod property |
| EstimatedCount | This value indicates the estimated number of items in the attribute. The default setting is zero. This value is used to assist in aggregation design choices and other internal operations. While EstimatedCount can be set manually to reflect estimated member counts, BimlStudio also provides an automatic Member Count Estimator in the Cube ribbon. |
| EstimatedCountDefaultValue | Gets the default value for the EstimatedCount property |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| GroupingBehavior | This value provides user-defined attribute grouping information to OLAP client applications such as Excel. |
| GroupingBehaviorDefaultValue | Gets the default value for the GroupingBehavior property |
| InstanceSelection | When client applications visualize the member values for an attribute, they often must commit to using a particular visualization style before all of the data has arrived. For large or small member value lists, the client application might want to use different visualization approaches. To assist with making an appropriate selection, this value communicates the characteristics of the member list before a query is performed. |
| InstanceSelectionDefaultValue | Gets the default value for the InstanceSelection property |
| IsAggregatable | This value indicates whether values of attribute members can be aggregated. Specifically, it indicates whether attribute hierarchy contains an (All) level. The default setting is True. |
| IsAggregatableDefaultValue | Gets the default value for the IsAggregatable property |
| KeyColumns | This value specifies the names of the physical columns from the underlying SQL Server table that define the key and granularity for the attribute. The value specified in this column for each member is the value that users see unless another value is specified for the NameColumn property. |
| MemberNamesUnique | This value indicates whether the attribute hierarchy is guaranteed to provide unique member names. |
| MemberNamesUniqueDefaultValue | Gets the default value for the MemberNamesUnique property |
| MembersWithData | When a parent-child hierarchy is specified, multiple options exist for how the member values that are associated with non-leaf nodes are displayed. This value indicates which approach should be taken. |
| MembersWithDataCaption | This value gets or sets a template string that parent attributes use to create captions for data members. This value is used only when a parent-child hierarchy has been defined. |
| MembersWithDataCaptionDefaultValue | Gets the default value for the MembersWithDataCaption property |
| MembersWithDataDefaultValue | Gets the default value for the MembersWithData property |
| NameColumn | This value indicates which column provides the display name of the attribute. When the key column value for an attribute member is cryptic or not useful, or when the key column is based on a composite key, the NameColumn column can be used instead. This column displays a name that is easily comprehensible to users. The NameColumn property is not used in parent-child hierarchies. |
| NamingTemplate | This value gets or sets a template string that parent attributes use to create captions for data members. This value is used only when a parent-child hierarchy has been defined. |
| NamingTemplateDefaultValue | Gets the default value for the NamingTemplate property |
| OrderBy | This value specifies the method of ordering of members of an attribute, including Key, Name, AttributeKey, and AttributeName. |
| OrderByAttribute | This value defines the ordering of the members contained in the attribute hierarchy. If the OrderBy property is set to AttributeKey or AttributeName, then this value defines which attribute to use for the key or name ordering. If the OrderBy property is set to Key or Name, this value has no effect. |
| OrderByDefaultValue | Gets the default value for the OrderBy property |
| RootMemberIf | This value specifies how the root or topmost members of a parent-child hierarchy are identified. This property value is used only when a parent-child hierarchy has been defined. |
| RootMemberIfDefaultValue | Gets the default value for the RootMemberIf 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. |
| UnaryOperatorColumn | This value specifies how the root or topmost members of a parent-child hierarchy are identified. This property value is used only when a parent-child hierarchy has been defined. |
| ValueColumn | This value indicates which column provides the value of the attribute. Specify the NameColumn element to use the same DataItem values as default values for the ValueColumn element. When the NameColumn element is not specified and the KeyColumns collection contains an element that represents a key column with a string data type, then the same DataItem values are used as default values for the ValueColumn element. |
| Dimension | Gets the AstDimensionNode that is the parent of this item |
| 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
| 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. |
| IsAttributeRelatedToKey() | Gets a value indicating whether or not this attribute is directly or indirectly related to the key attribute |
| 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) |