xplain.XObject [Beta]

class xplain.XObject(object_name, ref_session)

Bases: object

add_aggregation_dimension(dimension_name, aggregation, selections=[], floating_semantics=False)

adds an aggregation dimension to the given target dimension. The aggregation dimension aggregates data from a child object (or any deeper descendant objects) according to the given aggregation definition.

Parameters

• dimension_name (string) – the name of new dimension

• aggregation (json or aggregation object) – aggregation of the new dimension

• selections (array of json or selection object) – the selections shall be considered

• floating_semantics – If set to true the resulting dimension will

have a floating semantics. :type floating_semantics: boolean

Example:

>>> xobject = session.get_object("Krankengeld")
>>> xobject.add_aggregation_dimension(
                                 dimension_name="newDim",
                                 aggregation={
                                         "object": "Krankengeld",
                                         "dimension":"Anzahl_Tage",
                                         "type": "AVG"
                                        }
                                )

get_child_objects()

get the children Xobjects of current Xobject

Returns

list of Xobject

:rtype string[]

get_dimension(dimension_name)

get_dimensions()

get the list of dimensions attached to the current Xobject

Returns

list of dimension names

get_name()

object_name = None