class Ashikawa::Core::Figure
Wrapper around figures of a collection
Public Class Methods
Create a wrapper around given figures
@param [Hash] raw_figure @api public @example Create a new figure from a raw figure
figure = Ashikawa::Core::Figure.new(raw_figure)
# File lib/ashikawa-core/figure.rb, line 11 def initialize(raw_figure) @datafiles = raw_figure['datafiles'] @alive = raw_figure['alive'] @dead = raw_figure['dead'] @shapes = raw_figure['shapes'] @journals = raw_figure['journals'] @attributes = raw_figure['attributes'] end
Public Instance Methods
The number of living documents
@return Fixnum @api public @example Get the number of living documents
figure = Ashikawa::Core::Figure.new(raw_figure) figure.alive_count #=> 1337
# File lib/ashikawa-core/figure.rb, line 60 def alive_count @alive['count'] end
The total size in bytes used by all living documents
@return Fixnum @api public @example Get the size of all living documents in bytes
figure = Ashikawa::Core::Figure.new(raw_figure) figure.alive_size #=> 1337
# File lib/ashikawa-core/figure.rb, line 49 def alive_size @alive['size'] end
Number of different attributes that are or have been used in the collection
@return Fixnum @api public @example Get the number of attributes
figure = Ashikawa::Core::Figure.new(raw_figure) figure.attributes_count #=> 12
# File lib/ashikawa-core/figure.rb, line 137 def attributes_count @attributes['count'] end
The number of active datafiles
@return Fixnum @api public @example Get the number of datafiles
figure = Ashikawa::Core::Figure.new(raw_figure) figure.datafiles_count #=> 1337
# File lib/ashikawa-core/figure.rb, line 27 def datafiles_count @datafiles['count'] end
The file size of datafiles
@return Fixnum @api public @example Get the file size of datafiles
figure = Ashikawa::Core::Figure.new(raw_figure) figure.datafile_size #=> 1337
# File lib/ashikawa-core/figure.rb, line 38 def datafiles_file_size @datafiles['fileSize'] end
The number of dead documents
@return Fixnum @api public @example Get the number of dead documents
figure = Ashikawa::Core::Figure.new(raw_figure) figure.dead_count #=> 1337
# File lib/ashikawa-core/figure.rb, line 82 def dead_count @dead['count'] end
The number of deletion markers
@return Fixnum @api public @example Get the number of deletion markers
figure = Ashikawa::Core::Figure.new(raw_figure) figure.dead_deletion #=> 1337
# File lib/ashikawa-core/figure.rb, line 104 def dead_deletion @dead['deletion'] end
The total size in bytes used by all dead documents
@return Fixnum @api public @example Get the size of all dead documents in bytes
figure = Ashikawa::Core::Figure.new(raw_figure) figure.dead_size #=> 1337
# File lib/ashikawa-core/figure.rb, line 71 def dead_size @dead['size'] end
The number of journals
@return Fixnum @api public @example Get the number of journals
figure = Ashikawa::Core::Figure.new(raw_figure) figure.journal_count #=> 1337
# File lib/ashikawa-core/figure.rb, line 115 def journals_count @journals['count'] end
The file size of journals
@return Fixnum @api public @example Get the file size of journals
figure = Ashikawa::Core::Figure.new(raw_figure) figure.journal_size #=> 1337
# File lib/ashikawa-core/figure.rb, line 126 def journals_file_size @journals['fileSize'] end
The total number of shapes used in the collection
@return Fixnum @api public @example Get the number of shapes
figure = Ashikawa::Core::Figure.new(raw_figure) figure.shapes_count #=> 1337
# File lib/ashikawa-core/figure.rb, line 93 def shapes_count @shapes['count'] end