com.chemaxon.overlap.cli.util.prop.impl

Class MolnamePropertyExtractor

java.lang.Object

com.chemaxon.overlap.cli.util.prop.impl.MolnamePropertyExtractor

All Implemented Interfaces:

PropertyExtractor<String>, Serializable

public final class MolnamePropertyExtractor
extends Object
implements PropertyExtractor<String>

Extractor for molecule name as String.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MolnamePropertyExtractor(boolean allowMissing)

Method Summary

Modifier and Type	Method and Description
String	extract(StructureRecord mol) Extract/calculate represented property from a structure.
Class<String>	getExtractedType() Extracted type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MolnamePropertyExtractor

public MolnamePropertyExtractor(boolean allowMissing)

Method Detail

getExtractedType

public Class<String> getExtractedType()

Description copied from interface: PropertyExtractor

Extracted type.

Specified by:

getExtractedType in interface PropertyExtractor<String>

Returns:

Extracted type.

extract

public String extract(StructureRecord mol)
               throws IllegalArgumentException

Description copied from interface: PropertyExtractor

Extract/calculate represented property from a structure. Note that an IllegalArgumentException is thrown when the property of the represented type can not be extracted, including the following example cases:

• An SDF property extractor does not find the specified property.
• An SDF property extractor finds the specified property but parsing to the given type fails.
• A Chemical Terms calculator results in a type which is incompatible with the given one.

Specified by:

extract in interface PropertyExtractor<String>

Parameters:

mol - Input structure

Returns:

Extracted property.

Throws:

IllegalArgumentException - when the represented type can not be extracted. Implementation note: this is the expected exception thrown when Chemical Terms are encapsulated and type mismatch surfaces only after execution

toString

public String toString()

Overrides:

toString in class Object