Class: GoodData::Fact

Inherits:

Includes:: Mixin::IsFact

Defined in:: lib/gooddata/models/metadata/fact.rb

Constant Summary collapse

FACT_BASE_AGGREGATIONS = TODO: verify that we have all (which we do not right now)

[:sum, :min, :max, :avg, :median, :runsum, :runmin, :runmax, :runavg, :runstdev, :runstdevp, :runvar, :runvarp, :stdev, :stdevp, :var, :varp]

Instance Attribute Summary

Attributes inherited from Rest::Object

#client, #json, #project

Class Method Summary collapse

.all(options = { :client => GoodData.connection, :project => GoodData.project }) ⇒ Array<GoodData::MdObject> | Array<Hash>
Method intended to get all objects of that type in a specified project.

Instance Method Summary collapse

#create_metric(options = { :type => :sum }) ⇒ GoodData::Metric (also: #create_measure)
Creates the basic count metric with the fact used.

Methods included from Mixin::IsFact

#fact?

Methods inherited from MdObject

#==, #add_tag, #browser_uri, #delete, #deprecated, #deprecated=, find_replaceable_values, #initialize, #listed?, #project, #reload!, #remove_tag, replace, #replace, #replace!, replace_bracketed, replace_quoted, #save, #save_as, #tag_set, #unlisted, #unlisted=, #validate

Methods included from Mixin::MdIdToUri

#identifier_to_uri

Methods included from Mixin::MdObjectIndexer

#[]

Methods included from Mixin::MdObjectQuery

#all, #dependency, #dependency?, #query, #usedby, #usedby?, #using, #using?

Methods included from Mixin::MdFinders

#find_by_identifier, #find_by_tag, #find_by_title, #find_first_by_identifier, #find_first_by_title

Methods included from Mixin::MdObjId

#uri_obj_id

Methods included from Mixin::MdGrantees

#change_permission, #grant, #grantees, #revoke

Methods included from Mixin::MdRelations

#dependency, #dependency?, #usedby, #usedby?, #using, #using?

Methods included from Mixin::ObjId

#obj_id

Methods included from Mixin::Links

#links

Methods inherited from Rest::Resource

#initialize

Methods inherited from Rest::Object

client, default_client, #initialize, #saved?

Methods included from Mixin::DataPropertyReader

#data_property_reader

Methods included from Mixin::DataPropertyWriter

#data_property_writer

Methods included from Mixin::MetaPropertyReader

#metadata_property_reader

Methods included from Mixin::MetaPropertyWriter

#metadata_property_writer

Methods included from Mixin::MetaGetter

#meta

Methods included from Mixin::DataGetter

#data

Methods included from Mixin::RootKeyGetter

#root_key

Methods included from Mixin::ContentGetter

#content

Constructor Details

This class inherits a constructor from GoodData::MdObject

Class Method Details

.all(options = { :client => GoodData.connection, :project => GoodData.project }) ⇒ `Array<GoodData::MdObject> | Array<Hash>`

Method intended to get all objects of that type in a specified project

Parameters:

options (Hash) (defaults to: { :client => GoodData.connection, :project => GoodData.project }) —
the options hash

Options Hash (options):

:full (Boolean) —
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

Returns:

(Array<GoodData::MdObject> | Array<Hash>) —
Return the appropriate metadata objects or their representation



26
27
28

# File 'lib/gooddata/models/metadata/fact.rb', line 26

def all(options = { :client => GoodData.connection, :project => GoodData.project })
  query('fact', Fact, options)
end

Instance Method Details

#create_metric(options = { :type => :sum }) ⇒ `GoodData::Metric` Also known as: create_measure

Creates the basic count metric with the fact used. The metric created is not saved.