org.gbif.nameparser

Class NameParserGbifV1

java.lang.Object

org.gbif.nameparser.NameParserGbifV1

All Implemented Interfaces:

NameParser

public class NameParserGbifV1
extends Object
implements NameParser

A name parser wrapped to return classic ParsedName objects from the GBIF API v1.

Constructor Summary

Constructors

Constructor and Description
NameParserGbifV1() Using the default GBIF RegEx Name Parser.
NameParserGbifV1(long timeout) Using the default GBIF RegEx Name Parser with a given timeout for parsing a single name.
NameParserGbifV1(org.gbif.nameparser.NameParserGBIF parser)

Method Summary

Modifier and Type	Method and Description
static org.gbif.nameparser.api.Rank	fromGbif(Rank rank)
static NameType	gbifNameType(org.gbif.nameparser.api.ParsedName pn)
long	getTimeout()
ParsedName	parse(String scientificName) Delegate method to parse a scientific name of unknown rank.
ParsedName	parse(String s, Rank rank) Fully parse the supplied name also trying to extract authorships, a conceptual sec reference, remarks or notes on the nomenclatural status.
ParsedName	parseQuietly(String scientificName) Delegate method to parse a scientific name of unknown rank quietly.
ParsedName	parseQuietly(String scientificName, Rank rank) Fully parses a name using #parse(String, Rank) but converts names that throw a UnparsableException into ParsedName objects with the scientific name, rank and name type given.
String	parseToCanonical(String scientificName) Delegate method to parse a scientific name of unknown rank and return its canonical form.
String	parseToCanonical(String scientificName, Rank rank) Parses the scientific name without authorship and returns the ParsedName.canonicalName() string
String	parseToCanonicalOrScientificName(String scientificName)
String	parseToCanonicalOrScientificName(String scientificName, Rank rank) Tries to parses the name without authorship and returns the ParsedName.canonicalName() string For unparsable types and other UnparsableExceptions the original scientific name is returned.
void	setTimeout(long timeout)
static NamePart	toGbif(org.gbif.nameparser.api.NamePart notho)
static Rank	toGbif(org.gbif.nameparser.api.Rank rank)

Methods inherited from class java.lang.Object

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

Constructor Detail

NameParserGbifV1

public NameParserGbifV1()

Using the default GBIF RegEx Name Parser.

NameParserGbifV1

public NameParserGbifV1(long timeout)

Using the default GBIF RegEx Name Parser with a given timeout for parsing a single name.

Parameters:

timeout - in milliseconds before returning an Unparsable name

NameParserGbifV1

public NameParserGbifV1(org.gbif.nameparser.NameParserGBIF parser)

Method Detail

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

parse

public ParsedName parse(String s,
                        @Nullable
                        Rank rank)
                 throws UnparsableException

Description copied from interface: NameParser

Fully parse the supplied name also trying to extract authorships, a conceptual sec reference, remarks or notes on the nomenclatural status. In some cases the authorship parsing proves impossible and this nameparser will return null. For strings which are no scientific names and scientific names that cannot be expressed by the ParsedName class the parser will throw an UnparsableException with a given NameType and the original, unparsed name. This is the case for all virus names and proper hybrid formulas, so make sure you catch and process this exception.

Specified by:

parse in interface NameParser

Parameters:

s - the full scientific name to parse

rank - the rank of the name if it is known externally. Helps identifying infrageneric names vs bracket authors

Returns:

the parsed name

Throws:

UnparsableException

parse

public ParsedName parse(String scientificName)
                 throws UnparsableException

Description copied from interface: NameParser

Delegate method to parse a scientific name of unknown rank.

Specified by:

parse in interface NameParser

Returns:

the parsed name

Throws:

UnparsableException

parseQuietly

public ParsedName parseQuietly(String scientificName,
                               @Nullable
                               Rank rank)

Description copied from interface: NameParser

Fully parses a name using #parse(String, Rank) but converts names that throw a UnparsableException into ParsedName objects with the scientific name, rank and name type given.

Specified by:

parseQuietly in interface NameParser

Returns:

the parsed name

parseQuietly

public ParsedName parseQuietly(String scientificName)

Description copied from interface: NameParser

Delegate method to parse a scientific name of unknown rank quietly.

Specified by:

parseQuietly in interface NameParser

Returns:

the parsed name

parseToCanonical

public String parseToCanonical(String scientificName,
                               @Nullable
                               Rank rank)

Description copied from interface: NameParser

Parses the scientific name without authorship and returns the ParsedName.canonicalName() string

Specified by:

parseToCanonical in interface NameParser

Parameters:

scientificName - the full scientific name to parse

rank - the rank of the name if it is known externally. Helps identifying infrageneric names vs bracket authors

Returns:

the canonical name or null for unparsable names

parseToCanonical

public String parseToCanonical(String scientificName)

Description copied from interface: NameParser

Delegate method to parse a scientific name of unknown rank and return its canonical form.

Specified by:

parseToCanonical in interface NameParser

parseToCanonicalOrScientificName

public String parseToCanonicalOrScientificName(String scientificName)

parseToCanonicalOrScientificName

public String parseToCanonicalOrScientificName(String scientificName,
                                               @Nullable
                                               Rank rank)

Tries to parses the name without authorship and returns the ParsedName.canonicalName() string For unparsable types and other UnparsableExceptions the original scientific name is returned.

Parameters:

rank - the rank of the name if it is known externally. Helps identifying infrageneric names vs bracket authors

gbifNameType

public static NameType gbifNameType(org.gbif.nameparser.api.ParsedName pn)

toGbif

public static NamePart toGbif(org.gbif.nameparser.api.NamePart notho)

toGbif

public static Rank toGbif(org.gbif.nameparser.api.Rank rank)

fromGbif

public static org.gbif.nameparser.api.Rank fromGbif(Rank rank)