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

Documentation

Support Forums
What can we help you with?
Topics

Class AstSortColumnNode

The Sort transformation sorts input data in the specified order and then copies the sorted data to an output file. The sort order of columns is indicated by numbering.

Namespace:
Varigence.Languages.Biml.Transformation
Assembly:
Biml.dll
C#
    public class AstSortColumnNode : AstDataflowColumnMappingNode, IBindableItem, IGetJsonProvider, IFrameworkItem, IValidationInfo, INamedItem
    
  
Inheritance
System.Object
AstNode
AstDataflowColumnMappingNode
AstSortColumnNode
Implements

Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo,

Constructors

AstSortColumnNode(IFrameworkItem)

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

Fields

IsScopeImported

Properties

ComparisonFlags

This value specifies a collection of flags that determine specific behaviors of the Sort component when comparing column values.

ComparisonFlagsDefaultValue

Gets the default value for the ComparisonFlags property

ComposedComparisonFlags

Gets or sets a single ComparisonFlags value that consists of the collection of items in the ComparisonFlags property

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

Sort

This value specifies whether this column should be sorted.

SortDefaultValue

Gets the default value for the Sort property

SortOrder

This value specifies the sort order of the column.

SortOrderDefaultValue

Gets the default value for the SortOrder property

Name

Gets or sets the Name of the column mapping, which corresponds directly to the SourceColumn property

SourceColumn

This value specifies the name of the source column in the data flow path mapping.

TargetColumn

This value specifies the name of the destination column in the data flow path mapping.

IsUsed

This value specifies whether the dataflow column is used.

SortKeyPosition

This value specifies where the parent column is situated in the sort order. For example if the rows were first sorted by 2 other columns, then the value would be 3. If this column was not used for sorting, it's value should be 0.

SourceColumnDefaultValue

Gets the default value for the SourceColumn property

TargetColumnDefaultValue

Gets the default value for the TargetColumn property

IsUsedDefaultValue

Gets the default value for the IsUsed property

SortKeyPositionDefaultValue

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

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

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

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)
ParseNameValueMapping(XElement)
BindReference(SymbolTable, String, Boolean, String, Int32, Boolean)

© Varigence