arelle.ModelFormulaObject

See COPYRIGHT.md for copyright information.

Module Contents

Classes

FormulaOptions
Trace
ModelFormulaResource
ModelAssertionSet
ModelVariableSet
ModelFormulaRules
ModelFormula
ModelTuple
ModelVariableSetAssertion
ModelExistenceAssertion
ModelValueAssertion
ModelConsistencyAssertion
ModelParameter
ModelInstance
ModelVariable
ModelFactVariable
ModelGeneralVariable
ModelPrecondition
ModelFilter
ModelTestFilter
ModelPatternFilter
ModelAspectCover
ModelBooleanFilter
ModelAndFilter
ModelOrFilter
ModelConceptName
ModelConceptPeriodType
ModelConceptBalance
ModelConceptFilterWithQnameExpression
ModelConceptCustomAttribute
ModelConceptDataType
ModelConceptSubstitutionGroup
ModelConceptRelation
ModelEntityIdentifier
ModelEntitySpecificIdentifier
ModelEntityScheme
ModelEntityRegexpIdentifier
ModelEntityRegexpScheme
ModelGeneral
ModelMatchFilter
ModelPeriod
ModelDateTimeFilter
ModelPeriodStart
ModelPeriodEnd
ModelPeriodInstant
ModelForever
ModelInstantDuration
MemberModel
ModelExplicitDimension
ModelTypedDimension
ModelRelativeFilter
ModelSegmentFilter
ModelScenarioFilter
ModelAncestorFilter
ModelParentFilter
ModelLocationFilter
ModelSiblingFilter
ModelGeneralMeasures
ModelSingleMeasure
ModelNilFilter
ModelPrecisionFilter
ModelEqualityDefinition
ModelMessage
ModelAssertionSeverity
ModelCustomFunctionSignature
ModelCustomFunctionImplementation

API

class arelle.ModelFormulaObject.FormulaOptions(savedValues=None)

Initialization

typedParameters(prefixedNamespaces=None)

traceSource(traceType)

traceEvaluation(traceType)

class arelle.ModelFormulaObject.Trace

PARAMETER

1

VARIABLE_SET

2

MESSAGE

3

FORMULA_RULES

4

VARIABLE

5

CUSTOM_FUNCTION

6

CALL

7

TEST

8

class arelle.ModelFormulaObject.ModelFormulaResource

Bases: arelle.ModelDtsObject.ModelResource

init(modelDocument)

property descendantArcroles

compile()

variableRefs(progs=[], varRefSet=None)

logLabel(preferredRole='*', lang=None)

class arelle.ModelFormulaObject.ModelAssertionSet

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

property descendantArcroles

property propertyView

__repr__()

class arelle.ModelFormulaObject.ModelVariableSet

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

property descendantArcroles

property aspectModel

property implicitFiltering

property groupFilterRelationships

property xmlElementView

property propertyView

__repr__()

class arelle.ModelFormulaObject.ModelFormulaRules

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

evaluate(xpCtx)

evaluateRule(xpCtx, aspect)

hasRule(aspect)

property value

property expression

source(aspect=None, ruleElement=None, acceptFormulaSource=True)

aspectRuleElements(aspect)

class arelle.ModelFormulaObject.ModelFormula

Bases: arelle.ModelFormulaObject.ModelFormulaRules, arelle.ModelFormulaObject.ModelVariableSet

init(modelDocument)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelTuple

Bases: arelle.ModelFormulaObject.ModelFormula

init(modelDocument)

class arelle.ModelFormulaObject.ModelVariableSetAssertion

Bases: arelle.ModelFormulaObject.ModelVariableSet

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

property test

property expression

message(satisfied, preferredMessage='*', lang=None)

unsatisfiedSeverity(xpCtx, contextItem=None)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelExistenceAssertion

Bases: arelle.ModelFormulaObject.ModelVariableSetAssertion

init(modelDocument)

class arelle.ModelFormulaObject.ModelValueAssertion

Bases: arelle.ModelFormulaObject.ModelVariableSetAssertion

init(modelDocument)

evaluate(xpCtx)

class arelle.ModelFormulaObject.ModelConsistencyAssertion

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

compile()

evalRadius(xpCtx, factValue)

property descendantArcroles

property hasProportionalAcceptanceRadius

property hasAbsoluteAcceptanceRadius

property isStrict

message(satisfied, preferredMessage='*', lang=None)

property radiusExpression

property viewExpression

property xmlElementView

property propertyView

__repr__()

class arelle.ModelFormulaObject.ModelParameter

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

evaluate(xpCtx, typeQname)

property name

property parameterQname

property select

property isRequired

property asType

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelInstance

Bases: arelle.ModelFormulaObject.ModelParameter

init(modelDocument)

property instanceQname

class arelle.ModelFormulaObject.ModelVariable

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

compile()

property bindAsSequence

class arelle.ModelFormulaObject.ModelFactVariable

Bases: arelle.ModelFormulaObject.ModelVariable

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

property descendantArcroles

property nils

property matches

property fallbackValue

property filterRelationships

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelGeneralVariable

Bases: arelle.ModelFormulaObject.ModelVariable

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

property select

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelPrecondition

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

property test

evalTest(xpCtx)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelFilter

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

hasNoFilterVariableDependencies(xpCtx)

property isFilterShared

property propertyView

__repr__()

class arelle.ModelFormulaObject.ModelTestFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

compile()

variableRefs(progs=[], varRefSet=None)

property test

evalTest(xpCtx, fact)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelPatternFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

property pattern

property rePattern

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelAspectCover

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding, xpCtx=None)

dimAspectsCovered(varBinding)

compile()

variableRefs(progs=[], varRefSet=None)

property viewExpression

class arelle.ModelFormulaObject.ModelBooleanFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

property descendantArcroles

property filterRelationships

aspectsCovered(varBinding)

class arelle.ModelFormulaObject.ModelAndFilter

Bases: arelle.ModelFormulaObject.ModelBooleanFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelOrFilter

Bases: arelle.ModelFormulaObject.ModelBooleanFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelConceptName

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

compile()

variableRefs(progs=[], varRefSet=None)

property conceptQnames

property qnameExpressions

evalQnames(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelConceptPeriodType

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

aspectsCovered(varBinding)

property periodType

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelConceptBalance

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

aspectsCovered(varBinding)

property balance

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property filterQname

property qnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalQname(xpCtx, fact)

class arelle.ModelFormulaObject.ModelConceptCustomAttribute

Bases: arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

init(modelDocument)

clear()

property value

compile()

variableRefs(progs=[], varRefSet=None)

evalValue(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelConceptDataType

Bases: arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

init(modelDocument)

property strict

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelConceptSubstitutionGroup

Bases: arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

init(modelDocument)

property strict

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelConceptRelation

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property variable

property sourceQname

property linkrole

property linkQname

property arcrole

property axis

property generations

property test

property arcQname

property sourceQnameExpression

property linkroleExpression

property linknameExpression

property arcroleExpression

property arcnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalSourceQname(xpCtx, fact)

evalLinkrole(xpCtx, fact)

evalLinkQname(xpCtx, fact)

evalArcrole(xpCtx, fact)

evalArcQname(xpCtx, fact)

evalTest(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property viewExpression

property xmlElementView

class arelle.ModelFormulaObject.ModelEntityIdentifier

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

aspectsCovered(varBinding)

class arelle.ModelFormulaObject.ModelEntitySpecificIdentifier

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property scheme

property value

compile()

variableRefs(progs=[], varRefSet=None)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelEntityScheme

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property scheme

compile()

variableRefs(progs=[], varRefSet=None)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelEntityRegexpIdentifier

Bases: arelle.ModelFormulaObject.ModelPatternFilter

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelEntityRegexpScheme

Bases: arelle.ModelFormulaObject.ModelPatternFilter

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelGeneral

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelMatchFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

property aspectName

property dimension

property matchAny

property aspect

aspectsCovered(varBinding)

property variable

variableRefs(progs=[], varRefSet=None)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelPeriod

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelDateTimeFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property date

property time

compile()

variableRefs(progs=[], varRefSet=None)

evalDatetime(xpCtx, fact, addOneDay=False)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelPeriodStart

Bases: arelle.ModelFormulaObject.ModelDateTimeFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelPeriodEnd

Bases: arelle.ModelFormulaObject.ModelDateTimeFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelPeriodInstant

Bases: arelle.ModelFormulaObject.ModelDateTimeFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelForever

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

aspectsCovered(varBinding)

class arelle.ModelFormulaObject.ModelInstantDuration

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

aspectsCovered(varBinding)

property variable

variableRefs(progs=[], varRefSet=None)

property boundary

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.MemberModel(qname, qnameExprProg, variable, linkrole, arcrole, axis)

Initialization

class arelle.ModelFormulaObject.ModelExplicitDimension

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property dimQname

property dimQnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalDimQname(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

property viewExpression

class arelle.ModelFormulaObject.ModelTypedDimension

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

aspectsCovered(varBinding)

property dimQname

property dimQnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalDimQname(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property viewExpression

class arelle.ModelFormulaObject.ModelRelativeFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

property variable

variableRefs(progs=[], varRefSet=None)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelSegmentFilter

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelScenarioFilter

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelAncestorFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

aspectsCovered(varBinding)

property ancestorQname

property qnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalQname(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelParentFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property parentQname

property qnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalQname(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelLocationFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property location

property variable

compile()

variableRefs(progs=[], varRefSet=None)

evalLocation(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelSiblingFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

aspectsCovered(varBinding)

property variable

variableRefs(progs=[], varRefSet=None)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelGeneralMeasures

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

aspectsCovered(varBinding)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelSingleMeasure

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

clear()

aspectsCovered(varBinding)

property measureQname

property qnameExpression

compile()

variableRefs(progs=[], varRefSet=None)

evalQname(xpCtx, fact)

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelNilFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

filter(xpCtx, varBinding, facts, cmplmt)

class arelle.ModelFormulaObject.ModelPrecisionFilter

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument)

property minimum

filter(xpCtx, varBinding, facts, cmplmt)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelEqualityDefinition

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument)

evalTest(xpCtx, facta, factb)

class arelle.ModelFormulaObject.ModelMessage

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

property xmlLang

(str) – xml:lang attribute

property separator

compile()

variableRefs(progs=[], varRefSet=None)

evaluate(xpCtx, contextItem=None)

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelAssertionSeverity

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

compile()

evaluate(xpCtx, contextItem=None)

variableRefs(progs=[], varRefSet=None)

property isStatic

property level

property severity

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelCustomFunctionSignature

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

property descendantArcroles

property name

property functionQname

property outputType

property inputTypes

property propertyView

__repr__()

property viewExpression

class arelle.ModelFormulaObject.ModelCustomFunctionImplementation

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument)

clear()

property inputNames

property stepExpressions

property outputExpression

compile()

variableRefs(progs=[], varRefSet=None)

property propertyView

__repr__()

property viewExpression