Class: Ecfr::VersionerService::Ancestors::NodeSummary

Inherits:
Object
  • Object
show all
Extended by:
Extensible
Includes:
AttributeMethodDefinition
Defined in:
lib/ecfr/versioner_service/ancestors/node_summary.rb

Overview

This class provides a summary of important data for the level in the hierarchy that it represents.

Some levels of the hierarchy (generally subject groups) use generated identifiers because they are not designated potions of the CFR hierarchy and thus are not completely stable over time.

Instance Attribute Summary collapse

Method Summary

Methods included from Extensible

inherited

Methods included from AttributeMethodDefinition

included, #initialize

Instance Attribute Details

#descendant_range ⇒ String (readonly)

the range of sections that are descendents of this level

Returns:

  • (String) 


17
18
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 17

attribute :descendant_range,
desc: "the range of sections that are descendents of this level"

#generated_id ⇒ Boolean (readonly)

whether the identifier was generated

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 33

attribute :generated_id,
type: :boolean,
desc: "whether the identifier was generated"

#hierarchy ⇒ Ecfr::Common::Hierarchy (readonly)

the hierarchy for this node

Returns:



48
49
50
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 48

attribute :hierarchy,
type: Ecfr::Common::Hierarchy,
desc: "the hierarchy for this node"

#identifier ⇒ String (readonly)

the shortened identifier portion of the CFR level

Returns:

  • (String) 


19
20
21
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 19

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

#label ⇒ String (readonly)

the full description of the CFR level

Returns:

  • (String) 


22
23
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 22

attribute :label,
desc: "the full description of the CFR level"

#label_description ⇒ String (readonly)

the descriptive portion of the CFR level

Returns:

  • (String) 


26
27
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 26

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

#label_level ⇒ String (readonly)

the full identifier portion of the CFR level

Returns:

  • (String) 


24
25
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 24

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

#reserved ⇒ Boolean (readonly)

whether this level represents a portion of the CFR that is Reserved

Returns:

  • (Boolean) 


36
37
38
39
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 36

attribute :reserved,
          type: :boolean,
          desc: "whether this level represents a portion of
the CFR that is Reserved"

#type ⇒ String (readonly)

the type of CFR level - the value will be a stringified version of the attribute keys in Common::Hierarchy

Returns:

  • (String) 


28
29
30
31
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 28

attribute :type,
          desc: "the type of CFR level - the value will be a
stringified version of the attribute keys in
{Ecfr::Common::Hierarchy}"

#volumes ⇒ [:string] (readonly)

the Volumes this level of the hierarchy was present within in the print edition - only appears on Part levels and below

Returns:

  • ([:string]) 


41
42
43
44
 
# File 'lib/ecfr/versioner_service/ancestors/node_summary.rb', line 41

attribute :volumes,
          type: Array(:string),
          desc: "the Volumes this level of the hierarchy was present
within in the print edition - only appears on Part levels and below"