Class: DoubleEntry::Reporting::AggregateArray Private

Inherits:
Array
  • Object
show all
Defined in:
lib/double_entry/reporting/aggregate_array.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(function, account, code, options) ⇒ AggregateArray

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AggregateArray.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/double_entry/reporting/aggregate_array.rb', line 14

def initialize(function, , code, options)
  @function = function.to_s
  @account = 
  @code = code
  @filter = options[:filter]
  @range_type = options[:range_type]
  @start = options[:start]
  @finish = options[:finish]
  @currency = DoubleEntry::Account.currency()

  retrieve_aggregates
  fill_in_missing_aggregates
  populate_self
end

Instance Attribute Details

#accountObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def 
  @account
end

#codeObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def code
  @code
end

#currencyObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def currency
  @currency
end

#filterObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def filter
  @filter
end

#finishObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def finish
  @finish
end

#functionObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def function
  @function
end

#range_typeObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def range_type
  @range_type
end

#startObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An AggregateArray is awesome It is useful for making reports It is basically an array of aggregate results, representing a column of data in a report.

For example, you could request all sales broken down by month and it would return an array of values



12
13
14
# File 'lib/double_entry/reporting/aggregate_array.rb', line 12

def start
  @start
end