Class AstAdfTextFormatNode
AstAdfTextFormatNode objects correspond directly to Azure Data Factory TextFormat objects.
Namespace: Varigence.Languages.Biml.DataFactory
Assembly: Biml.dll
C#
public class AstAdfTextFormatNode : AstAdfFormatBaseNode, IBindableItem, IGetJsonProvider, 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 |
|---|---|
| AstAdfTextFormatNode(IFrameworkItem) | Initializes a new instance of the AstAdfTextFormatNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| ColumnDelimiter | Specifies the character used to separate colums in a file. |
| ColumnDelimiterDefaultValue | Gets the default value for the ColumnDelimiter property |
| Encoding | Specifies the name of the encoding used in the file. |
| EncodingDefaultValue | Gets the default value for the Encoding property |
| EscapeChar | Specifies the character used to escape appearances of the ColumnDelimiter within column text data. This property should only be specified if QuoteChar is not provided. |
| EscapeCharDefaultValue | Gets the default value for the EscapeChar property |
| FirstRowAsHeader | Specifies whether or not the first row in the file should be treated as a list of header labels. The default value is false. |
| FirstRowAsHeaderDefaultValue | Gets the default value for the FirstRowAsHeader property |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| NullValue | Specifies the character(s) used to indicate a null value in a column. |
| NullValueDefaultValue | Gets the default value for the NullValue property |
| QuoteChar | Specifies the character used to quote a column value when the ColumnDelimiter appears within the text data for a column. This property should only be specified if EscapeChar is not provided. |
| QuoteCharDefaultValue | Gets the default value for the QuoteChar property |
| RowDelimiter | Specifies the character used to separate rows in a file. |
| RowDelimiterDefaultValue | Gets the default value for the RowDelimiter property |
| SkipLineCount | Specifies the number of lines that should be skipped in the input file before reading data. If FirstRowAsHeader is set to true, the lines will be skipped prior to reading the header row. |
| SkipLineCountDefaultValue | Gets the default value for the SkipLineCount property |
| TreatEmptyAsNull | Specifies whether or not empty string values in a column should be treated as null values in the resulting dataset. The default value is false. |
| TreatEmptyAsNullDefaultValue | Gets the default value for the TreatEmptyAsNull 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. |
| Duplicate() | Creates a duplicate of the current node |
| Duplicate(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| 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 |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| GetSchemaLocalName() | Retrieves the local XML element name that corresponds to this node in Biml code. |
| FirstChildOfType<TChild>() | Gets the first defined descendant node of the specified type |
| RemoveFromParent() | Removes this node definition from its parent |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| 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>) | |
| 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. |
| ParseSelf(XElement, ParserContext) | |
| ParseChild(XElement, ParserContext) | |
| ParseNameValueMapping(XElement) | |
| BindReference(SymbolTable, String, Boolean, String, Int32, Boolean) | |
| GetBimlChildFragment(CulturedStringBuilder, Int32) | |
| HasAnyBimlChildNodes() |