Module: BEL::Extension::Format::Formatter
- Included in:
- FormatBEL, FormatJGF, FormatJSON, FormatRDF, FormatXBEL
- Defined in:
- lib/bel/extension_format.rb
Overview
The Formatter module defines methods to be implemented by a format extension Class
. It is broken up into three parts:
-
Metadata
-
#id: the runtime-wide unique extension id
-
#media_types: the media types this format supports
-
#file_extensions: the file extensions this format supports
-
-
Deserialize
-
#deserialize: read the implemented document format and return Model::Evidence objects
-
-
Serialize
-
#serialize: write Model::Evidence objects to the implemented document format
-
Instance Method Summary collapse
- #deserialize(data) ⇒ Object
- #evidence_hash(object) ⇒ Object
- #file_extensions ⇒ Object
- #id ⇒ Object
- #media_types ⇒ Object
- #serialize(data, writer = nil) ⇒ Object
Instance Method Details
#deserialize(data) ⇒ Object
186 187 188 |
# File 'lib/bel/extension_format.rb', line 186 def deserialize(data) raise NotImplementedError.new("#{__method__} is not implemented.") end |
#evidence_hash(object) ⇒ Object
182 183 184 |
# File 'lib/bel/extension_format.rb', line 182 def evidence_hash(object) raise NotImplementedError.new("#{__method__} is not implemented.") end |
#file_extensions ⇒ Object
177 178 179 180 |
# File 'lib/bel/extension_format.rb', line 177 def file_extensions # optional nil end |
#id ⇒ Object
168 169 170 |
# File 'lib/bel/extension_format.rb', line 168 def id raise NotImplementedError.new("#{__method__} is not implemented.") end |
#media_types ⇒ Object
172 173 174 175 |
# File 'lib/bel/extension_format.rb', line 172 def media_types # optional nil end |
#serialize(data, writer = nil) ⇒ Object
190 191 192 |
# File 'lib/bel/extension_format.rb', line 190 def serialize(data, writer = nil) raise NotImplementedError.new("#{__method__} is not implemented.") end |