Class: Concept::Base

Inherits:
ActiveRecord::Base
  • Object
show all
Includes:
Validations, Iqvoc::Versioning
Defined in:
app/models/concept/base.rb

Overview

Copyright 2011-2013 innoQ Deutschland GmbH

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Direct Known Subclasses

Collection::Base, SKOS::Base, SKOS::Scheme

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Validations

#distinct_versions, #exclusive_top_term, #pref_label_in_primary_thesaurus_language, #rooted_top_terms, #unique_pref_label, #unique_pref_label_language, #valid_rank_for_ranked_relations

Methods included from Iqvoc::Versioning

#branch, #editor_selectable?, #in_review?, #lock_by_user, #locked?, #publish, #published?, #state, #to_review, #unlock, #unpublish

Class Method Details

.broader_tops ⇒ Object 



256
257
258
259
260
261
 
# File 'app/models/concept/base.rb', line 256

def self.broader_tops
  includes(:narrower_relations, :pref_labels).
  where(:concept_relations => { :id => nil },
    :labelings => { :type => Iqvoc::Concept.pref_labeling_class_name }).
  order("LOWER(#{Label::Base.table_name}.value)")
end

.edit_link_partial_name ⇒ Object 



289
290
291
 
# File 'app/models/concept/base.rb', line 289

def self.edit_link_partial_name
  "partials/concept/edit_link_base"
end

.for_dashboard ⇒ Object 



275
276
277
 
# File 'app/models/concept/base.rb', line 275

def self.for_dashboard
  unpublished_or_follow_up.includes(:pref_labels, :locking_user)
end

.inline_partial_name ⇒ Object

********** Class methods



281
282
283
 
# File 'app/models/concept/base.rb', line 281

def self.inline_partial_name
  "partials/concept/inline_base"
end

.new_link_partial_name ⇒ Object 



285
286
287
 
# File 'app/models/concept/base.rb', line 285

def self.new_link_partial_name
  "partials/concept/new_link_base"
end

.tops ⇒ Object

********** Scopes



252
253
254
 
# File 'app/models/concept/base.rb', line 252

def self.tops
  where(:top_term => true)
end

.with_associations ⇒ Object 



263
264
265
266
267
 
# File 'app/models/concept/base.rb', line 263

def self.with_associations
  includes([
    { :labelings => :target }, :relations, :matches, :notes, :notations
  ])
end

.with_pref_labels ⇒ Object 



269
270
271
272
273
 
# File 'app/models/concept/base.rb', line 269

def self.with_pref_labels
  includes(:pref_labels).
  order("LOWER(#{Label::Base.table_name}.value)").
  where(:labelings => { :type => Iqvoc::Concept.pref_labeling_class_name }) # This line is just a workaround for a Rails Bug. TODO: Delete it when the Bug is fixed
end

Instance Method Details

#additional_info ⇒ Object

This shows up (in brackets) to the right of a concept link if it doesn’t return nil



391
392
393
 
# File 'app/models/concept/base.rb', line 391

def additional_info
  nil
end

#associated_objects_in_editing_mode ⇒ Object 



421
422
423
424
425
 
# File 'app/models/concept/base.rb', line 421

def associated_objects_in_editing_mode
  {
    :concept_relations => Concept::Relation::Base.by_owner(id).target_in_edit_mode,
  }
end

#concept_relations_by_id(relation_name) ⇒ Object 



320
321
322
323
324
 
# File 'app/models/concept/base.rb', line 320

def concept_relations_by_id(relation_name)
  (@concept_relations_by_id && @concept_relations_by_id[relation_name]) ||
    self.send(relation_name).map { |l| l.target.origin }.
    join(Iqvoc::InlineDataHelper::JOINER)
end

#concept_relations_by_id=(hash) ⇒ Object 



316
317
318
 
# File 'app/models/concept/base.rb', line 316

def concept_relations_by_id=(hash)
  @concept_relations_by_id = hash
end

#concept_relations_by_id_and_rank(relation_name) ⇒ Object 



326
327
328
329
 
# File 'app/models/concept/base.rb', line 326

def concept_relations_by_id_and_rank(relation_name)
  self.send(relation_name).each_with_object({}) { |rel, hsh| hsh[rel.target] = rel.rank }
  # self.send(relation_name).map { |l| "#{l.target.origin}:#{l.rank}" }
end

#invalid_with_full_validation? ⇒ Boolean

TODO: remove

Returns:

  • (Boolean) 


416
417
418
419
 
# File 'app/models/concept/base.rb', line 416

def invalid_with_full_validation?
  @full_validation = true
  invalid?
end

#labelings_by_text(relation_name, language) ⇒ Object 



309
310
311
312
313
314
 
# File 'app/models/concept/base.rb', line 309

def labelings_by_text(relation_name, language)
  (@labelings_by_text && @labelings_by_text[relation_name] &&
      @labelings_by_text[relation_name][language]) ||
      Iqvoc::InlineDataHelper.generate_inline_values(self.send(relation_name).
          by_label_language(language).map { |l| l.target.value })
end

#labelings_by_text=(hash) ⇒ Object

********** Methods



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'app/models/concept/base.rb', line 295

def labelings_by_text=(hash)
  @labelings_by_text = hash

  @labelings_by_text.each do |relation_name, labels_by_lang|
    # if `language` is `nil`, the respective HTML form field returns an array
    # instead of a hash (`<input name=bla[labeling_class][]>`)
    if labels_by_lang.is_a?(Array)
      @labelings_by_text[relation_name] = { nil => labels_by_lang.first }
    end
  end

  @labelings_by_text
end

#labels_for_labeling_class_and_language(labeling_class, lang = :en, only_published = true) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'app/models/concept/base.rb', line 353

def labels_for_labeling_class_and_language(labeling_class, lang = :en, only_published = true)
  # Convert lang to string in case it's not nil.
  # nil values play their own role for labels without a language.
  if lang == "none"
    lang = nil
  elsif lang
    lang = lang.to_s
  end
  labeling_class = labeling_class.name if labeling_class < ActiveRecord::Base # Use the class name string
  @labels ||= labelings.each_with_object({}) do |labeling, hash|
    ((hash[labeling.class.name.to_s] ||= {})[labeling.target.language] ||= []) << labeling.target if labeling.target
  end
  ((@labels && @labels[labeling_class] && @labels[labeling_class][lang]) || []).select{|l| l.published? || !only_published}
end

#matches_for_class(match_class) ⇒ Object 



374
375
376
377
 
# File 'app/models/concept/base.rb', line 374

def matches_for_class(match_class)
  match_class = match_class.name if match_class < ActiveRecord::Base # Use the class name string
  matches.select{ |match| match.class.name == match_class }
end

#notations_for_class(notation_class) ⇒ Object 



384
385
386
387
 
# File 'app/models/concept/base.rb', line 384

def notations_for_class(notation_class)
  notation_class = notation_class.name if notation_class < ActiveRecord::Base # Use the class name string
  notations.select{ |notation| notation.class.name == notation_class }
end

#notes_for_class(note_class) ⇒ Object 



379
380
381
382
 
# File 'app/models/concept/base.rb', line 379

def notes_for_class(note_class)
  note_class = note_class.name if note_class < ActiveRecord::Base # Use the class name string
  notes.select{ |note| note.class.name == note_class }
end

#pref_label ⇒ Object

returns the (one!) preferred label of a concept for the requested language. lang can either be a (lowercase) string or symbol with the (ISO .…) two letter code of the language (e.g. :en for English, :fr for French, :de for German). If no prefLabel for the requested language exists, a new label will be returned (if you modify it, don’t forget to save it afterwards!)



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'app/models/concept/base.rb', line 336

def pref_label
  lang = I18n.locale.to_s == "none" ? nil : I18n.locale.to_s
  @cached_pref_labels ||= pref_labels.each_with_object({}) do |label, hash|
    if hash[label.language]
      Rails.logger.warn("Two pref_labels (#{hash[label.language]}, #{label}) for one language (#{label.language}). Taking the second one.")
    end
    hash[label.language] = label
  end
  if @cached_pref_labels[lang].nil?
    # Fallback to the main language
    @cached_pref_labels[lang] = pref_labels.select{ |l|
        l.language.to_s == Iqvoc::Concept.pref_labeling_languages.first.to_s
    }.first
  end
  @cached_pref_labels[lang]
end

#related_concepts_for_relation_class(relation_class, only_published = true) ⇒ Object 



368
369
370
371
372
 
# File 'app/models/concept/base.rb', line 368

def related_concepts_for_relation_class(relation_class, only_published = true)
  relation_class = relation_class.name if relation_class < ActiveRecord::Base # Use the class name string
  relations.select { |rel| rel.class.name == relation_class }.map(&:target).
      select { |c| c.published? || !only_published }
end

#save_with_full_validation! ⇒ Object

TODO: rename to “publish!”



404
405
406
407
 
# File 'app/models/concept/base.rb', line 404

def save_with_full_validation!
  @full_validation = true
  save!
end

#to_param ⇒ Object 



395
396
397
 
# File 'app/models/concept/base.rb', line 395

def to_param
  "#{origin}"
end

#to_s ⇒ Object 



399
400
401
 
# File 'app/models/concept/base.rb', line 399

def to_s
  pref_label.to_s
end

#valid_with_full_validation? ⇒ Boolean

TODO: rename to “publishable?”

Returns:

  • (Boolean) 


410
411
412
413
 
# File 'app/models/concept/base.rb', line 410

def valid_with_full_validation?
  @full_validation = true
  valid?
end