org.openscience.cdk.qsar

Class DescriptorSpecification

java.lang.Object

org.openscience.cdk.qsar.DescriptorSpecification

All Implemented Interfaces:

Serializable, IImplementationSpecification

public class DescriptorSpecification
extends Object
implements Serializable, IImplementationSpecification

Class that is used to distribute descriptor specifications.

See Also:

Serialized Form

Source code:

master

Belongs to CDK module:

standard

Constructor Summary

Constructors

Constructor and Description
DescriptorSpecification(String specificationReference, String implementationTitle, String implementationVendor) Container for specifying the type of descriptor.
DescriptorSpecification(String specificationReference, String implementationTitle, String implementationIdentifier, String implementationVendor) Container for specifying the type of descriptor.

Method Summary

Modifier and Type	Method and Description
String	getImplementationIdentifier() Identifier for this implementation which must include version information.
String	getImplementationTitle() Human-readable name for the implementation for the algorithm specified by the reference.
String	getImplementationVendor() Human-readable name for the vendor that holds copyright for this implementation.
String	getSpecificationReference() Pointer to a dictionary or ontology describing a unique algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptorSpecification

public DescriptorSpecification(String specificationReference,
                               String implementationTitle,
                               String implementationIdentifier,
                               String implementationVendor)

Container for specifying the type of descriptor.

Parameters:

specificationReference - Reference to a formal definition in a dictionary (e.g. in STMML format) of the descriptor, preferably referring to the original article. The format of the content is expected to be <dictionaryNameSpace>:<entryID>.

implementationTitle - Title for the implementation of the descriptor for which the algorithm is given by the specification.

implementationIdentifier - Unique identifier for the actual implementation, preferably including the exact version number of the source code. E.g. $Id$ can be used when the source code is in a CVS repository.

implementationVendor - Name of the organisation/person/program/whatever who wrote/packaged the implementation.

DescriptorSpecification

public DescriptorSpecification(String specificationReference,
                               String implementationTitle,
                               String implementationVendor)

Container for specifying the type of descriptor. The specificationIdentifier is defined by the CDK version.

Parameters:

specificationReference - Reference to a formal definition in a dictionary (e.g. in STMML format) of the descriptor, preferably referring to the original article. The format of the content is expected to be <dictionaryNameSpace>:<entryID>.

implementationTitle - Title for the implementation of the descriptor for which the algorithm is given by the specification.

implementationVendor - Name of the organisation/person/program/whatever who wrote/packaged the implementation.

Method Detail

getSpecificationReference

public String getSpecificationReference()

Description copied from interface: IImplementationSpecification

Pointer to a dictionary or ontology describing a unique algorithm.

Specified by:

getSpecificationReference in interface IImplementationSpecification

Returns:

the URN pointing to a (virtual) dictionary or ontology.

getImplementationTitle

public String getImplementationTitle()

Description copied from interface: IImplementationSpecification

Human-readable name for the implementation for the algorithm specified by the reference.

Specified by:

getImplementationTitle in interface IImplementationSpecification

Returns:

the name of this implementation

getImplementationIdentifier

public String getImplementationIdentifier()

Description copied from interface: IImplementationSpecification

Identifier for this implementation which must include version information. The format is free.

Specified by:

getImplementationIdentifier in interface IImplementationSpecification

Returns:

a free format identifier for this implementation

getImplementationVendor

public String getImplementationVendor()

Description copied from interface: IImplementationSpecification

Human-readable name for the vendor that holds copyright for this implementation.

Specified by:

getImplementationVendor in interface IImplementationSpecification

Returns:

the copyright holder of the implementation