Class CollectionManifestGroup

Namespace

EncDotNet.S100.Collections.Manifests

Assembly

EncDotNet.S100.Collections.dll

One group of a CollectionManifestDocument.

public sealed record CollectionManifestGroup : IEquatable<CollectionManifestGroup>

Inheritance

object

CollectionManifestGroup

Implements

IEquatable<CollectionManifestGroup>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CollectionManifestGroup(string, string?, string?, IReadOnlyList<string>, bool)

One group of a CollectionManifestDocument.

public CollectionManifestGroup(string Id, string? Name, string? Description, IReadOnlyList<string> Paths, bool Recursive = true)

Parameters

Id string

The group's identifier, unique within the manifest (case-insensitively).

Name string

The display name, or null to use Id.

Description string

An optional description.

Paths IReadOnlyList<string>

The group's paths: relative to the manifest's folder, or absolute. Each is a folder, an exchange set (folder, catalogue or ZIP), or a loose dataset.

Recursive bool

Whether folders are scanned recursively.

Properties

Description

An optional description.

public string? Description { get; init; }

Property Value

string

DisplayName

The name to show: Name, or Id when it has none.

public string DisplayName { get; }

Property Value

string

Id

The group's identifier, unique within the manifest (case-insensitively).

public string Id { get; init; }

Property Value

string

Name

The display name, or null to use Id.

public string? Name { get; init; }

Property Value

string

Paths

The group's paths: relative to the manifest's folder, or absolute. Each is a folder, an exchange set (folder, catalogue or ZIP), or a loose dataset.

public IReadOnlyList<string> Paths { get; init; }

Property Value

IReadOnlyList<string>

Recursive

Whether folders are scanned recursively.

public bool Recursive { get; init; }

Property Value

bool

Methods

ResolvePaths(string)

The group's paths made absolute against manifestDirectory, with either slash accepted and duplicates removed.

public IReadOnlyList<string> ResolvePaths(string manifestDirectory)

Parameters

manifestDirectory string

Returns

IReadOnlyList<string>