DataItem

Class DataItem

Namespace: DataWarehouseAutomation.DwaModel
Assembly: DataWarehouseAutomation.dll

Data items belong to data objects or data object queries. This means that a given data item always has a parent object. They describe the individual elements, such as the columns in a table or headers in a file.

public class DataItem : IDataItem

Inheritance

object ← DataItem

Implements

IDataItem

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

CharacterLength

The length, number of characters for the IDataItem.

[JsonPropertyName("characterLength")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? CharacterLength { get; set; }

Property Value

int?

Classifications

Free-form and optional classification for the Data Item for use in generation logic (evaluation).

[JsonPropertyName("classifications")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DataClassification>? Classifications { get; set; }

Property Value

List<DataClassification>?

DataObject

The to which the data item belongs. This can be used to construct fully qualified names.

[JsonPropertyName("dataObject")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public IDataObject? DataObject { get; set; }

Property Value

IDataObject?

DataType

The data type of the IDataItem. E.g. VARCHAR, int, text.

[JsonPropertyName("dataType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DataType { get; set; }

Property Value

string?

Extensions

The collection of extension Key/Value pairs.

[JsonPropertyName("extensions")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<Extension>? Extensions { get; set; }

Property Value

List<Extension>?

Id

Identifier as a string value to allow various identifier approaches.

[JsonPropertyName("id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Id { get; set; }

Property Value

string?

IsPrimaryKey

An indicator to flag whether this IDataItem is part of a Primary Key.

[JsonPropertyName("isPrimaryKey")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? IsPrimaryKey { get; set; }

Property Value

bool?

Name

The name of the IDataItem.

[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
public string Name { get; set; }

Property Value

string

Notes

Free-format notes.

[JsonPropertyName("notes")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Notes { get; set; }

Property Value

string?

NumericPrecision

The precision for the IDataItem.

[JsonPropertyName("numericPrecision")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? NumericPrecision { get; set; }

Property Value

int?

NumericScale

The number of decimal points for the IDataItem.

[JsonPropertyName("numericScale")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? NumericScale { get; set; }

Property Value

int?

OrdinalPosition

The position of the IDataItem in a Data Object or Data Object Query.

[JsonPropertyName("ordinalPosition")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? OrdinalPosition { get; set; }

Property Value

int?

Methods

Equals(object?)

Use this method to assert if two Data Items are the same, based on their Ids.

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

True if the Data Items are the same, based on their Ids

GetHashCode()

Override to get a hash value that represents the identifier.

public override int GetHashCode()

Returns

int

A 32-bit signed integer hash code

ToString()

String override so that the object returns its value (‘name’). When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the “Name” property will be returned.

public override string ToString()

Returns

string

The Name