Class: FederalRegister::Facet

Inherits:

Base

• Object
• Client
• Base
• FederalRegister::Facet

Extended by:

Utilities

Defined in:

lib/federal_register/facet.rb

Direct Known Subclasses

Agency, Document, PresidentialDocumentType, PublicInspectionDocument, Topic

Defined Under Namespace

Classes: Agency, Document, PresidentialDocumentType, PublicInspectionDocument, PublicInspectionIssue, Topic

Constant Summary

Constants inherited from Base

Base::INTEGER_CLASS

Instance Attribute Summary

• #result_set ⇒ Object readonly

  Returns the value of attribute result_set.

Attributes inherited from Base

#attributes

Class Method Summary

• .search(args = {}) ⇒ Object

Instance Method Summary

• #initialize(attributes = {}, options = {}) ⇒ Facet constructor

  A new instance of Facet.

Methods inherited from Base

add_attribute, #fetch_full, #full?, override_base_uri

Methods inherited from Client

get

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ Facet

Returns a new instance of Facet.

# File 'lib/federal_register/facet.rb', line 16

def initialize(attributes={}, options={})
  @result_set = options.delete(:result_set)

  super(attributes, options)
end

Instance Attribute Details

#result_set ⇒ Object (readonly)

Returns the value of attribute result_set.

# File 'lib/federal_register/facet.rb', line 4

def result_set
  @result_set
end

Class Method Details

.search(args = {}) ⇒ Object

# File 'lib/federal_register/facet.rb', line 10

def self.search(args={})
  FederalRegister::FacetResultSet.fetch(
    url, :query => args, :result_class => self
  )
end