Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method

Usage

make_empty_line

Custom action: Create a TM1RuleToken instance representing an empty line.

make_comment

Custom action: Creates a TM1RuleToken instance representing a comment or a directive.

make_command

Custom action: Creates a TM1RuleToken or TM1RuleCommand instance based on type of parsed token. TM1RuleCommand instance will be created for calculation rule or a feeder rule (CalcRule non-terminal symbol in grammar), an instance of TM1RuleToken in other cases (skipcheck, feeders, feedstrings).

begin_region

Custom action: Creates instance of TM1RegionStart when #Region was parsed.

end_region

Custom action: Creates instance of TM1RegionEnd when #EndRegion was parsed.

make_directive

Custom action: Will call directives_resolver.consume_directive to create an instance of a new TM1Directive in the directives_resolver.directives_by_scope internal store when the parser parsed a directive.

make_calc_rule

Custom action: Creates a TM1CalcRule instance when a calculation rule statement was parsed.

make_feeder_rule

Custom action: Creates a TM1CalcRule instance when a feeder rule statement was parsed.

make_area_statement

Custom action: Creates a TM1RuleAreaStatement instance when an area statement of calculation or a feeder rule was parsed. The instance of the class is area_statementproperty of TM1CalcRule created by make_calc_rule or make_feeder_rule.

make_ident

Custom action: Returns a string representing an identifier parsed by the parser - for example it may be a dimension, hierarchy or element name.

make_catalog_key

Custom action: Returns a string representing an ID to use to retrieve MDX query from fpm.json Catalog object that is associated with a directive that has been parsed.

make_region_definition

Custom action: Returns a string representing name of a region after #Region or #EndRegion have been parsed.

add_dim_to_map

Custom action: Returns a dictionary of elements that follow a dimension name in a directive or in an area statement indexed by the dimension name.

add_dim_to_map2

Custom action: Returns a tuple containing a dimension and an element name.

make_dim_elem_pair

Custom action: Returns a tuple containing a dimension identifier and element list.

make_hier_elem

Custom action: Returns a hierarchy name (optional) and element name.

ignore_dim_elem_pair

Custom action: Returns an element name with no hierarchy.

make_elem_list

Custom action: Returns a list of element names.

make_elem_list2

Custom action: Returns a list of element names.

make_mdx_query

Custom action: Returns @mdx flag indicating unlimited spicing scope within a dimension/hierarchy.

make_hex_footprint

Custom action: Returns a hex footprint parsed from a placeholder before actual rule for which the checksum was calculated.

make_rule_id

Custom action: Returns an instance of TM1RuleID representing a checksum calculated for actual rule when the checksum has been parsed.

splice_rule

Returns a spliced rule as string. The method will first parse the rule, then it will retrieve parse tree and in turn it will run convert method on all objects included in the parse tree.

get_rule

Returns a rule as string. The method will parse the rule, then retrieve parse tree and run get_text method on all objects included in the parse tree.

get_parse_tree

Returns a parse tree, root element of the tree is a TreeNode instance representing entire rule file. The method runs parser.parse() to get the parse tree from the Parser instance.

locate_region_subtrees

exclude_subtree

inject_subtree

...