Class: TaxonNameRelationship::OriginalCombination

Inherits:
TaxonNameRelationship show all
Defined in:
app/models/taxon_name_relationship/original_combination.rb

Overview

Discussion (MJY, DD, 1/9/15) - It may be that this is semantically identical to Combination, and that we can infer the difference, i.e. functionality might get simplified/merged in the future.

Conclusion- remains fixed as is, Combination becomes citable, Protonym not.

Direct Known Subclasses

OriginalForm, OriginalGenus, OriginalSpecies, OriginalSubform, OriginalSubgenus, OriginalSubspecies, OriginalSubvariety, OriginalVariety

Defined Under Namespace

Classes: OriginalForm, OriginalGenus, OriginalSpecies, OriginalSubform, OriginalSubgenus, OriginalSubspecies, OriginalSubvariety, OriginalVariety

Constant Summary

Constant Summary

Constants included from SoftValidation

SoftValidation::ANCESTORS_WITH_SOFT_VALIDATIONS

Instance Attribute Summary

Attributes inherited from TaxonNameRelationship

#no_cached, #object_taxon_name_id, #project_id, #subject_taxon_name_id, #type

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from TaxonNameRelationship

assignable, collect_descendants_and_itself_to_s, collect_descendants_to_s, collect_to_s, disjoint_object_classes, disjoint_subject_classes, disjoint_taxon_name_relationships, gbif_status_of_object, gbif_status_of_subject, #is_combination?, #is_invalidating?, nomen_uri, #nomenclature_date, #object_properties, #object_status_tag, required_taxon_name_relationships, #set_cached_names_for_taxon_names, #subject_properties, #subject_status_tag, #sv_coordinated_taxa, #sv_fix_combination_relationship, #sv_fix_coordinated_object_taxa, #sv_fix_coordinated_subject_taxa, #sv_fix_specify_homonymy_type, #sv_fix_specify_synonymy_type, #sv_fix_subject_parent_update, #sv_matching_type_genus, #sv_not_specific_relationship, #sv_objective_synonym_relationship, #sv_specific_relationship, #sv_synonym_linked_to_valid_name, #sv_synonym_relationship, #sv_validate_disjoint_object, #sv_validate_disjoint_relationships, #sv_validate_disjoint_subject, #sv_validate_priority, #sv_validate_required_relationships, #type_class, #type_class=, #type_name, valid_object_ranks, valid_subject_ranks, #validate_object_and_subject_both_protonyms, #validate_object_must_equal_subject_for_uncertain_placement, #validate_rank_group, #validate_subject_and_object_are_not_identical, #validate_subject_and_object_ranks, #validate_subject_and_object_share_code, #validate_type, #validate_uniqueness_of_typification_object

Methods included from SoftValidation

#clear_soft_validations, #fix_soft_validations, #soft_fixed?, #soft_valid?, #soft_validate, #soft_validated?, #soft_validations

Methods included from Housekeeping

#has_polymorphic_relationship?

Methods included from ActiverecordUtilities

#trim_attributes

Class Method Details

+ (Object) nomenclatural_priority



13
14
15
# File 'app/models/taxon_name_relationship/original_combination.rb', line 13

def self.nomenclatural_priority
  :reverse
end

+ (Object) order_index

TODO: Why only ICN?



24
25
26
# File 'app/models/taxon_name_relationship/original_combination.rb', line 24

def self.order_index
  RANKS.index(::ICN_LOOKUP[self.name.demodulize.underscore.humanize.downcase.gsub('original ', '')])
end

Instance Method Details

- (Symbol) applicable_rank

Returns the rank this relationship applies to as a symbol

Returns:

  • (Symbol)

    the rank this relationship applies to as a symbol



19
20
21
# File 'app/models/taxon_name_relationship/original_combination.rb', line 19

def applicable_rank
  self.class.name.demodulize.underscore.humanize.downcase.gsub('original ', '').to_sym
end

- (Hash) combination_name

Returns the elements of the original combination name for this instance TODO: reconcile this with <>_name_elements for other combinations. TODO: reconcile this format with that of full_name_hash

Returns:

  • (Hash)

    the elements of the original combination name for this instance TODO: reconcile this with <>_name_elements for other combinations. TODO: reconcile this format with that of full_name_hash



62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'app/models/taxon_name_relationship/original_combination.rb', line 62

def combination_name
  elements = [monomial_prefix]
  if !subject_taxon_name.verbatim_name.blank? # subject_taxon_name ?! TODO ?! - provide verbatim test
    elements.push subject_taxon_name.verbatim_name 
  else
    elements.push subject_taxon_name.genderized_name(element_gender)
  end

  elements.push('[sic]') if subject_taxon_name.cached_misspelling
  elements[1] = "(#{elements[1]})" if applicable_rank == :subgenus

  return {applicable_rank => elements}
end

- (Object) element_gender



76
77
78
# File 'app/models/taxon_name_relationship/original_combination.rb', line 76

def element_gender
  subject_taxon_name.gender_name
end

- (String?) monomial_prefix

Returns String should be included in Protonym

Returns:

  • (String, nil)
    String should be included in Protonym


54
55
56
# File 'app/models/taxon_name_relationship/original_combination.rb', line 54

def monomial_prefix
  nil
end

- (Object) object_status

Returns String the status inferred by the relationship to the object name

Returns:

  • String the status inferred by the relationship to the object name



44
45
46
# File 'app/models/taxon_name_relationship/original_combination.rb', line 44

def object_status
  'in original combination with ' +  self.type_name.demodulize.underscore.humanize.downcase
end

- (Object) object_status_connector_to_subject



28
29
30
# File 'app/models/taxon_name_relationship/original_combination.rb', line 28

def object_status_connector_to_subject
  ' with'
end

- (Object) set_cached_original_combination (protected)



82
83
84
# File 'app/models/taxon_name_relationship/original_combination.rb', line 82

def set_cached_original_combination
  self.object_taxon_name.update_cached_original_combinations
end

- (Object) subject_status

Returns String the status inferred by the relationship to the subject name

Returns:

  • String the status inferred by the relationship to the subject name



34
35
36
# File 'app/models/taxon_name_relationship/original_combination.rb', line 34

def subject_status
  'as ' +  self.type_name.demodulize.underscore.humanize.downcase
end

- (Object) subject_status_connector_to_object



38
39
40
# File 'app/models/taxon_name_relationship/original_combination.rb', line 38

def subject_status_connector_to_object
  ' of'
end