Class: Mongoid::Relations::Builder

Inherits:

Object

• Object
• Mongoid::Relations::Builder

Defined in:

lib/mongoid/relations/builder.rb

Overview

Superclass for all builder objects. Builders are responsible for either looking up a relation’s target from the database, or creating them from a supplied attributes hash.

Direct Known Subclasses

Mongoid::Relations::Builders::Embedded::In, Mongoid::Relations::Builders::Embedded::Many, Mongoid::Relations::Builders::Embedded::One, Mongoid::Relations::Builders::Referenced::In, Mongoid::Relations::Builders::Referenced::Many, Mongoid::Relations::Builders::Referenced::ManyToMany, Mongoid::Relations::Builders::Referenced::One

Instance Attribute Summary

• #loading ⇒ Object readonly

  Returns the value of attribute loading.

• #metadata ⇒ Object readonly

  Returns the value of attribute metadata.

• #object ⇒ Object readonly

  Returns the value of attribute object.

Instance Method Summary

• #initialize(metadata, object, loading = false) ⇒ Builder constructor

  Instantiate the new builder for a relation.

Constructor Details

#initialize(metadata, object, loading = false) ⇒ Builder

Instantiate the new builder for a relation.

Examples:

Create the builder.

Builder.new(metadata, { :field => "value })

Parameters:

• metadata (Metdata) —

  The metadata for the relation.

• object (Hash, BSON::ObjectId) —

  The attributes to build from or id to query with.

Since:

• 2.0.0.rc.1

# File 'lib/mongoid/relations/builder.rb', line 22

def initialize(metadata, object, loading = false)
  @metadata, @object = metadata, object
  @loading = loading
end

Instance Attribute Details

#loading ⇒ Object (readonly)

Returns the value of attribute loading.

# File 'lib/mongoid/relations/builder.rb', line 10

def loading
  @loading
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.

# File 'lib/mongoid/relations/builder.rb', line 10

def metadata
  @metadata
end

#object ⇒ Object (readonly)

Returns the value of attribute object.

# File 'lib/mongoid/relations/builder.rb', line 10

def object
  @object
end