Class: ROF::Filter

Inherits:

Object

• Object
• ROF::Filter

Defined in:

lib/rof/filter.rb

Overview

A placeholder implementation for an ROF::Filter.

See Also:

• Filters

Direct Known Subclasses

ROF::Filters::AccessToRelsext, ROF::Filters::Bendo, ROF::Filters::DateStamp, ROF::Filters::FileToUrl, ROF::Filters::Label, ROF::Filters::Work

Instance Method Summary

• #initialize(options = {}) ⇒ Filter constructor

  A new instance of Filter.

• #process(obj_list) ⇒ Array<Hash>

  Performs operations on the given obj_list.

Constructor Details

#initialize(options = {}) ⇒ Filter

Returns a new instance of Filter.

Parameters:

• options (Hash) (defaults to: {}) —

  • a hash with symbol keys; used to configure the instantiation of the filter

# File 'lib/rof/filter.rb', line 6

def initialize(options = {})
end

Instance Method Details

#process(obj_list) ⇒ Array<Hash>

Performs operations on the given obj_list. This can be things like:

• Adding new keys to the inner Hash

• Converting placeholder values with calculated values (@see ROF::Filters::Label)

• Other changes

Parameters:

• obj_list (Array<Hash>) —

  • An Array of Hash objects

Returns:

• (Array<Hash>) —

  a changed version of the given

Raises:

• (NotImplementedError)

# File 'lib/rof/filter.rb', line 17

def process(obj_list)
  raise NotImplementedError
end