Package org.openscience.cdk.reaction
Class ReactionSpecification
- java.lang.Object
-
- org.openscience.cdk.reaction.ReactionSpecification
-
- All Implemented Interfaces:
IImplementationSpecification
public class ReactionSpecification extends Object implements IImplementationSpecification
Class that is used to distribute reactions specifications.- Author:
- Miguel Rojas
- Source code:
- main
- Belongs to CDK module:
- reaction
-
-
Constructor Summary
Constructors Constructor Description ReactionSpecification(String specificationReference, String implementationTitle, String implementationIdentifier, String implementationVendor)
Container for specifying the type of reaction.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Constructor Detail
-
ReactionSpecification
public ReactionSpecification(String specificationReference, String implementationTitle, String implementationIdentifier, String implementationVendor)
Container for specifying the type of reaction.- Parameters:
specificationReference
- Reference to a formal definition in a dictionary (e.g. in STMML format) of the descriptor, preferably refering to the original article. The format of the content is expected to be <dictionaryNameSpace>:<entryID>.implementationTitle
- Title for the reaction process.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.
-
-
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 interfaceIImplementationSpecification
- 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 interfaceIImplementationSpecification
- 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 interfaceIImplementationSpecification
- 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 interfaceIImplementationSpecification
- Returns:
- the copyright holder of the implementation
-
-