• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Class AstTabularColumnNode

Tabular column objects correspond directly to SQL Server Analysis Services (SSAS) Tabular Model table columns, which offer aggregation and other options for use in analytics.

Namespace:
Varigence.Languages.Biml.Tabular
Assembly:
Biml.dll
C#
    public class AstTabularColumnNode : AstSecurableNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstScopeBoundaryNode
AstSecurableNode
AstTabularColumnNode
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

AstTabularColumnNode(IFrameworkItem)

Initializes a new instance of the AstTabularColumnNode class with the specified parent node.

Fields

ScopedNamePrefixBackingStore
IsScopeImported

Properties

Alignment

Specifies the default alignment that should be used when presenting the value of this tabular column within data cells in a user facing application.

AlignmentDefaultValue

Gets the default value for the Alignment property

DataCategory

Specifies the category into which this tabular column should be displayed in user facing applications.

DataCategoryDefaultValue

Gets the default value for the DataCategory property

DataType

Specifies the SSAS tabular data type that should be used for this column. In most cases, the data type can be inferred from the SourceColumn and the SummarizeBy aggregate function. This property is used when that inferred type needs to be overridden.

DataTypeDefaultValue

Gets the default value for the DataType property

Description

Specifies a user facing description that will be used for this tabular column in reporting client tools.

DescriptionDefaultValue

Gets the default value for the Description property

DisplayFolder

Specifies the display folder for this tabular column.

DisplayFolderDefaultValue

Gets the default value for the DisplayFolder property

DisplayOrdinal

Specifies an integer that will be used to determine the ordering of this column relative to other columns in user facing applications.

DisplayOrdinalDefaultValue

Gets the default value for the DisplayOrdinal property

ErrorMessage

Specifies an error message associated with the current state of this tabular column.

ErrorMessageDefaultValue

Gets the default value for the ErrorMessage property

FormatString

Specifies the format to be used when presenting the value of this tabular column in reporting client tools.

FormatStringDefaultValue

Gets the default value for the FormatString property

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

InferRelationships

Specifies whether or not to autocreate tabular relationships for this column.

InferRelationshipsDefaultValue

Gets the default value for the InferRelationships property

IsAvailableInMDX

Specifies whether or not this column is available for use in MDX queries.

IsAvailableInMDXDefaultValue

Gets the default value for the IsAvailableInMDX property

IsHidden

Specifies whether or not this tabular column is hidden from reporting client tools.

IsHiddenDefaultValue

Gets the default value for the IsHidden property

IsNullable

Specifies whether or not the parent column supports null values.

IsNullableDefaultValue

Gets the default value for the IsNullable property

IsUnique

Specifies whether or not the column values are unique amongst themselves.

IsUniqueDefaultValue

Gets the default value for the IsUnique property

KeepUniqueRows

Specifies whether or not values in this column should be grouped based on the corresponding values in the IdentifierColumn specified in the parent table. When true, duplicate values will not be aggregated.

KeepUniqueRowsDefaultValue

Gets the default value for the KeepUniqueRows property

RefreshedTime

Specifies the date and time at which the data in this tabular column was last refreshed from the data source.

RefreshedTimeDefaultValue

Gets the default value for the RefreshedTime property

Relationships

This is a collection of the tabular column references that are defined for the parent source column and a specified target column.

SortByColumn

Specifies a different column in the same table that will be used to sort the values in this column. If not specified, the column will be sorted based on its own values.

SourceColumn

Specifies a reference to the column in the parent table that this tabular model column will summarize.

SummarizeBy

Specifies the tabular aggregate function that should be used to summarize the values in this column.

SummarizeByDefaultValue

Gets the default value for the SummarizeBy property

TableDetailPosition

Specifies the ordinal position of this column when used in a default field set for the parent table. If set to -1, this column will not be included in the default field set for the parent table.

TableDetailPositionDefaultValue

Gets the default value for the TableDetailPosition 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

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)

© Varigence