Class: Export::Dwca::GbifProfile::VernacularName

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

Constant Summary collapse

NAMESPACES = 
{
  :taxonID => 'http://rs.tdwg.org/dwc/terms/taxonID',
  :vernacularName => 'http://rs.tdwg.org/dwc/terms/vernacularName',
  :source => 'http://purl.org/dc/terms/source',
  :language => 'http://purl.org/dc/terms/language',
  :temporal => 'http://purl.org/dc/terms/temporal',
  :locationID => 'http://rs.tdwg.org/dwc/terms/locationID',
  :locality => 'http://rs.tdwg.org/dwc/terms/locality',
  :countryCode => 'http://rs.tdwg.org/dwc/terms/countryCode',
  :sex => 'http://rs.tdwg.org/dwc/terms/sex',
  :lifeStage => 'http://rs.tdwg.org/dwc/terms/lifeStage',
  :isPlural => 'http://rs.gbif.org/terms/1.0/isPlural',
  :isPreferredName => 'http://rs.gbif.org/terms/1.0/isPreferredName',
  :organismPart => 'http://rs.gbif.org/terms/1.0/organismPart',
  :taxonRemarks => 'http://rs.tdwg.org/dwc/terms/taxonRemarks'
}.freeze

Instance Attribute Summary collapse

Instance Attribute Details

#countryCode ⇒ String

countryCode (http://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 http://rs.gbif.org/vocabulary/iso/3166-1_alpha2.xml. For multiple countries separate values with a comma ","

Vocabulary: http://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) 


101
102
103
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 101

def countryCode
  @countryCode
end

#isPlural ⇒ String

isPlural (http://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: http://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) 


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

def isPlural
  @isPlural
end

#isPreferredName ⇒ String

isPreferredName (http://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: http://rs.gbif.org/vocabulary/basic/boolean.xml

Example: "True" "False"

Returns:

  • (String) 


159
160
161
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 159

def isPreferredName
  @isPreferredName
end

#language ⇒ String

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

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

Example: "ES", "Spanish", "Español"

Returns:

  • (String) 


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

def language
  @language
end

#lifeStage ⇒ String

lifeStage (http://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: http://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) 


128
129
130
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 128

def lifeStage
  @lifeStage
end

#locality ⇒ String

locality (http://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) 


86
87
88
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 86

def locality
  @locality
end

#locationID ⇒ String

locationID (http://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) 


74
75
76
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 74

def locationID
  @locationID
end

#organismPart ⇒ String

organismPart (http://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) 


171
172
173
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 171

def organismPart
  @organismPart
end

#sex ⇒ String

sex (http://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: http://rs.gbif.org/vocabulary/gbif/sex.xml

Example: "male"

Returns:

  • (String) 


115
116
117
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 115

def sex
  @sex
end

#source ⇒ String

source (http://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) 


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

def source
  @source
end

#taxonID ⇒ String

taxonID (http://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) 


31
32
33
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 31

def taxonID
  @taxonID
end

#taxonRemarks ⇒ String

taxonRemarks (http://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) 


181
182
183
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 181

def taxonRemarks
  @taxonRemarks
end

#temporal ⇒ String

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

temporal context when name is/was used

Example: "19th Century"; 1950

Returns:

  • (String) 


66
67
68
 
# File 'lib/export/dwca/gbif_profile/vernacular_name.rb', line 66

def temporal
  @temporal
end

#vernacularName ⇒ String

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

A common or vernacular name.

Example: Andean Condor", "Condor Andino", "American Eagle", "Gönsegeier"

Returns:

  • (String) 


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

def vernacularName
  @vernacularName
end