Class S128CatalogueIndexer

Namespace

EncDotNet.S100.Collections.Indexing

Assembly

EncDotNet.S100.Collections.dll

Indexes an S128CatalogueSource: each product entry of an S-128 Catalogue of Nautical Products becomes a catalogue-only item (NoItemLocation) carrying the product's identification, currency and coverage.

public sealed class S128CatalogueIndexer : ICollectionSourceIndexer

Inheritance

object

S128CatalogueIndexer

Implements

ICollectionSourceIndexer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CanIndex(CollectionSource)

Returns true when this indexer handles source.

public bool CanIndex(CollectionSource source)

Parameters

source CollectionSource

Returns

bool

GetFingerprintAsync(CollectionSource, CancellationToken)

Cheaply computes a fingerprint of the source's current state. When it equals a previous index's Fingerprint, that index is still valid. Returns null when the state cannot be determined (for example the source is unavailable).

public ValueTask<string?> GetFingerprintAsync(CollectionSource source, CancellationToken cancellationToken)

Parameters

source CollectionSource

cancellationToken CancellationToken

Returns

ValueTask<string>

IndexAsync(CollectionSource, IProgress<IndexProgress>?, CancellationToken)

Indexes source.

public ValueTask<SourceIndex> IndexAsync(CollectionSource source, IProgress<IndexProgress>? progress, CancellationToken cancellationToken)

Parameters

source CollectionSource

progress IProgress<IndexProgress>

cancellationToken CancellationToken

Returns

ValueTask<SourceIndex>

MapEntries(S128Dataset)

Maps every product entry of an already-parsed S-128 dataset onto catalogue-only items (for example a dataset the host has loaded).

public static IReadOnlyList<CollectionItem> MapEntries(S128Dataset dataset)

Parameters

dataset S128Dataset

Returns

IReadOnlyList<CollectionItem>