Class: GoodData::Folder

Inherits:
MdObject show all
Includes:
Mixin::IsFolder
Defined in:
lib/gooddata/models/metadata/folder.rb

Constant Summary

Constants inherited from MdObject

MdObject::IDENTIFIERS_CFG, MdObject::MD_OBJ_CTG

Constants included from Mixin::MdIdToUri

Mixin::MdIdToUri::IDENTIFIERS_CFG

Constants included from Mixin::MdObjectIndexer

Mixin::MdObjectIndexer::MD_OBJ_CTG

Constants included from Mixin::MdObjectQuery

Mixin::MdObjectQuery::ERROR_MESSAGE_NO_PROJECT

Instance Attribute Summary

Attributes inherited from Rest::Object

#client, #json, #project

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixin::IsFolder

#folder?

Methods inherited from MdObject

#==, #add_tag, #browser_uri, #delete, #deprecated, #deprecated=, find_replaceable_values, #get_flag?, #initialize, #listed?, #production, #production=, #project, #reload!, #remove_tag, replace, #replace, #replace!, replace_bracketed, replace_quoted, #restricted, #restricted=, #save, #save_as, #set_flag, #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

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.

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

Returns:

  • (Array<GoodData::MdObject> | Array<Hash>) —

    Return the appropriate metadata objects or their representation



26
27
28
 
# File 'lib/gooddata/models/metadata/folder.rb', line 26

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

.create(opts) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/gooddata/models/metadata/folder.rb', line 30

def create(opts)
  title = opts[:title]
  summary = opts[:summary] || ''
  type = opts[:type] || 'fact'

  folder = {
    'folder' => {
      'content' => {
        'type' => Array(type)
      },
      'meta' => {
        'tags' => '',
        'summary' => summary,
        'title' => title
      }
    }
  }

  client, project = GoodData.get_client_and_project(opts)
  client.create(Folder, folder, project: project)
end

Instance Method Details

#entries ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/gooddata/models/metadata/folder.rb', line 53

def entries
  (json['folder']['content']['entries'] || []).pmap do |entry|
    res = case json['folder']['content']['type'].first
          when 'fact'
            GoodData::Fact[entry['link'], :client => client, :project => project]
          when 'metric'
            GoodData::Metric[entry['link'], :client => client, :project => project]
          else
            GoodData::MdObject[entry['link'], :client => client, :project => project]
          end
    res
  end
end

#type ⇒ Object 



67
68
69
 
# File 'lib/gooddata/models/metadata/folder.rb', line 67

def type
  json['folder']['content']['type'][0]
end