Class AstRootNode
AstRootNode serves as the root of the entire project tree. Anything that can be defined in a Biml project must be a descendant of the AstRootNode, and all constructs in the project can be reached by following a path through the child properties starting at the AstRootNode.
Namespace: Varigence.Languages.Biml
Assembly: Biml.dll
C#
public class AstRootNode : AstNode, IBindableItem, IGetJsonProvider, IDataflowItem, IRootItem, ISymbolTableProvider, IFrameworkItem, IValidationInfo
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,
Constructors
| Constructors | Description |
|---|---|
| AstRootNode(IFrameworkItem) | Initializes a new instance of the AstRootNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| AdoNetConnections | Gets a collection of all AstAdoNetConnectionNode objects contained in the Connections property for this root node |
| BuildSettings | Gets a collection of all root-level items contained by this root node |
| Connections | This is a collection of all connection definitions in the project. |
| CubeProjects | Gets a collection of all AstCubeProjectNode objects contained in the Projects property for this root node |
| Cubes | This is a collection of all SQL Server Analysis Services (SSAS) cube definitions in the project. |
| Databases | This is a collection of all database definitions in the project. |
| DataFactories | This is a collection of all Azure Data Factory linked service, dataset, and pipeline objects in the project. |
| DbConnections | Gets a collection of all AstDbConnectionNode objects contained in the Connections property for this root node |
| Dimensions | Gets a collection of all AstDimensionMetadataNode objects contained in the all Tables for this root node |
| FileFormats | This is a collection of all file format definitions in the project. |
| FlatFileFormats | Gets a collection of all AstFlatFileFormatNode objects contained in the FileFormats property for this root node |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| Items | Gets a collection of all root-level items contained by this root node |
| MeasureGroups | Gets a collection of all AstMeasureGroupMetadataNode objects contained in the all Tables for this root node |
| Metadata | Defines the collection of offline metadata contaiers associated with this Biml project These containers can be used to store query and table column type information which can then be used to perform builds without needing to connect to the live data sources. |
| MetadataInstances | Gets a collection of all AstMetadataInstanceNode objects contained in the Metadata collection for this root node |
| MetadataModels | Gets a collection of all AstMetadataModelNode objects contained in the Metadata collection for this root node |
| OdbcConnections | Gets a collection of all AstOdbcConnectionNode objects contained in the Connections property for this root node |
| OfflineSchemas | Gets a collection of all AstOfflineSchemaNode objects contained in the Metadata collection for this root node |
| OleDbConnections | Gets a collection of all AstOleDbConnectionNode objects contained in the Connections property for this root node |
| PackageProjects | Gets a collection of all AstPackageProjectNode objects contained in the Projects property for this root node |
| Packages | This is a collection of all SQL Server Integration Services package definitions in the project. |
| Principals | This is a collection of all principal definitions in the project. |
| Projects | Defines the collection of PackageProjects and CubeProjects associated with this Biml project. |
| RawFileFormats | Gets a collection of all AstRawFileFormatNode objects contained in the FileFormats property for this root node |
| Schemas | This is a collection of all database schema definitions in the project. |
| ScriptProjects | This is a collection of all SQL Server Integration Services script project definitions in the project. |
| Servers | This is a collection of all server definitions in the project. |
| SymbolTable | Gets the symbol table that is used to track referenceable items in this project. |
| Tables | This is a collection of all regular table definitions in the project. |
| TabularModels | This is a collection of all SQL Server Analysis Services (SSAS) tabular model definitions in the project. |
| TabularProjects | Gets a collection of all AstTabularProjectNode objects contained in the Projects property for this root node |
| TabularTables | Gets a collection of all AstTabularMetadataNode objects contained in the all Tables for this root node |
| 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 |
| GetFriendlyTypeNames() | |
| GetRootItemType(String, String) | Retrieves the type of the root object with the specified collection and XML element name. |
| 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. |
| 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>) | |
| ParseAttribute(XAttribute, ParserContext) | |
| ParseSelf(XElement, ParserContext) | |
| ParseNameValueMapping(XElement) | |
| BindReference(SymbolTable, String, Boolean, String, Int32, Boolean) | |
| GetBimlAttributeFragment(CulturedStringBuilder) |