Class: Embulk::FilterPlugin

Inherits:
Object
  • Object
show all
Defined in:
lib/embulk/filter_plugin.rb

Direct Known Subclasses

Plugin::FilterExample

Defined Under Namespace

Classes: JavaAdapter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(task, in_schema, out_schema, page_builder) ⇒ FilterPlugin

Returns a new instance of FilterPlugin.



9
10
11
12
13
14
# File 'lib/embulk/filter_plugin.rb', line 9

def initialize(task, in_schema, out_schema, page_builder)
  @task = task
  @in_schema = in_schema
  @out_schema = out_schema
  @page_builder = page_builder
end

Instance Attribute Details

#in_schema ⇒ Object (readonly)

Returns the value of attribute in_schema.



16
17
18
# File 'lib/embulk/filter_plugin.rb', line 16

def in_schema
  @in_schema
end

#out_schema ⇒ Object (readonly)

Returns the value of attribute out_schema.



16
17
18
# File 'lib/embulk/filter_plugin.rb', line 16

def out_schema
  @out_schema
end

#page_builder ⇒ Object (readonly)

Returns the value of attribute page_builder.



16
17
18
# File 'lib/embulk/filter_plugin.rb', line 16

def page_builder
  @page_builder
end

#task ⇒ Object (readonly)

Returns the value of attribute task.



16
17
18
# File 'lib/embulk/filter_plugin.rb', line 16

def task
  @task
end

Class Method Details

.java_object ⇒ Object



29
30
31
# File 'lib/embulk/filter_plugin.rb', line 29

def self.java_object
  JavaAdapter.new(self)
end

.transaction(config, in_schema) {|config| ... } ⇒ Object

Yields:

  • (config)


4
5
6
7
# File 'lib/embulk/filter_plugin.rb', line 4

def self.transaction(config, in_schema, &control)
  yield(config)
  return {}
end

Instance Method Details

#add(page) ⇒ Object

Raises:

  • (NotImplementedError)


18
19
20
# File 'lib/embulk/filter_plugin.rb', line 18

def add(page)
  raise NotImplementedError, "FilterPlugin#add(page) must be implemented"
end

#close ⇒ Object



25
26
# File 'lib/embulk/filter_plugin.rb', line 25

def close
end

#finish ⇒ Object



22
23
# File 'lib/embulk/filter_plugin.rb', line 22

def finish
end