Containers/Objects (package)
TM1Directive
(class in TM1Directive.py
)
This class represents single splicing directive from parsed TM1 rule file.
The class defines following attributes:
Attribute | Type | Usage |
---|---|---|
|
| Name of region in which the directive applies. |
|
| Dictionary of associated regular expressions that define splicing set of the splicing directive indexed by dimension. |
|
| An ID to lookup a |
The class exposes following methods:
Method | Usage |
---|---|
| Returns |
| Returns a list of dimensions that the directive applies to. |
| Returns a list of hierarchies of specified dimension that the directive applies to. |
| Returns a list of elements (regular expression) associated with specified dimension of the directive. |
| Returns a flag if all of elements related to specified dimension should be spliced. This applies when a special tag |
| Returns |
| Returns a flag if the directive applies to supplied dimension and element list. |
| Returns a list of all elements for supplied dimension a and list of elements, for which the directive is matching with the regular expression, if the directive was specified with |
TM1Region
(class in TM1Region.py
, extends TM1RuleToken
)
The class represents a single region instance in the TM1 rule file. The region is considered as contents of the rule file between #Region
and #EndRegion
marks associated with the region.
The class defines following attributes:
Attribute | Type | Usage |
---|---|---|
|
| Name of region. |
The class exposes following methods:
Method | Usage |
---|---|
| Returns |
| Updates |
| Updates |
| Returns |
| Returns |
| Returns a flag indicating the region overlaps completely a string space inside supplied boundaries. |
TM1RegionStart
(class in TM1Region.py
, extends TM1RuleToken
)
This class represents a keyword #Region
parsed from the TM1 rule file.
The class defines following attributes:
Attribute | Type | Usage |
---|---|---|
|
| Link to a TM1Region instance that was defined by the keyword. |
The class exposes following methods:
Method | Usage |
---|---|
| Returns |
TM1RegionEnd
(class in TM1Region.py
, extends TM1RuleToken
)
This class represents a keyword #Region
parsed from the TM1 rule file.
The class defines following attributes:
Attribute | Type | Usage |
---|---|---|
|
| Link to a TM1Region instance that was defined by the keyword. |
The class exposes following methods:
Method | Usage |
---|---|
| Returns |
TM1ReverseDirective
(class in TM1ReverseDirective.py
, extends TM1Directive
)
The class represents a directive for reverse splicing. The reverse directive is derived from directive by using the same logic to match elements for splicing as the original directive, but uses element list obtained from QueryRollback
for splicing.
The class defines following attributes:
Attribute | Type | Usage |
---|---|---|
|
| Dictionary of associated regular expressions that define splicing set of the splicing directive indexed by dimension. |
The class exposes following methods:
Method | Usage |
---|---|
| Returns |
| Returns dimensions of |
| Returns a regular expression associated with the directive if it was defined or empty string. |
| Returns a regular expression assigned to the dimension directive or all dimension’s elements associated with the directive if all elements of a dimension are to be spliced ( |
| Returns |
| Returns a flag if all of elements related to specified dimension should be spliced. This applies when a special tag |
| Returns a flag if the directive applies to supplied dimension and element list. |