Class: Ecfr::SearchService::ContentVersion::HierarchicalCountNode

Inherits:
Object
  • Object
show all
Extended by:
Extensible
Includes:
AttributeMethodDefinition
Defined in:
lib/ecfr/search_service/content_version/hierarchical_count_node.rb

Instance Attribute Summary collapse

Method Summary

Methods included from Extensible

inherited

Methods included from AttributeMethodDefinition

included, #initialize

Instance Attribute Details

#children ⇒ [HierarchicalCountNode] (readonly)

An array of counts data for the next level down in the hierarchy

Returns:



24
25
26
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 24

attribute :children,
type: Array(HierarchicalCountNode),
desc: "An array of counts data for the next level down in the hierarchy"

#count ⇒ Integer (readonly)

number of results this hierarchy level contains

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 17

attribute :count,
type: :integer,
desc: "number of results this hierarchy level contains"

#heading ⇒ String (readonly)

the descriptive portion of the CFR level

Returns:

  • (String) 


8
9
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 8

attribute :heading,
desc: "the descriptive portion of the CFR level"

#hierarchy ⇒ String (readonly)

the shortened identifier portion of the CFR level

Returns:

  • (String) 


10
11
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 10

attribute :hierarchy,
desc: "the shortened identifier portion of the CFR level"

#hierarchy_heading ⇒ String (readonly)

the full identifier portion of the CFR level

Returns:

  • (String) 


12
13
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 12

attribute :hierarchy_heading,
desc: "the full identifier portion of the CFR level"

#level ⇒ String (readonly)

current hierarchy level

Returns:

  • (String) 


14
15
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 14

attribute :level,
desc: "current hierarchy level"

#max_score ⇒ Integer (readonly)

the max score of any result this hierarchy level contains

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/ecfr/search_service/content_version/hierarchical_count_node.rb', line 20

attribute :max_score,
type: :integer,
desc: "the max score of any result this hierarchy level contains"