Class: Sequel::Model::Associations::ManyToOneAssociationReflection

Inherits:
AssociationReflection show all
Defined in:
lib/sequel/model/associations.rb

Constant Summary

Constants included from Inflections

Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP

Instance Method Summary collapse

Methods inherited from AssociationReflection

#_add_method, #_remove_all_method, #_remove_method, #_setter_method, #add_method, #apply_dataset_changes, #associated_class, #associated_dataset, #association_method, #dataset_method, #eager_loader_key, #eager_loading_predicate_key, #eager_loading_use_associated_key?, #filter_by_associations_add_conditions?, #filter_by_associations_conditions_expression, #handle_silent_modification_failure?, #limit_and_offset, #need_associated_primary_key?, #predicate_keys, #qualify, #qualify_assoc, #qualify_cur, #reciprocal, #remove_all_method, #remove_before_destroy?, #remove_method, #remove_should_check_existing?, #select, #setter_method, #slice_range

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

#&, #case, #hstore, #pg_json, #sql_expr, #sql_negate, #sql_or, #|, #~

Instance Method Details

#can_have_associated_objects?(obj) ⇒ Boolean

many_to_one associations can only have associated objects if none of the :keys options have a nil value.

Returns:

  • (Boolean) 


370
371
372
 
# File 'lib/sequel/model/associations.rb', line 370

def can_have_associated_objects?(obj)
  !self[:keys].any?{|k| obj.send(k).nil?}
end

#dataset_need_primary_key? ⇒ Boolean

Whether the dataset needs a primary key to function, false for many_to_one associations.

Returns:

  • (Boolean) 


375
376
377
 
# File 'lib/sequel/model/associations.rb', line 375

def dataset_need_primary_key?
  false
end

#default_key ⇒ Object

Default foreign key name symbol for foreign key in current model’s table that points to the given association’s table’s primary key.



381
382
383
 
# File 'lib/sequel/model/associations.rb', line 381

def default_key
  :"#{self[:name]}_id"
end

#eager_graph_lazy_dataset? ⇒ Boolean

Whether to eagerly graph a lazy dataset, true for many_to_one associations only if the key is nil.

Returns:

  • (Boolean) 


387
388
389
 
# File 'lib/sequel/model/associations.rb', line 387

def eager_graph_lazy_dataset?
  self[:key].nil?
end

#eager_limit_strategy ⇒ Object

many_to_one associations don’t need an eager limit strategy



392
393
394
 
# File 'lib/sequel/model/associations.rb', line 392

def eager_limit_strategy
  nil
end

#predicate_key ⇒ Object

The expression to use on the left hand side of the IN lookup when eager loading



397
398
399
 
# File 'lib/sequel/model/associations.rb', line 397

def predicate_key
  cached_fetch(:predicate_key){qualified_primary_key}
end

#primary_key ⇒ Object

The column(s) in the associated table that the key in the current table references (either a symbol or an array).



402
403
404
 
# File 'lib/sequel/model/associations.rb', line 402

def primary_key
 cached_fetch(:primary_key){associated_class.primary_key}
end

#primary_key_method ⇒ Object

The method symbol or array of method symbols to call on the associated object to get the value to use for the foreign keys.



414
415
416
 
# File 'lib/sequel/model/associations.rb', line 414

def primary_key_method
 cached_fetch(:primary_key_method){primary_key}
end

#primary_key_methods ⇒ Object

The array of method symbols to call on the associated object to get the value to use for the foreign keys.



420
421
422
 
# File 'lib/sequel/model/associations.rb', line 420

def primary_key_methods
 cached_fetch(:primary_key_methods){Array(primary_key_method)}
end

#primary_keys ⇒ Object Also known as: associated_object_keys

The columns in the associated table that the key in the current table references (always an array).



407
408
409
 
# File 'lib/sequel/model/associations.rb', line 407

def primary_keys
 cached_fetch(:primary_keys){Array(primary_key)}
end

#qualified_primary_key ⇒ Object

#primary_key qualified by the associated table



425
426
427
 
# File 'lib/sequel/model/associations.rb', line 425

def qualified_primary_key
  cached_fetch(:qualified_primary_key){self[:qualify] == false ? primary_key : qualify_assoc(primary_key)}
end

#reciprocal_array? ⇒ Boolean

True only if the reciprocal is a one_to_many association.

Returns:

  • (Boolean) 


430
431
432
 
# File 'lib/sequel/model/associations.rb', line 430

def reciprocal_array?
  !set_reciprocal_to_self?
end

#returns_array? ⇒ Boolean

Whether this association returns an array of objects instead of a single object, false for a many_to_one association.

Returns:

  • (Boolean) 


436
437
438
 
# File 'lib/sequel/model/associations.rb', line 436

def returns_array?
  false
end

#set_reciprocal_to_self? ⇒ Boolean

True only if the reciprocal is a one_to_one association.

Returns:

  • (Boolean) 


441
442
443
444
 
# File 'lib/sequel/model/associations.rb', line 441

def set_reciprocal_to_self?
  reciprocal
  reciprocal_type == :one_to_one
end