com.chemaxon.descriptors.fingerprints.ecfp

Class ThreadLocalizedEcfpParameters.Builder

java.lang.Object

com.chemaxon.descriptors.fingerprints.ecfp.ThreadLocalizedEcfpParameters.Builder

All Implemented Interfaces:

ParameterBuilder<ThreadLocalizedEcfpParameters>

Enclosing class:

ThreadLocalizedEcfpParameters

public static class ThreadLocalizedEcfpParameters.Builder
extends Object
implements ParameterBuilder<ThreadLocalizedEcfpParameters>

Parameters builder class for ThreadLocalizedEcfpParameters.

Constructor Summary

Constructors

Constructor and Description
Builder() Construct.
Builder(ThreadLocalizedEcfpParameters parameters) Construct from the state of a ThreadLocalizedEcfpParameters.

Method Summary

Modifier and Type	Method and Description
ThreadLocalizedEcfpParameters.Builder	atomTypizer(EcfpAtomTypizers atomTypizer) Set atom typizer to use.
ThreadLocalizedEcfpParameters	build() Build immutable representation.
ThreadLocalizedEcfpParameters.Builder	diameter(int diameter) Sets diameter.
ThreadLocalizedEcfpParameters.Builder	identifierConfigurationXml(String identifierConfigurationXml) Set identifier configuration XML to use for custom typizer.
ThreadLocalizedEcfpParameters.Builder	length(int length) Set fingerprint length, the bit count of the folded binary fingerprint representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Construct.

Builder

public Builder(ThreadLocalizedEcfpParameters parameters)

Construct from the state of a ThreadLocalizedEcfpParameters.

Parameters:

parameters - State to reflect.

Method Detail

diameter

public ThreadLocalizedEcfpParameters.Builder diameter(int diameter)

Sets diameter.

Parameters:

diameter - Diameter to set

Returns:

Reference to this builder

Throws:

IllegalArgumentException - when the set diameter is a negative or odd number

length

public ThreadLocalizedEcfpParameters.Builder length(int length)

Set fingerprint length, the bit count of the folded binary fingerprint representation.

Parameters:

length - new length

Returns:

Reference to this builder

Throws:

IllegalArgumentException - when the set length is not a positive number, or not multiply of 32

atomTypizer

public ThreadLocalizedEcfpParameters.Builder atomTypizer(EcfpAtomTypizers atomTypizer)

Set atom typizer to use.

Parameters:

atomTypizer - Atom typizer to use. Note that when EcfpAtomTypizers.CUSTOMXML is used then the identifier configuration must be set by #identifierConfigurationXmlForCustom(java.lang.String).

Returns:

Reference to this builder

identifierConfigurationXml

public ThreadLocalizedEcfpParameters.Builder identifierConfigurationXml(String identifierConfigurationXml)

Set identifier configuration XML to use for custom typizer. Do not forget to set EcfpAtomTypizers.CUSTOMXML with atomTypizer(com.chemaxon.descriptors.fingerprints.ecfp.EcfpAtomTypizers).

Parameters:

identifierConfigurationXml - Identifier configuration XML.

Returns:

Reference to this builder.

build

public ThreadLocalizedEcfpParameters build()

Build immutable representation.

Specified by:

build in interface ParameterBuilder<ThreadLocalizedEcfpParameters>

Returns:

Immutable parameters object