Class: Traject::Indexer::Context
- Inherits:
-
Object
- Object
- Traject::Indexer::Context
- Defined in:
- lib/traject/indexer.rb
Overview
Represents the context of a specific record being indexed, passed to indexing logic blocks
Instance Attribute Summary collapse
-
#clipboard ⇒ Object
Returns the value of attribute clipboard.
-
#index_step ⇒ Object
Returns the value of attribute index_step.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#output_hash ⇒ Object
Returns the value of attribute output_hash.
-
#position ⇒ Object
1-based position in stream of processed records.
-
#settings ⇒ Object
Returns the value of attribute settings.
-
#skipmessage ⇒ Object
Should we be skipping this record?.
-
#source_record ⇒ Object
Returns the value of attribute source_record.
Instance Method Summary collapse
-
#initialize(hash_init = {}) ⇒ Context
constructor
A new instance of Context.
-
#skip!(msg = '(no message given)') ⇒ Object
Set the fact that this record should be skipped, with an optional message.
-
#skip? ⇒ Boolean
Should we skip this record?.
Constructor Details
#initialize(hash_init = {}) ⇒ Context
Returns a new instance of Context.
423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/traject/indexer.rb', line 423 def initialize(hash_init = {}) # TODO, argument checking for required args? self.clipboard = {} self.output_hash = {} hash_init.each_pair do |key, value| self.send("#{key}=", value) end @skip = false end |
Instance Attribute Details
#clipboard ⇒ Object
Returns the value of attribute clipboard.
436 437 438 |
# File 'lib/traject/indexer.rb', line 436 def clipboard @clipboard end |
#index_step ⇒ Object
Returns the value of attribute index_step.
437 438 439 |
# File 'lib/traject/indexer.rb', line 437 def index_step @index_step end |
#logger ⇒ Object
Returns the value of attribute logger.
436 437 438 |
# File 'lib/traject/indexer.rb', line 436 def logger @logger end |
#output_hash ⇒ Object
Returns the value of attribute output_hash.
436 437 438 |
# File 'lib/traject/indexer.rb', line 436 def output_hash @output_hash end |
#position ⇒ Object
1-based position in stream of processed records.
439 440 441 |
# File 'lib/traject/indexer.rb', line 439 def position @position end |
#settings ⇒ Object
Returns the value of attribute settings.
437 438 439 |
# File 'lib/traject/indexer.rb', line 437 def settings @settings end |
#skipmessage ⇒ Object
Should we be skipping this record?
442 443 444 |
# File 'lib/traject/indexer.rb', line 442 def @skipmessage end |
#source_record ⇒ Object
Returns the value of attribute source_record.
437 438 439 |
# File 'lib/traject/indexer.rb', line 437 def source_record @source_record end |
Instance Method Details
#skip!(msg = '(no message given)') ⇒ Object
Set the fact that this record should be skipped, with an optional message
446 447 448 449 |
# File 'lib/traject/indexer.rb', line 446 def skip!(msg = '(no message given)') @skipmessage = msg @skip = true end |
#skip? ⇒ Boolean
Should we skip this record?
452 453 454 |
# File 'lib/traject/indexer.rb', line 452 def skip? @skip end |