View on GitHub
A collecting event describes how something (e.g. a CollectionObject) was aquired. It is the unique combination of who, where, when, and how.
@!attribute verbatim_label
@return [String]
A verbatim representation of label that defined this collecting event, typically, but not exclusively,
used for retroactive data capture.
@!attribute print_label
@return [String]
A print-formatted ready representation of this collecting event. !! Do not assume that this remains static,
it can change over time with user needs.
@!attribute document_label
@return [String]
A print-ready expanded/clarified version of a verbatim_label intended to clarify interpretation of that label.
To be used, for example, when reporting Holotype labels.
@!attribute verbatim_locality
@return [String]
a string, typically sliced from verbatim_label, that represents the locality, including any modifiers (2 mi NE).
@!attribute verbatim_longitude
@return [String]
A string, typically sliced from verbatim_label, that represents the longitude. Is used to derive mappable values, but does not get mapped itself
@!attribute verbatim_latitude
@return [String]
A string, typically sliced from verbatim_label, that represents the latitude. Is used to derive mappable values, but does not get mapped itself.
@!attribute verbatim_geolocation_uncertainty
@return [String]
A string, typically sliced from verbatim_label, that represents the provided uncertainty value.
@!attribute verbatim_trip_identifier
@return [String]
the literal string/identifier used by the collector(s) to identify this particular collecting event, usually part of a series particular to one trip
@!attribute verbatim_collectors
@return [String]
the literal string that indicates the collectors, typically taken right off the label
@!attribute verbatim_method
@return [String]
the literal string that indicates the collecting method, typically taken right off the label
@!attribute geographic_area_id
@return [Integer]
the finest geo-political unit that this collecting event can be localized to, can be used for gross georeferencing when Georeference not available
@!attribute minimum_elevation
@return [String]
A float, in meters.
@!attribute maximum_elevation
@return [String]
A float, in meters.
@!attribute elevation_precision
@return [String]
A float, in meters.
@!attribute field_notes
@return [String]
Any/all field notes that this collecting event was derived from, or that supplement this collecting event.
@!attribute md5_of_verbatim_label
@return [String]
application defined, an index to the verbatim label
@!attribute cached
@return [String]
A string, typically sliced from verbatim_label, that represents the provided uncertainty value.
@!attribute project_id
@return [Integer]
the project ID
@!attribute start_date_year
@return [Integer]
the four digit year, start of the collecting event
@!attribute end_date_year
@return [Integer]
the four digit year, end of the collecting event
@!attribute start_date_day
@return [Integer]
the day of the month the collecting event started on
@!attribute end_date_day
@return [Integer]
the date of the month the collecting event ended on
@!attribute verbatim_elevation
@return [String]
A string, typically sliced from verbatim_label, that represents all elevation data (min/max/precision) as recorded there.
@!attribute verbatim_habitat
@return [String]
a literal string, typically taken from the printed label, tha represents assertions about the habitat
@!attribute verbatim_datum
@return [String]
@todo
@!attribute time_start_hour
@return [Integer]
0-23
@!attribute time_start_minute
@return [Integer]
0-59
@!attribute time_start_second
@return [Integer]
0-59
@!attribute time_end_hour
@return [Integer]
0-23
@!attribute time_end_minute
@return [Integer]
0-59
@!attribute time_end_second
@return [Integer]
0-59
@!attribute verbatim_date
@return [String]
the string representation, typically as taken from the label, of the date
@!attribute start_date_month
@return [Integer]
the month, from 0-12, that the collecting event started on
@!attribute end_date_month
@return [Integer]
the month, from 0-12, that the collecting event ended on
@!attribute group
@return [String, nil]
member sensu PBDB
@!attribute formation
@return [String, nil]
formation sensu PBDB
@!attribute member
@return [String, nil]
member sensu PBDB
@!attribute lithology
@return [String, nil]
lithology sensu PBDB
@!attribute max_ma
@return [Decimal, nil]
max_ma (million years) sensu PBDB
@!attribute min_ma
@return [Decimal, nil]
min_ma (million years) sensu PBDB
@!attribute cached_level0_geographic_name
@return [String, nil]
the auto-calculated level0 (= country in TaxonWorks) value drawn from GeographicNames, never directly user supplied
@!attribute cached_level1_geographic_name
@return [String, nil]
the auto-calculated level1 (typically state/province) value drawn from GeographicNames, never directly user supplied
@!attribute cached_level2_geographic_name
@return [String, nil]
the auto-calculated level2 value (e.g. county) drawn from GeographicNames, never directly user supplied