com.chemaxon.overlap.wui.res

Class DescRes

java.lang.Object

com.chemaxon.overlap.wui.res.DescRes

All Implemented Interfaces:

Described, HasSizeinfo

public class DescRes
extends Object
implements Described, HasSizeinfo

Resource for a descriptor over a molecule file.

Constructor Summary

Constructors

Constructor and Description
DescRes(String description, long time, MolsRes mols, IndexProjector indexProjector, UnguardedPagedOverlap desc, OverlapAnalysisContext context) Construct.

Method Summary

Modifier and Type	Method and Description
OverlapAnalysisContext	getContext() Get overlap analysis context.
UnguardedPagedOverlap	getDesc() Get descriptor storage with default metric.
String	getDescription() Human readable description of the instance.
DescriptorInfo	getDescriptorInfo(String url, String name) Get info about the represented set.
UnguardedPagedOverlap	getDescWithMetric(String metric) Get descriptor storage with specified metric.
IndexProjector	getIndexProjector() Get master index projector.
Linenote<ComparisonContext<?,?,?>>	getMetricSpec() Available metrics specification.
MolsRes	getMols() Associated molecules storage.
String	getMolsRef() URL of associated molecules storage.
long	getSize() Size of the represented resource.
SizeInfoDto	getSizeInfo(Function<Object,Long> sizeof, Function<Object,Long> sizeof2) Invoke size calculation.
long	getTime() Init/load/prepare time of the represented resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescRes

public DescRes(String description,
               long time,
               MolsRes mols,
               IndexProjector indexProjector,
               UnguardedPagedOverlap desc,
               OverlapAnalysisContext context)

Construct.

Parameters:

description - Instance description

time - Associated init/create/load time

mols - Associated molecule storage

indexProjector - Index projector from the descriptors storage

desc - Descriptor storage

context - Associated context

Method Detail

getSizeInfo

public SizeInfoDto getSizeInfo(Function<Object,Long> sizeof,
                               Function<Object,Long> sizeof2)

Description copied from interface: HasSizeinfo

Invoke size calculation.

Specified by:

getSizeInfo in interface HasSizeinfo

Parameters:

sizeof - Function for deep size calculation, expected to handle NoSize annotations.

sizeof2 - Function for deep size calculation of the large storages

Returns:

Size description

getDescription

public String getDescription()

Description copied from interface: Described

Human readable description of the instance.

Specified by:

getDescription in interface Described

Returns:

description

getDescriptorInfo

public DescriptorInfo getDescriptorInfo(String url,
                                        String name)

Get info about the represented set.

Parameters:

url - Url of the descriptor data to expose

name - Name of the descriptor data to expose

Returns:

descriptor info

getContext

public OverlapAnalysisContext getContext()

Get overlap analysis context.

Returns:

Overlap analysis context

getDesc

public UnguardedPagedOverlap getDesc()

Get descriptor storage with default metric. Default metric might be set during the creation (calculation) of the specified descriptors, so might differ from descriptor default (see DescriptorGenerator.defaultComparison() and MetricFactory.defaultComparison()).

Returns:

Descriptor storage with default comparison settings

getDescWithMetric

public UnguardedPagedOverlap getDescWithMetric(String metric)

Get descriptor storage with specified metric. Metric specification is expected to be compatible with the linenote description supplied by getMetricSpec().

Parameters:

metric - Metric description. null and empty String ("") is accepted and the default metric (see getDesc() is returned.

Returns:

Descriptor storage representing specified or the default metric

getIndexProjector

public IndexProjector getIndexProjector()

Get master index projector.

Returns:

INdex projector

getMols

public MolsRes getMols()

Associated molecules storage.

Returns:

Associated molecules storage

getMolsRef

public String getMolsRef()

URL of associated molecules storage.

Returns:

URL of associated molecules storage

getMetricSpec

public Linenote<ComparisonContext<?,?,?>> getMetricSpec()

Available metrics specification.

Returns:

Linenote description

getSize

public long getSize()

Description copied from interface: Described

Size of the represented resource.

Specified by:

getSize in interface Described

Returns:

Size in units described by the associated ResourceInfo.sizeDescription()

getTime

public long getTime()

Description copied from interface: Described

Init/load/prepare time of the represented resource.

Specified by:

getTime in interface Described

Returns:

Associated time