TransformOptions.cs

using JSONstat.Models;

namespace JSONstat.Transform;

/// <summary>The tabular output shape of <see cref="Dataset.Transform"/>.</summary>
public enum TransformType
{
    /// <summary>An array of arrays (a header row followed by data rows).</summary>
    ArrayOfArrays,

    /// <summary>An array of objects (one object per cell).</summary>
    ArrayOfObjects,

    /// <summary>An object whose values are column arrays.</summary>
    ObjectOfArrays,

    /// <summary>An object keyed by a composite of the cell coordinates.</summary>
    Object
}

/// <summary>Whether to use ids or labels for the dimension field (column key).</summary>
public enum TransformField
{
    /// <summary>Use the dimension id.</summary>
    Id,

    /// <summary>Use the dimension label.</summary>
    Label
}

/// <summary>Whether to use ids or labels for the category content (cell value).</summary>
public enum TransformContent
{
    /// <summary>Use the category id.</summary>
    Id,

    /// <summary>Use the category label.</summary>
    Label
}

/// <summary>Options for <see cref="Dataset.Transform"/>.</summary>
public sealed class TransformOptions
{
    /// <summary>The output shape. Defaults to <see cref="TransformType.ArrayOfArrays"/>.</summary>
    public TransformType Type { get; set; } = TransformType.ArrayOfArrays;

    /// <summary>Dimension field form. <c>null</c> = type-dependent default
    /// (<see cref="TransformField.Label"/> for <see cref="TransformType.ArrayOfArrays"/>,
    /// <see cref="TransformField.Id"/> otherwise).</summary>
    public TransformField? Field { get; set; }

    /// <summary>Category content form. <c>null</c> = <see cref="TransformContent.Label"/>.</summary>
    public TransformContent? Content { get; set; }

    /// <summary>Include the status column. Defaults to <c>false</c>.</summary>
    public bool Status { get; set; }

    /// <summary>Label for the value column. Defaults to "Value".</summary>
    public string ValueLabel { get; set; } = "Value";

    /// <summary>Label for the status column. Defaults to "Status".</summary>
    public string StatusLabel { get; set; } = "Status";

    /// <summary>Include metadata (reserved; currently ignored).</summary>
    public bool Meta { get; set; }

    /// <summary>Dimension id to transpose on (reserved; currently ignored).</summary>
    public string? By { get; set; }

    /// <summary>Prefix for transposed properties (reserved; currently ignored).</summary>
    public string? Prefix { get; set; }

    /// <summary>Dimension ids to exclude from the output.</summary>
    public string[]? Drop { get; set; }

    /// <summary>Use a comma decimal mark for values. Defaults to <c>false</c>.</summary>
    public bool Comma { get; set; }
}