Module: Curate::Indexer::Adapters::AbstractAdapter

Included in:
InMemoryAdapter
Defined in:
lib/curate/indexer/adapters/abstract_adapter.rb

Overview

A module that defines the interface of methods required to interact with Curate::Indexer operations

Class Method Summary collapse

Class Method Details

.each_child_document_of { ... } ⇒ Object

Parameters:

Yields:

  • Curate::Indexer::Documents::IndexDocument

Raises:

  • (NotImplementedError) 


30
31
32
 
# File 'lib/curate/indexer/adapters/abstract_adapter.rb', line 30

def self.each_child_document_of(*, &_block)
  raise NotImplementedError
end

.each_preservation_document { ... } ⇒ Object

Yields:

  • Curate::Indexer::Document::PreservationDocument

Raises:

  • (NotImplementedError) 


23
24
25
 
# File 'lib/curate/indexer/adapters/abstract_adapter.rb', line 23

def self.each_preservation_document
  raise NotImplementedError
end

.find_index_document_by ⇒ Object

Returns Curate::Indexer::Documents::IndexDocument.

Parameters:

  • pid (String)

Returns:

  • Curate::Indexer::Documents::IndexDocument

Raises:

  • (NotImplementedError) 


17
18
19
 
# File 'lib/curate/indexer/adapters/abstract_adapter.rb', line 17

def self.find_index_document_by(*)
  raise NotImplementedError
end

.find_preservation_document_by ⇒ Object

Returns Curate::Indexer::Document::PreservationDocument.

Parameters:

  • pid (String)

Returns:

  • Curate::Indexer::Document::PreservationDocument

Raises:

  • (NotImplementedError) 


10
11
12
 
# File 'lib/curate/indexer/adapters/abstract_adapter.rb', line 10

def self.find_preservation_document_by(*)
  raise NotImplementedError
end

.write_document_attributes_to_index_layer ⇒ Object

Returns Curate::Indexer::Documents::IndexDocument.

Returns:

  • Curate::Indexer::Documents::IndexDocument

Raises:

  • (NotImplementedError) 


36
37
38
 
# File 'lib/curate/indexer/adapters/abstract_adapter.rb', line 36

def self.write_document_attributes_to_index_layer(*)
  raise NotImplementedError
end