Class: JSONAPI::ResourceIdTree

Inherits:

Object

• Object
• JSONAPI::ResourceIdTree

Defined in:

lib/jsonapi/resource_id_tree.rb

Overview

A tree structure representing the resource structure of the requested resource(s). This is an intermediate structure used to keep track of the resources, by identity, found at different included relationships. It will be flattened and the resource instances will be fetched from the cache or the record store.

Direct Known Subclasses

PrimaryResourceIdTree, RelatedResourceIdTree

Instance Attribute Summary

• #fragments ⇒ Object readonly

  Returns the value of attribute fragments.

• #related_resource_id_trees ⇒ Object readonly

  Returns the value of attribute related_resource_id_trees.

Instance Method Summary

• #fetch_related_resource_id_tree(relationship) ⇒ JSONAPI::RelatedResourceIdTree

  Gets the related Resource Id Tree for a relationship, and creates it first if it does not exist.

Instance Attribute Details

#fragments ⇒ Object (readonly)

Returns the value of attribute fragments.

# File 'lib/jsonapi/resource_id_tree.rb', line 8

def fragments
  @fragments
end

#related_resource_id_trees ⇒ Object (readonly)

Returns the value of attribute related_resource_id_trees.

# File 'lib/jsonapi/resource_id_tree.rb', line 8

def related_resource_id_trees
  @related_resource_id_trees
end

Instance Method Details

#fetch_related_resource_id_tree(relationship) ⇒ JSONAPI::RelatedResourceIdTree

Gets the related Resource Id Tree for a relationship, and creates it first if it does not exist

Parameters:

• relationship (JSONAPI::Relationship)

Returns:

• (JSONAPI::RelatedResourceIdTree) —

  the new or existing resource id tree for the requested relationship

# File 'lib/jsonapi/resource_id_tree.rb', line 15

def fetch_related_resource_id_tree(relationship)
  relationship_name = relationship.name.to_sym
  @related_resource_id_trees[relationship_name] ||= RelatedResourceIdTree.new(relationship, self)
end