Class LibraryOpenGroup

Namespace

EncDotNet.S100.Collections.Library

Assembly

EncDotNet.S100.Collections.dll

Library items that open together: the local items of one exchange set (or one loose-dataset folder), so a host gives the set one source, one header and one catalogue read.

public sealed record LibraryOpenGroup : IEquatable<LibraryOpenGroup>

Inheritance

object

LibraryOpenGroup

Implements

IEquatable<LibraryOpenGroup>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LibraryOpenGroup(string, string?, bool, IReadOnlyList<CollectionItem>)

Library items that open together: the local items of one exchange set (or one loose-dataset folder), so a host gives the set one source, one header and one catalogue read.

public LibraryOpenGroup(string RootPath, string? CatalogueRelativePath, bool IsZip, IReadOnlyList<CollectionItem> Items)

Parameters

RootPath string

The exchange-set folder, ZIP, or loose-dataset folder.

CatalogueRelativePath string

The catalogue within the root, or null for loose datasets.

IsZip bool

True when RootPath is a ZIP archive.

Items IReadOnlyList<CollectionItem>

The items, each with a LocalItemLocation under the root, in request order.

Properties

CatalogueRelativePath

The catalogue within the root, or null for loose datasets.

public string? CatalogueRelativePath { get; init; }

Property Value

string

IsZip

True when RootPath is a ZIP archive.

public bool IsZip { get; init; }

Property Value

bool

Items

The items, each with a LocalItemLocation under the root, in request order.

public IReadOnlyList<CollectionItem> Items { get; init; }

Property Value

IReadOnlyList<CollectionItem>

RootPath

The exchange-set folder, ZIP, or loose-dataset folder.

public string RootPath { get; init; }

Property Value

string

Source

The Library source the items come from, when the caller says; null otherwise.

public LibrarySourceLabel? Source { get; init; }

Property Value

LibrarySourceLabel

Methods

LocationOf(CollectionItem)

The local location of item (every group item has one).

public static LocalItemLocation LocationOf(CollectionItem item)

Parameters

item CollectionItem

One of Items.

Returns

LocalItemLocation