Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Element Parent and Ancestor methods #771

Merged
merged 3 commits into from
Jul 26, 2022
Merged

Update Element Parent and Ancestor methods #771

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8517432
Update Element Parent and Ancestor methods to support 2 MDX query opt…
rclapp Jul 25, 2022
7cbc240
Small Cleanup of MDX
rclapp Jul 25, 2022
faacbf9
Correct issue with MDX method switch
rclapp Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 35 additions & 22 deletions TM1py/Services/ElementService.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,19 @@

from requests import Response

from TM1py.Exceptions import TM1pyRestException
from TM1py.Exceptions import TM1pyRestException, TM1pyException
from TM1py.Objects import ElementAttribute, Element
from TM1py.Services.ObjectService import ObjectService
from TM1py.Services.RestService import RestService
from TM1py.Utils import CaseAndSpaceInsensitiveDict, format_url, CaseAndSpaceInsensitiveSet
from TM1py.Utils import build_element_unique_names, CaseAndSpaceInsensitiveTuplesDict
from mdxpy import MdxHierarchySet, Member
from mdxpy import MdxHierarchySet, Member, MdxLevelExpression
from enum import Enum


class MDXDrillMethod(Enum):
TM1DRILLDOWNMEMBER = 1
DESCENDANTS = 2



Expand All @@ -23,7 +29,6 @@ class ElementService(ObjectService):
def __init__(self, rest: RestService):
super().__init__(rest)


def get(self, dimension_name: str, hierarchy_name: str, element_name: str, **kwargs) -> Element:
url = format_url(
"/api/v1/Dimensions('{}')/Hierarchies('{}')/Elements('{}')?$expand=*",
Expand Down Expand Up @@ -458,7 +463,7 @@ def get_leaves_under_consolidation(self, dimension_name: str, hierarchy_name: st
:param hierarchy_name: name of hierarchy
:param consolidation: name of consolidated Element
:param max_depth: 99 if not passed
:return:
:return:
"""
return self.get_members_under_consolidation(dimension_name, hierarchy_name, consolidation, max_depth, True,
**kwargs)
Expand Down Expand Up @@ -659,14 +664,22 @@ def _get_mdx_set_cardinality(self, mdx: str) -> int:
response = self._rest.POST(url, json.dumps(payload, ensure_ascii=False))
return response.json()['Cardinality']

def _build_drill_intersection_mdx(self, dimension_name: str, hierarchy_name: str, first_element_name: str,
second_element_name: str, recursive: bool) ->str:
@staticmethod
def _build_drill_intersection_mdx(dimension_name: str, hierarchy_name: str, first_element_name: str,
second_element_name: str, mdx_method: str, recursive: bool) -> str:

first_member = Member.of(dimension_name, hierarchy_name, first_element_name)
second_member = Member.of(dimension_name, hierarchy_name, second_element_name)
mdx = MdxHierarchySet.members([first_member]).tm1_drill_down_member(all=True, recursive=recursive)\
.intersect(MdxHierarchySet.members([second_member])).to_mdx()

if not hasattr(MDXDrillMethod, mdx_method.upper()):
raise TM1pyException('Invalid MDX Drill Method Specified, Options: TM1DrillDownMember or Descendants')
elif MDXDrillMethod.DESCENDANTS.name == mdx_method.upper():
mdx = MdxHierarchySet.members([first_member]).tm1_drill_down_member(all=True, recursive=recursive) \
rclapp marked this conversation as resolved.
Show resolved Hide resolved
.intersect(MdxHierarchySet.members([second_member])).to_mdx()
elif MDXDrillMethod.TM1DRILLDOWNMEMBER.name == mdx_method.upper():
mdx = MdxHierarchySet.descendants(first_member,
MdxLevelExpression.member_level(first_member),
'SELF_AND_AFTER')
return mdx

def element_is_parent(self, dimension_name: str, hierarchy_name: str, parent_name: str,
Expand All @@ -676,30 +689,30 @@ def element_is_parent(self, dimension_name: str, hierarchy_name: str, parent_nam
:if an invalid element is passed;
:but will raise an exception if an invalid dimension, or hierarchy is passed
"""
mdx = self._build_drill_intersection_mdx(dimension_name,
hierarchy_name,
parent_name,
element_name,
False)
mdx = self._build_drill_intersection_mdx(dimension_name=dimension_name,
hierarchy_name=hierarchy_name,
first_element_name=parent_name,
second_element_name=element_name,
mdx_method='TM1DrillDownMember',
recursive=False)

cardinality = self._get_mdx_set_cardinality(mdx)
return bool(cardinality)

def element_is_ancestor(self, dimension_name: str, hierarchy_name: str, ancestor_name: str,
element_name: str) -> bool:
element_name: str, mdx_method: str = 'TM1DrillDownMember') -> bool:
""" Element is Parent
:Note, unlike the related function in TM1 (ELISANC or ElementIsAncestor), this function will return False
:if an invalid element is passed;
:but will raise an exception if an invalid dimension, or hierarchy is passed
"""
mdx = self._build_drill_intersection_mdx(dimension_name,
hierarchy_name,
ancestor_name,
element_name,
True)

mdx = self._build_drill_intersection_mdx(dimension_name=dimension_name,
hierarchy_name=hierarchy_name,
first_element_name=ancestor_name,
second_element_name=element_name,
mdx_method=mdx_method,
recursive=True)

cardinality = self._get_mdx_set_cardinality(mdx)
return bool(cardinality)



16 changes: 16 additions & 0 deletions Tests/ElementService_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,22 @@ def test_element_is_not_ancestor(self):
element_name='1991')
self.assertEqual(False, result)

def test_element_is_ancestor_descendants_method(self):
result = self.tm1.elements.element_is_ancestor(dimension_name=self.dimension_name,
hierarchy_name=self.hierarchy_name,
ancestor_name='All Consolidations',
element_name='1992',
mdx_method='Descendants')
self.assertEqual(True, result)

def test_element_is_not_ancestor_descendants_method(self):
result = self.tm1.elements.element_is_ancestor(dimension_name=self.dimension_name,
hierarchy_name=self.hierarchy_name,
ancestor_name='1992',
element_name='1991',
mdx_method='Descendants')
self.assertEqual(False, result)

@classmethod
def tearDownClass(cls):
cls.tm1.logout()
Expand Down