Class: GoodData::Model::SchemaBlueprint

Inherits:
Object
  • Object
show all
Defined in:
lib/gooddata/models/blueprint/schema_blueprint.rb

Direct Known Subclasses

DatasetBlueprint, DateDimension

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dim, blueprint) ⇒ SchemaBlueprint

Returns a new instance of SchemaBlueprint.



12
13
14
15
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 12

def initialize(dim, blueprint)
  @data = dim
  @project_blueprint = blueprint
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



10
11
12
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 10

def data
  @data
end

#project_blueprint ⇒ Object

Returns the value of attribute project_blueprint.



10
11
12
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 10

def project_blueprint
  @project_blueprint
end

Instance Method Details

#==(other) ⇒ Boolean

Compares two blueprints. This is done by comapring the hash represenatation. It has to be exacty identical including the order of the columns

Parameters:

Returns:

  • (Boolean) —

    matching fields



151
152
153
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 151

def ==(other)
  to_hash == other.to_hash
end

#anchor ⇒ GoodData::Model::AnchorBlueprintField

Returns anchor

Returns:



27
28
29
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 27

def anchor
  nil
end

#anchor? ⇒ Boolean

Returns true if anchor is present. Currently returns always true. Probably good to remove

Returns:

  • (Boolean) —

    is anchor on schema?l70



20
21
22
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 20

def anchor?
  true
end

#attributes(_id = :all, _options = {}) ⇒ Array<GoodData::Model::AttributeBlueprintField>

Returns list of all attributes defined on the schema.

Returns:



48
49
50
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 48

def attributes(_id = :all, _options = {})
  []
end

#attributes_and_anchors ⇒ Array<GoodData::Model::AnchorBlueprintField | GoodData::Model::AttributeBlueprintField>

Returns list of attributes and anchor.

Returns:



69
70
71
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 69

def attributes_and_anchors
  []
end

#breaks ⇒ Array<GoodData::Model::AnchorBlueprintField | GoodData::Model::AttributeBlueprintField>

Returns list of attributes that are broken by attributes in this dataset. This means all anchors and attributes from this dataset and the ones that are referenced by any dataset. It works transitively. Includes only anchors that have labels.

Returns:



89
90
91
92
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 89

def breaks
  attrs = attributes_and_anchors.reject { |a| a.labels.empty? }
  referenced_by.empty? ? attrs : attrs + referenced_by.flat_map(&:breaks)
end

#broken_by ⇒ Array<GoodData::Model::BlueprintField>

Returns list of attributes that can break facts in a given dataset. This basically means that it is giving you all attributes from this dataset and datasets that are referenced by given dataset transitively. Includes only anchors that have labels.

Returns:



79
80
81
82
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 79

def broken_by
  attrs = attributes_and_anchors.reject { |a| a.labels.empty? }
  attrs + references.map(&:dataset).flat_map(&:broken_by)
end

#facts(_id = :all, _options = {}) ⇒ Array<GoodData::Model::FactBlueprintField>

Returns list of all facts defined on the schema.

Returns:



41
42
43
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 41

def facts(_id = :all, _options = {})
  []
end

#fields ⇒ Array<GoodData::Model::BlueprintField>

Returns list of all fields defined on the schema.

Returns:



62
63
64
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 62

def fields
  []
end

#find_dataset(dataset, options = {}) ⇒ GoodData::Model::DatasetBlueprint

Relays request on finding a dataset in the associated project blueprint. Used by reference fields

Parameters:

  • dataset (String) —

    Name of a dataset

  • options (Hash) (defaults to: {}) —

    additional options. See ProjectBlueprint form more

Returns:



99
100
101
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 99

def find_dataset(dataset, options = {})
  project_blueprint.find_dataset(dataset, options)
end

#id ⇒ String

Returns id of the schema

Returns:



106
107
108
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 106

def id
  data[:id]
end

#labels(_id = :all, _options = {}) ⇒ Array<GoodData::Model::LabelBlueprintField>

Returns list of all labels defined on the schema.

Returns:



55
56
57
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 55

def labels(_id = :all, _options = {})
  []
end

#referenced_by ⇒ Array<GoodData::Model::SchemaBlueprint>

Returns dataset that are referencing this dataset (directly through references not transitively).

Returns:



113
114
115
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 113

def referenced_by
  @project_blueprint.referencing(self)
end

#references ⇒ Array<GoodData::Model::ReferenceBlueprintField>

Returns list of all references defined on the schema.

Returns:



34
35
36
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 34

def references
  []
end

#referencing ⇒ Array<GoodData::Model::SchemaBlueprint>

Returns dataset that are referenced by this dataset (directly through references not transitively).

Returns:



120
121
122
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 120

def referencing
  references.map(&:dataset)
end

#title ⇒ String

Returns title of the dataset. If it is not set up. It is generated for you based on the name which is titleized

Returns:



128
129
130
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 128

def title
  data[:title] || GoodData::Helpers.titleize(data[:id])
end

#to_hash ⇒ Object 



155
156
157
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 155

def to_hash
  @data
end

#valid? ⇒ Boolean

Validates the blueprint and returns true if model is valid. False otherwise.

Returns:

  • (Boolean) —

    is model valid?



135
136
137
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 135

def valid?
  validate.empty?
end

#validate ⇒ Array<Hash>

Validates the blueprint and returns array of errors.

Returns:

  • (Array<Hash>) —

    returns array of errors or empty array



142
143
144
 
# File 'lib/gooddata/models/blueprint/schema_blueprint.rb', line 142

def validate
  fields.flat_map(&:validate)
end