Class: BioInterchange::Model

Inherits:

Object

• Object
• BioInterchange::Model

Defined in:

lib/biointerchange/model.rb

Overview

Instances of this class represent an object model that is populated by a Reader and serialized by a Writer. The model does not have to be read completely into memory (see GFF3/GVF implementation as an example).

Direct Known Subclasses

Genomics::GFF3FeatureSet, Phylogenetics::TreeSet, TextMining::Document

Instance Method Summary

• #initialize ⇒ Model constructor

  Create a new instance of an object model.

• #prune ⇒ Object

  For readers that support batch processing, pruning removes all data from the model that has been serialized already.

Constructor Details

#initialize ⇒ Model

Create a new instance of an object model. Your concrete object model make take some extra parameters for configuring/parametrizing the model’s behaviour.

# File 'lib/biointerchange/model.rb', line 10

def initialize
end

Instance Method Details

#prune ⇒ Object

For readers that support batch processing, pruning removes all data from the model that has been serialized already. This prevents memory issues when the input data is very large.

Raises:

• (BioInterchange::Exceptions::ImplementationModelError)

# File 'lib/biointerchange/model.rb', line 15

def prune
  raise BioInterchange::Exceptions::ImplementationModelError, 'Pruning is not implemented by this model'
end