com.chemaxon.overlap.cli.util

Interface DescriptorsWithIds<T extends Serializable>

Type Parameters:

T - Unguarded descriptor form.

All Superinterfaces:

Serializable

All Known Implementing Classes:

DescriptorsWithIdsImpl

public interface DescriptorsWithIds<T extends Serializable>
extends Serializable

Represents unguarded descriptors with IDs. This abstraction is typically used by searchStorage to represent imported data from various sources.

Method Summary

Modifier and Type	Method and Description
OverlapAnalysisContext<?,T>	getContext() Get represented OverlapAnalysisContext.
UnguardedPagedOverlap<T>	getDescriptors() Represented descriptors.
MasterStringStorage	getIds() Represented IDs.
IndexProjector	getIndexProjector() Get represented index projector.
default ImmutableList<T>	getUnguardedsAsFlatList() Get unguarded descriptors in a flat List.
default UnmodifiableIterator<ImmutableList<T>>	iterateUnguardedsInPages(int pagesize) Iterate unguarded descriptors in fixed size lists.
default long	size() Get represented descriptor count.
default String	toMultilineString() Print details to a multiline String.
DescriptorsWithIds<T>	withMetric(String metricOrNull) Use specified metric.

Method Detail

getIds

MasterStringStorage getIds()

Represented IDs. Storage is always returned, however some of the stored IDs might be missing.

Returns:

represented IDs.

getDescriptors

UnguardedPagedOverlap<T> getDescriptors()

Represented descriptors.

Returns:

represented descriptors

getUnguardedsAsFlatList

default ImmutableList<T> getUnguardedsAsFlatList()

Get unguarded descriptors in a flat List.

Returns:

Unguarded descriptors

iterateUnguardedsInPages

default UnmodifiableIterator<ImmutableList<T>> iterateUnguardedsInPages(int pagesize)

Iterate unguarded descriptors in fixed size lists.

Parameters:

pagesize - Max size of iterated descriptor pages

Returns:

Page iterator

getIndexProjector

IndexProjector getIndexProjector()

Get represented index projector.

Returns:

Index projector

size

default long size()

Get represented descriptor count.

Returns:

Represented descriptor count

getContext

OverlapAnalysisContext<?,T> getContext()

Get represented OverlapAnalysisContext.

Returns:

represented context

withMetric

DescriptorsWithIds<T> withMetric(String metricOrNull)

Use specified metric.

Parameters:

metricOrNull - Metric to use or null to use default

Returns:

An instance exposing the specified metric

toMultilineString

default String toMultilineString()

Print details to a multiline String.

Returns:

Multiline String representation