Class SchemaNode

Information about a dataflow row column or column schema. The same SchemaNode instance appears both as a node in the SchemaNodeList flat list and the SchemaNodeRoot hierarchical tree. The root SchemaNodeRoot node however does not appear in the SchemaNodeList flat list.

This class is not instantiated directly, instead use one of the Create(IEnumerable<String>) or overloads.

Also see Dataflow Columns.

Inheritance
Object
SchemaNode
TypeSchemaNode
Namespace: actionETL
Assembly: actionETL.dll
Syntax
public class SchemaNode

Properties

CanRead

true if this member can be read; otherwise false. Defaults to true, but can be modified by derived classes.

TypeSchemaNode sets it to false for properties without any getter (without considering access modifiers (public, private etc). For copying the column value, also see TypeDetail.

Declaration
public bool CanRead { get; protected set; }
Property Value
Type Description
Boolean

CanWrite

true if this member can be written; otherwise false. Defaults to true, but can be modified by derived classes.

TypeSchemaNode sets it to false for properties without any setter (without considering access modifiers (public, private etc). For copying the column value, also see TypeDetail.

Declaration
public bool CanWrite { get; protected set; }
Property Value
Type Description
Boolean

Children

Gets the children of this (row or a column schema struct) instance, or an empty list if there are no children (in the case of a column or unsupported type).

Declaration
public IReadOnlyList<SchemaNode> Children { get; }
Property Value
Type Description
IReadOnlyList<SchemaNode>

HasChildren

Gets a value indicating whether this instance has children.

Declaration
public bool HasChildren { get; }
Property Value
Type Description
Boolean

true if this instance has children; otherwise, false.

IsColumn

Gets a value indicating whether this instance is a column, i.e. a column of data that can potentially be used in a dataflow as a single indivisible unit (and is not a group of other columns or schemas).

Note that for TypeSchemaNode, columns must be public.

Declaration
public bool IsColumn { get; }
Property Value
Type Description
Boolean

true if this instance is a column; otherwise, false.

IsSchema

Gets a value indicating whether this instance is a (row or column) schema, i.e. a group of child columns and schemas.

Note that for TypeSchemaNode, schemas must be public.

Declaration
public bool IsSchema { get; }
Property Value
Type Description
Boolean

true if this instance is a (row or column) schema; otherwise, false.

Level

Gets the level of this instance in the SchemaNodeRoot hierarchical tree. The row is at level 0, its direct children at level 1 etc.

Declaration
public int Level { get; }
Property Value
Type Description
Int32

Name

Gets the full name, with potentially multiple dot-separated parts, e.g. "Product.Weight".

Note that in general, column mapping on the name is done in an ordinal case insensitive manner, although matches with exactly the same casing takes precedence over inexact casing.

Declaration
public string Name { get; }
Property Value
Type Description
String

NameSuffix

Gets the name suffix, i.e. the right-most part of a (potentially) dot-separated name. E.g., if Name is "Product.Weight", then NameSuffix is "Weight".

Note that in general, column mapping on the name is done in an ordinal case insensitive manner, although matches with exactly the same casing takes precedence over inexact casing.

Declaration
public string NameSuffix { get; }
Property Value
Type Description
String

Parent

Gets the (row or column schema struct) parent of this instance, or null if this instance corresponds to the root class.

Declaration
public SchemaNode Parent { get; }
Property Value
Type Description
SchemaNode

SchemaNodeCategory

The type of SchemaNode instance, e.g. whether it is a row schema, a column schema, or a column.

Declaration
public SchemaNodeCategory SchemaNodeCategory { get; }
Property Value
Type Description
SchemaNodeCategory

SchemaNodeListIndex

Gets the index of this instance in the SchemaNodeList flat list.

Declaration
public int SchemaNodeListIndex { get; }
Property Value
Type Description
Int32

Methods

ToString()

Returns a string that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

See Also

RowSchemaBase<TRowSchema, TSchemaNode>