Class: Dwca::GbifProfile::VernacularName

Inherits:
Object
  • Object
show all
Defined in:
lib/dwca/gbif_profile/vernacular_name.rb

Instance Attribute Summary (collapse)

Instance Attribute Details

- (String) countryCode

countryCode (rs.tdwg.org/dwc/terms/countryCode)

The standard code for the country in which the vernacular name is used. Recommended best practice is to use the ISO 3166-1-alpha-2 country codes available as a vocabulary at rs.gbif.org/vocabulary/iso/3166-1_alpha2.xml. For multiple countries separate values with a comma “,”

Vocabulary: rs.gbif.org/vocabulary/iso/3166-1_alpha2.xml

Example: “AR” for Argentina, “SV” for El Salvador. “AR,CR,SV” for Argentina, Costa Rica, and El Salvador combined.

Returns:

  • (String)


84
85
86
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 84

def countryCode
  @countryCode
end

- (String) isPlural

isPlural (rs.gbif.org/terms/1.0/isPlural)

This value is true if the vernacular name it qualifies refers to a plural form of the name.

Vocabulary: rs.gbif.org/vocabulary/basic/boolean.xml

Example: The term “Schoolies” is the plural form of a name used along the coastal Northeastern U.S. for groups of juvenile fish of the species, Morone saxatilis.

Returns:

  • (String)


124
125
126
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 124

def isPlural
  @isPlural
end

- (String) isPreferredName

isPreferredName (rs.gbif.org/terms/1.0/isPreferredName)

This term is true if the source citing the use of this vernacular name indicates the usage has some preference or specific standing over other possible vernacular names used for the species. Some organisations have attempted to assign specific and unique vernacular names for particular taxon groups in a systematic attempt to bring order and consistency to the use of these names. For example, the American Ornithological Union assigns the name “Pearl Kite” for the taxon, Gampsonyx swainsonii. The value of isPreferredName for this record would be true.

Vocabulary: rs.gbif.org/vocabulary/basic/boolean.xml

Example: “True” “False”

Returns:

  • (String)


142
143
144
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 142

def isPreferredName
  @isPreferredName
end

- (String) language

language (purl.org/dc/terms/language)

ISO 639-1 language code used for the vernacular name value.

Example: “ES”, “Spanish”, “Español”

Returns:

  • (String)


41
42
43
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 41

def language
  @language
end

- (String) lifeStage

lifeStage (rs.tdwg.org/dwc/terms/lifeStage)

The age class or life stage of the species for which the vernacular name applies. Best practice is to utilise a controlled list of terms for this value.

Vocabulary: rs.gbif.org/vocabulary/gbif/life_stage.xml

Example: ‘juvenile“ is the life stage of the fish Pomatomus saltatrix for which the name ”snapper blue“ refers.’

Returns:

  • (String)


111
112
113
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 111

def lifeStage
  @lifeStage
end

- (String) locality

locality (rs.tdwg.org/dwc/terms/locality)

The specific description of the area from which the vernacular name usage originates. Vernacular names may have very specific regional contexts. A name used for a species in one area may refer to a different species in another.

Example: “Southeastern coastal New England from Buzzards Bay through Rhode Island”

Returns:

  • (String)


69
70
71
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 69

def locality
  @locality
end

- (String) locationID

locationID (rs.tdwg.org/dwc/terms/locationID)

An identifier for the set of location information (data associated with dcterms:Location). May be a global unique identifier or an identifier specific to the data set.

Returns:

  • (String)


57
58
59
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 57

def locationID
  @locationID
end

- (String) organismPart

organismPart (rs.gbif.org/terms/1.0/organismPart)

The part of the organism to which the vernacular name refers. Best practice is to utilise a controlled vocabulary for this term although it is likely that multiple controlled lists for different organism groups may be the best implementation for this term. The spice “Mace”, is derived from the “aril” of the plant Myristica fragrans while the spice “nutmeg” is derived from the “seed.” “Seed” and “Aril” represent two different values for organismPart.

Returns:

  • (String)


154
155
156
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 154

def organismPart
  @organismPart
end

- (String) sex

sex (rs.tdwg.org/dwc/terms/sex)

The sex (gender) of the taxon for which the vernacular name applies when the vernacular name is limited to a specific gender of a species. If not limited sex should be empty. For example the vernacular name “Buck” applies to the “Male” gender of the species, Odocoileus virginianus.

Vocabulary: rs.gbif.org/vocabulary/gbif/sex.xml

Example: “male”

Returns:

  • (String)


98
99
100
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 98

def sex
  @sex
end

- (String) source

source (purl.org/dc/terms/source)

Bibliographic citation referencing a source where the vernacular name refers to the cited species.

Example: “Peterson Field Guide to the Eastern Seashore, Houghton Mifflin Co, 1961, p131”

Returns:

  • (String)


33
34
35
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 33

def source
  @source
end

- (String) taxonID

taxonID (rs.tdwg.org/dwc/terms/taxonID)

The first field in the data file should be the taxonID representing the taxon in the core data file to which this vernacular name points. This identifier provides the link between the core data record and the extension record.

Returns:

  • (String)


14
15
16
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 14

def taxonID
  @taxonID
end

- (String) taxonRemarks

taxonRemarks (rs.tdwg.org/dwc/terms/taxonRemarks)

A description of any context that qualify the specific usage of the vernacular name.

Example: “This name applies only when the fruit has been blessed by a tribal shaman”

Returns:

  • (String)


164
165
166
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 164

def taxonRemarks
  @taxonRemarks
end

- (String) temporal

temporal (purl.org/dc/terms/temporal)

temporal context when name is/was used

Example: “19th Century”; 1950

Returns:

  • (String)


49
50
51
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 49

def temporal
  @temporal
end

- (String) vernacularName

vernacularName (rs.tdwg.org/dwc/terms/vernacularName)

A common or vernacular name.

Example: Andean Condor“, ”Condor Andino“, ”American Eagle“, ”Gönsegeier“

Returns:

  • (String)


23
24
25
# File 'lib/dwca/gbif_profile/vernacular_name.rb', line 23

def vernacularName
  @vernacularName
end