com.chemaxon.descriptors.common.comparison.impl

Class SerializingComparisonContextFactory<DC extends DescriptorComparator<D>,D extends Descriptor>

java.lang.Object

com.chemaxon.descriptors.common.comparison.impl.SerializingComparisonContextFactory<DC,D>

Type Parameters:

DC - Represented DescriptorComparator type

D - Descriptor bare representation

All Implemented Interfaces:

ComparisonContextFactory<DC,D,byte[]>, Guarded, MetricFactory<ComparisonContext<DC,D,byte[]>>, Serializable

public class SerializingComparisonContextFactory<DC extends DescriptorComparator<D>,D extends Descriptor>
extends Object
implements ComparisonContextFactory<DC,D,byte[]>

Factory for serializing unguarded contexts.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.common.Guarded

Guarded.EnsureThat, Guarded.New

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.metrics.MetricFactory

MetricFactory.ToLinenote<C>

Constructor Summary

Constructors

Constructor and Description
SerializingComparisonContextFactory(DescriptorSerializer<D> serializer, DC comparator) Construct.

Method Summary

Modifier and Type	Method and Description
Linenote<ComparisonContext<DC,D,byte[]>>	comparisonLinenote() Gets the string based parameterization description.
ComparisonContext<DC,D,byte[]>	defaultComparison() Gets the default comparator object.
DescriptorSerializer<D>	descriptorSerializer() Associated descriptor serializer.
ComparisonContext<DC,D,byte[]>	forComparator(DC comparator) Use a DescriptorComparator as underlying UnguardedDissimilarityCalculator.
static <D extends Descriptor> SerializingComparisonContextFactory<DescriptorComparator<D>,D>	forGenerator(DescriptorGenerator<D> generator) Construct for a generator with default comparator.
Object	getGuardObject() Gets the guard object associated to the generated descriptors/utilities.
Class<? extends MetricFactory>	metricFactoryClass() Represented metric factory class.
String	toString()
SerializingComparisonContextFactory<DC,D>	withComparator(DC comparator)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializingComparisonContextFactory

public SerializingComparisonContextFactory(DescriptorSerializer<D> serializer,
                                           DC comparator)

Construct.

Parameters:

serializer - Underlying serializer

comparator - Exposed comparator

Method Detail

metricFactoryClass

public Class<? extends MetricFactory> metricFactoryClass()

Description copied from interface: ComparisonContextFactory

Represented metric factory class. The represented metric factory interface is expected to have a Description annotation.

Specified by:

metricFactoryClass in interface ComparisonContextFactory<DC extends DescriptorComparator<D>,D extends Descriptor,byte[]>

Returns:

Represented metric factory

forGenerator

public static <D extends Descriptor> SerializingComparisonContextFactory<DescriptorComparator<D>,D> forGenerator(DescriptorGenerator<D> generator)

Construct for a generator with default comparator.

Type Parameters:

D - Represented descriptor type

Parameters:

generator - Generator

Returns:

Context

defaultComparison

public ComparisonContext<DC,D,byte[]> defaultComparison()

Description copied from interface: MetricFactory

Gets the default comparator object.

Specified by:

defaultComparison in interface MetricFactory<ComparisonContext<DC extends DescriptorComparator<D>,D extends Descriptor,byte[]>>

Returns:

default comparator

withComparator

public SerializingComparisonContextFactory<DC,D> withComparator(DC comparator)

forComparator

public ComparisonContext<DC,D,byte[]> forComparator(DC comparator)

Use a DescriptorComparator as underlying UnguardedDissimilarityCalculator. Note that the supplied comparator must be compatible with the underlying generator.

Parameters:

comparator - Comparator to use

Returns:

Context

toString

public String toString()

Overrides:

toString in class Object

getGuardObject

public Object getGuardObject()

Description copied from interface: Guarded

Gets the guard object associated to the generated descriptors/utilities. Note that serialization/deserialization must preserve guard object reference.

This method is intended to use only for ensuring the compatibility of manipulated objects.

Implementations might use the associated DescriptorGenerator or DescriptorParameters reference as the guard object, however it is a non recommended practice to use this method to access the associated generator to perform further operations on it.

Specified by:

getGuardObject in interface Guarded

Returns:

The guard object, can not be null.

descriptorSerializer

public DescriptorSerializer<D> descriptorSerializer()

Description copied from interface: ComparisonContextFactory

Associated descriptor serializer.

Specified by:

descriptorSerializer in interface ComparisonContextFactory<DC extends DescriptorComparator<D>,D extends Descriptor,byte[]>

Returns:

Descriptor serializer.

comparisonLinenote

public Linenote<ComparisonContext<DC,D,byte[]>> comparisonLinenote()

Description copied from interface: MetricFactory

Gets the string based parameterization description. This can be used to automatically compose user interfaces with rich parameterization. Please note that the represented APIs are under development.

Specified by:

comparisonLinenote in interface MetricFactory<ComparisonContext<DC extends DescriptorComparator<D>,D extends Descriptor,byte[]>>

Returns:

Parameterization description