de.bioforscher.singa.core.identifier

Class PubChemIdentifier

java.lang.Object

de.bioforscher.singa.core.identifier.model.AbstractIdentifier

de.bioforscher.singa.core.identifier.PubChemIdentifier

All Implemented Interfaces:

Identifier

public class PubChemIdentifier
extends AbstractIdentifier

This identifier is used by the PubChem Database to identify small molecules.

The identifier usually only contains numbers. Sometimes the number is preceded by "CID:". To make this identifier more "identifiable" we require the suffix "CID:".

Author:

cl

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	PATTERN The pattern to verify the identifier.

Constructor Summary

Constructors

Constructor and Description
PubChemIdentifier(String identifier) Creates a new identifier.

Method Summary

Modifier and Type	Method and Description
static boolean	check(Identifier identifier) Returns true, if the identifier is valid.
static Optional<Identifier>	find(Collection<Identifier> identifiers) Searches a valid PubChem identifier in a collection of identifiers and returns it.
int	getConsecutiveNumber() Returns the consecutive number without the "CID:" part.
static Pattern	getPattern() Returns the pattern used to validate the identifier.

Methods inherited from class de.bioforscher.singa.core.identifier.model.AbstractIdentifier

equals, getIdentifier, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATTERN

public static final Pattern PATTERN

The pattern to verify the identifier.

Constructor Detail

PubChemIdentifier

public PubChemIdentifier(String identifier)
                  throws IllegalArgumentException

Creates a new identifier.

Parameters:

identifier - The identifier.

Throws:

IllegalArgumentException - If the identifier not valid.

Method Detail

check

public static boolean check(Identifier identifier)

Returns true, if the identifier is valid.

Parameters:

identifier - The identifier.

Returns:

True, if the identifier is valid.

find

public static Optional<Identifier> find(Collection<Identifier> identifiers)

Searches a valid PubChem identifier in a collection of identifiers and returns it.

Parameters:

identifiers - A collection of identifiers.

Returns:

The first PubChem identifier or an empty optional if no identifier could be found.

getPattern

public static Pattern getPattern()

Returns the pattern used to validate the identifier.

Returns:

The pattern used to validate the identifier.

getConsecutiveNumber

public int getConsecutiveNumber()

Returns the consecutive number without the "CID:" part.

Returns:

The consecutive number without the "CID:" part.