Skip to content

MDXView

MDX_VIEW_EXCLUDED_KEYS = frozenset({'@odata.type', '@odata.context', '@odata.etag', 'Name', 'MDX', 'Cube', 'Attributes', 'LocalizedAttributes'}) module-attribute

MDXView(cube_name, view_name, MDX, dynamic_properties=None)

Bases: View

Abstraction on TM1 MDX view

IMPORTANT. MDXViews can't be seen through the old TM1 clients (Architect, Perspectives). They do exist though!

Source code in TM1py/Objects/MDXView.py 
31
32
33
34
35
def __init__(self, cube_name: str, view_name: str, MDX: str, dynamic_properties: Optional[Dict] = None):
    View.__init__(self, cube_name, view_name)
    self._mdx = MDX
    self._dynamic_properties = {}
    self.dynamic_properties = dynamic_properties

MDX property writable

body property

dynamic_properties property writable

mdx property writable

construct_body()

Source code in TM1py/Objects/MDXView.py 
103
104
105
106
107
108
109
def construct_body(self) -> str:
    mdx_view_as_dict = collections.OrderedDict()
    mdx_view_as_dict["@odata.type"] = "ibm.tm1.api.v1.MDXView"
    mdx_view_as_dict["Name"] = self._name
    mdx_view_as_dict["MDX"] = self._mdx
    mdx_view_as_dict.update({k: v for k, v in self._dynamic_properties.items() if k not in MDX_VIEW_EXCLUDED_KEYS})
    return json.dumps(mdx_view_as_dict, ensure_ascii=False)

from_dict(view_as_dict, cube_name=None) classmethod

Source code in TM1py/Objects/MDXView.py 
 94
 95
 96
 97
 98
 99
100
101
@classmethod
def from_dict(cls, view_as_dict: Dict, cube_name: str = None) -> "MDXView":
    return cls(
        cube_name=view_as_dict["Cube"]["Name"] if not cube_name else cube_name,
        view_name=view_as_dict["Name"],
        MDX=view_as_dict["MDX"],
        dynamic_properties={k: v for k, v in view_as_dict.items() if k not in MDX_VIEW_EXCLUDED_KEYS},
    )

from_json(view_as_json, cube_name=None) classmethod

Source code in TM1py/Objects/MDXView.py 
89
90
91
92
@classmethod
def from_json(cls, view_as_json: str, cube_name: Optional[str] = None) -> "MDXView":
    view_as_dict = json.loads(view_as_json)
    return cls.from_dict(view_as_dict, cube_name)

substitute_title(dimension, hierarchy, element)

dimension and hierarchy name are space sensitive!

Parameters:

Name Type Description Default
dimension str
required
hierarchy str
required
element str
required

Returns:

Type Description
Source code in TM1py/Objects/MDXView.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def substitute_title(self, dimension: str, hierarchy: str, element: str):
    """dimension and hierarchy name are space sensitive!

    :param dimension:
    :param hierarchy:
    :param element:
    :return:
    """
    pattern = re.compile(r"\[" + dimension + r"\].\[" + hierarchy + r"\].\[(.*?)\]", re.IGNORECASE)
    findings = re.findall(pattern, self._mdx)

    if findings:
        self._mdx = re.sub(pattern=pattern, repl=f"[{dimension}].[{hierarchy}].[{element}]", string=self._mdx)
        return

    if hierarchy is None or case_and_space_insensitive_equals(dimension, hierarchy):
        pattern = re.compile(r"\[" + dimension + r"\].\[(.*?)\]", re.IGNORECASE)
        findings = re.findall(pattern, self._mdx)
        if findings:
            self._mdx = re.sub(pattern=pattern, repl=f"[{dimension}].[{element}]", string=self._mdx)
            return

    raise ValueError(f"No selection in title with dimension: '{dimension}' and hierarchy: '{hierarchy}'")