Contents

# encoding: UTF-8

require_relative '../metadata'
require_relative '../../core/rest'
require_relative 'metadata'

module GoodData
  class Fact < GoodData::MdObject
    root_key :fact

    # TODO: verify that we have all (which we do not right now)
    FACT_BASE_AGGREGATIONS = [:sum, :min, :max, :avg, :median]

    class << self
      # Method intended to get all objects of that type in a specified project
      #
      # @param options [Hash] the options hash
      # @option options [Boolean] :full if passed true the subclass can decide to pull in full objects. This is desirable from the usability POV but unfortunately has negative impact on performance so it is not the default
      # @return [Array<GoodData::MdObject> | Array<Hash>] Return the appropriate metadata objects or their representation
      def all(options = {})
        query('facts', Fact, options)
      end
    end

    # Returns true if the object is a fact false otherwise
    # @return [Boolean]
    def fact?
      true
    end

    # Creates the basic count metric with the fact used. The metric created is not saved.
    # @param [Hash] options the options to pass to the value list
    # @option options [Symbol] :type type of aggregation function. Default is :sum
    # @return [GoodData::Metric]
    def create_metric(options = {})
      a_type = options[:type] || :sum
      fail "Suggested aggreagtion function (#{a_type}) does not exist for base metric created out of fact. You can use only one of #{FACT_BASE_AGGREGATIONS.map { |x| ":" + x.to_s }.join(',')}" unless FACT_BASE_AGGREGATIONS.include?(a_type)
      a_title = options[:title] || "#{a_type} of #{title}"
      Metric.xcreate(:expression => "SELECT #{a_type.to_s.upcase}(![#{identifier}])", :title => a_title)
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
gooddata-0.6.4	lib/gooddata/models/metadata/fact.rb