org.gbif.common.parsers

Class LicenseParser

java.lang.Object

org.gbif.common.parsers.core.DictionaryBackedParser<T>

org.gbif.common.parsers.core.FileBasedDictionaryParser<T>

org.gbif.common.parsers.core.EnumParser<License>

org.gbif.common.parsers.LicenseParser

All Implemented Interfaces:

Parsable<License>

public class LicenseParser
extends EnumParser<License>

Singleton implementation of the dictionary that uses the file /dictionaries/parse/license.txt to lookup a License by its URI or its acronym/title, e.g. a lookup by "CC-BY 4.0" returns License.CC_BY_4_0.
The dictionary file must enforce the GBIF Licensing Policy. Non-CC licenses that GBIF considers equal to one of its three supported CC licenses (CC0 1.0, CC-BY 4.0 and CC-BY-NC 4.0) can be added to this file.
Note a lookup by license acronym/title without a version number defaults to the latest version of that license, e.g. a lookup by "CC-BY" returns License.CC_BY_4_0.

Method Summary

Modifier and Type	Method and Description
static LicenseParser	getInstance()
License	parseUriThenTitle(URI uri, String title) Parse license supplied in two parts: URI and title.

Methods inherited from class org.gbif.common.parsers.core.DictionaryBackedParser

init, parse

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LicenseParser getInstance()

parseUriThenTitle

public License parseUriThenTitle(@Nullable
                                 URI uri,
                                 @Nullable
                                 String title)

Parse license supplied in two parts: URI and title. First parse URI. Only if no URI supplied, parse title. supplied.

Parameters:

uri - optional license URI

title - optional license title

Returns:

License corresponding to license URI or title, License.UNSPECIFIED if both URI and title not supplied, otherwise defaults to License.UNSUPPORTED