Click or drag to resize

Altova.RaptorXml.Xbrl.Formula Namespace

The Altova.RaptorXml.Xbrl.Formula namespace provides a .NET API for the Formula 1.0 specifications.

This .NET interface enables the user to navigate the formula linkbase and access information from the formula-related resources.

Classes
  ClassDescription
Public classAncestorFilter

An AncestorFilter class represents a <tf:ancestorFilter> resource in the formula linkbase.

Public classAncestorFilterAncestorData

This class represents the <tf:ancestor> child element of a <tf:ancestorFilter> filter resource.

Public classAndFilter

An AndFilter class represents a <bf:andFilter> resource in the formula linkbase.

Public classAspectCoverFilter

An AspectCoverFilter class represents a <acf:aspectCover> resource in the formula linkbase.

Public classAspectCoverFilterAspectData

This class represents the <acf:aspect> child element of a <acf:aspectCover> filter resource.

Public classAspectCoverFilterDimensionData

This class represents the <acf:dimension> child element of a <acf:aspectCover> filter resource.

Public classAspectCoverFilterExcludeDimensionData

This class represents the <acf:excludeDimension> child element of a <acf:aspectCover> filter resource.

Public classAspectCoverFilterAspectDataCollection
Public classAspectCoverFilterDimensionDataCollection
Public classAspectCoverFilterExcludeDimensionDataCollection
Public classAspectRule

An AspectRule class represents an aspect rule in a <formula:formula> or <table:table> resource.

Public classAspectRuleCollection
The AspectRuleCollection class represents a collection of AspectRule objects.
Public classAssertion

An Assertion class represents an <validation:assertion> resource in the formula linkbase.

Public classAssertionCollection
The AssertionCollection class represents a collection of Assertion objects.
Public classAssertionEvaluation

An AssertionEvaluation class represents a single evaluation of an assertion.

Public classAssertionEvaluationCollection
The AssertionEvaluationCollection class represents a collection of AssertionEvaluation objects.
Public classAssertionProcessingResult

An AssertionProcessingResult class is a container for all assertion results.

Public classAssertionProcessingSettings

The AssertionProcessingSettings class allows to modify the settings used to execute validation assertions.

Public classAssertionResult

An AssertionResult class groups together all evaluations of an assertion.

Public classAssertionResultCollection
The AssertionResultCollection class represents a collection of AssertionResult objects.
Public classAssertionSatisfiedMessageRelationship

An AssertionSatisfiedMessageRelationship class represents an assertion-satisfied-message relationship in the DTS network of relationships.

Public classAssertionSatisfiedMessageRelationshipCollection
Public classAssertionSet

An AssertionSet class represents an <validation:assertionSet> resource in the formula linkbase.

Public classAssertionSetCollection
The AssertionSetCollection class represents a collection of AssertionSet objects.
Public classAssertionSetRelationship

An AssertionSetRelationship class represents an assertion-set relationship in the DTS network of relationships.

Public classAssertionSetRelationshipCollection
The AssertionSetRelationshipCollection class represents a collection of AssertionSetRelationship objects.
Public classAssertionSetResult

An AssertionSetResult class groups together the results for all assertions in the assertion set.

Public classAssertionSetResultCollection
The AssertionSetResultCollection class represents a collection of AssertionSetResult objects.
Public classAssertionUnsatisfiedMessageRelationship

An AssertionUnsatisfiedMessageRelationship class represents an assertion-unsatisfied-message relationship in the DTS network of relationships.

Public classAssertionUnsatisfiedMessageRelationshipCollection
Public classAssertionUnsatisfiedSeverityRelationship

An AssertionUnsatisfiedSeverityRelationship class represents an assertion-unsatisfied-severity relationship in the DTS network of relationships.

Public classAssertionUnsatisfiedSeverityRelationshipCollection
Public classBooleanFilterRelationship

An BooleanFilterRelationship class represents a boolean-filter relationship in the DTS network of relationships.

Public classBooleanFilterRelationshipCollection
The BooleanFilterRelationshipCollection class represents a collection of BooleanFilterRelationship objects.
Public classConceptBalanceFilter

An ConceptBalanceFilter class represents a <cf:conceptBalance> resource in the formula linkbase.

Public classConceptCustomAttributeFilter

An ConceptCustomAttributeFilter class represents a <cf:conceptCustomAttribute> resource in the formula linkbase.

Public classConceptCustomAttributeFilterAttributeData

This class represents the <cf:attribute> child element of a <cf:conceptCustomAttribute> filter resource.

Public classConceptDataTypeFilter

An ConceptDataTypeFilter class represents a <cf:conceptDataType> resource in the formula linkbase.

Public classConceptDataTypeFilterTypeData

This class represents the <cf:type> child element of a <cf:conceptDataType> filter resource.

Public classConceptNameFilter

An ConceptNameFilter class represents a <cf:conceptName> resource in the formula linkbase.

Public classConceptNameFilterConceptData

This class represents the <cf:concept> child element of a <cf:conceptName> filter resource.

Public classConceptNameFilterConceptDataCollection
Public classConceptPeriodTypeFilter

An ConceptPeriodTypeFilter class represents a <cf:conceptPeriodType> resource in the formula linkbase.

Public classConceptRelationFilter

An ConceptRelationFilter class represents a <crf:conceptRelation> resource in the formula linkbase.

Public classConceptRelationFilterArcNameData

This class represents the <crf:arcname> or <crf:arcnameExpression> child element of a <crf:conceptRelation> filter resource.

Public classConceptRelationFilterArcRoleData

This class represents the <crf:arcrole> or <crf:arcroleExpression> child element of a <crf:conceptRelation> filter resource.

Public classConceptRelationFilterLinkNameData

This class represents the <crf:linkname> or <crf:linknameExpression> child element of a <crf:conceptRelation> filter resource.

Public classConceptRelationFilterLinkRoleData

This class represents the <crf:linkrole> or <crf:linkroleExpression> child element of a <crf:conceptRelation> filter resource.

Public classConceptRelationFilterQNameData

This class represents the <crf:qname> or <crf:qnameExpression> child element of a <crf:conceptRelation> filter resource.

Public classConceptRule

An ConceptRule class represents a concept rule in a <formula:formula> or <table:table> resource.

Public classConceptRuleQNameData

This class represents the <formula:qname> or <formula:qnameExpression> child element of a concept aspect rule.

Public classConceptSubstitutionGroupFilter

An ConceptSubstitutionGroupFilter class represents a <cf:conceptSubstitutionGroup> resource in the formula linkbase.

Public classConceptSubstitutionGroupFilterSubstitutionGroupData

This class represents the <cf:substitutionGroup> child element of a <cf:conceptSubstitutionGroup> filter resource.

Public classConsistencyAssertion

An ConsistencyAssertion class represents a <ca:consistencyAsertion> resource in the formula linkbase.

Public classConsistencyAssertionFormulaRelationship

An ConsistencyAssertionFormulaRelationship class represents a consistency-assertion-formula relationship in the DTS network of relationships.

Public classConsistencyAssertionFormulaRelationshipCollection
Public classConsistencyAssertionParameterRelationship

An ConsistencyAssertionParameterRelationship class represents a consistency-assertion-parameter relationship in the DTS network of relationships.

Public classConsistencyAssertionParameterRelationshipCollection
Public classDimensionFilter

An DimensionFilter class represents <df:explicitDimension> and <df:typedDimension> filter resources in the formula linkbase.

Public classDimensionFilterDimensionData

This class represents the <df:dimension> child element of a filter resource.

Public classDimensionRule

An DimensionRule class represents a dimension rule in a <formula:formula> or <table:table> resource.

Public classEntityIdentifierRule

An EntityIdentifierRule class represents an entity identifier rule in a <formula:formula> or <table:table> resource.

Public classEqualityDefinition

An EqualityDefinition class represents an <variable:equalityDefinition> resource in the formula linkbase.

Public classEqualityDefinitionCollection
The EqualityDefinitionCollection class represents a collection of EqualityDefinition objects.
Public classExistenceAssertion

An ExistenceAssertion class represents an <ea:existenceAsertion> resource in the formula linkbase.

Public classExplicitDimensionFilter

An ExplicitDimensionFilter class represents a <df:explicitDimension> filter resource in the formula linkbase.

Public classExplicitDimensionFilterMemberData

This class represents the <df:member> child element of an explicit dimension filter resource.

Public classExplicitDimensionFilterMemberDataCollection
Public classExplicitDimensionRule

An ExplicitDimensionRule class represents an explicit dimension rule in a <formula:formula> or <table:table> resource.

Public classExplicitDimensionRuleMemberData

This class represents the <formula:member> child element of an explicit dimension aspect rule.

Public classFactVariable

An FactVariable class represents a <variable:factVariable> resource in the formula network.

Public classFilter

An Filter class represents a <variable:filter> resource in the formula network.

Public classFilterCollection
The FilterCollection class represents a collection of Filter objects.
Public classForeverFilter

An ForeverFilter class represents a <pf:forever> filter resource in the formula linkbase.

Public classFormula

An Formula class represents a <formula:formula> resource in the formula linkbase.

Public classFormulaCollection
The FormulaCollection class represents a collection of Formula objects.
Public classFormulaProcessingSettings

The FormulaProcessingSettings class allows to modify the settings used to execute formulas.

Public classGeneralFilter

An GeneralFilter class represents a <gf:general> filter resource in the formula linkbase.

Public classGeneralMeasuresFilter

An GeneralMeasuresFilter class represents a <uf:generalMeasures> filter resource in the formula linkbase.

Public classGeneralVariable

An GeneralVariable class represents a <variable:generalVariable> resource in the formula network.

Public classIdentifierFilter

An IdentifierFilter class represents a <ef:identifier> filter resource in the formula linkbase.

Public classInstantDurationFilter

An InstantDurationFilter class represents a <pf:instantDuration> filter resource in the formula linkbase.

Public classLocationFilter

An LocationFilter class represents a <uf:locationFilter> filter resource in the formula linkbase.

Public classMatchConceptFilter

An MatchConceptFilter class represents a <mf:matchConcept> filter resource in the formula linkbase.

Public classMatchDimensionFilter

An MatchDimensionFilter class represents a <mf:matchDimension> filter resource in the formula linkbase.

Public classMatchEntityIdentifierFilter

An MatchEntityIdentifierFilter class represents a <mf:matchEntityIdentifier> filter resource in the formula linkbase.

Public classMatchLocationFilter

An MatchLocationFilter class represents a <mf:matchLocation> filter resource in the formula linkbase.

Public classMatchNonXdtScenarioFilter

An MatchNonXdtScenarioFilter class represents a <mf:matchNonXDTScenario> filter resource in the formula linkbase.

Public classMatchNonXdtSegmentFilter

An MatchNonXdtSegmentFilter class represents a <mf:matchNonXDTSegment> filter resource in the formula linkbase.

Public classMatchPeriodFilter

An MatchPeriodFilter class represents a <mf:matchPeriod> filter resource in the formula linkbase.

Public classMatchScenarioFilter

An MatchScenarioFilter class represents a <mf:matchScenario> filter resource in the formula linkbase.

Public classMatchSegmentFilter

An MatchSegmentFilter class represents a <mf:matchSegment> filter resource in the formula linkbase.

Public classMatchUnitFilter

An MatchUnitFilter class represents a <mf:matchUnit> filter resource in the formula linkbase.

Public classMessageExpansion

An MessageExpansion class represents a single expension of a validation message.

Public classMessageExpansionCollection
The MessageExpansionCollection class represents a collection of MessageExpansion objects.
Public classNilFilter

An NilFilter class represents a <vf:Nil> filter resource in the formula linkbase.

Public classOccEmptyRule

An OccEmptyRule class represents an empty OCC rule in a <formula:formula> or <table:table> resource.

Public classOccFragmentsRule

An OccFragmentsRule class represents a fragments OCC rule in a <formula:formula> or <table:table> resource.

Public classOccRule

An OccRule class represents an OCC rule in a <formula:formula> or <table:table> resource.

Public classOccRuleCollection
The OccRuleCollection class represents a collection of OccRule objects.
Public classOccXPathRule

An OccXPathRule class represents an XPath OCC rule in a <formula:formula> or <table:table> resource.

Public classOrFilter

An OrFilter class represents a <bf:orFilter> resource in the formula linkbase.

Public classParameter

An Parameter class represents a <variable:parameter> resource in the formula linkbase.

Public classParameterCollection
The ParameterCollection class represents a collection of Parameter objects.
Public classParameterValuesDictionary
The ParameterValuesDictionary class represents the user-specified values of formula parameters. It is implemented as a dictionary of parameter names (QName) to values (AnySimpleTypeList).
Public classParentFilter

An ParentFilter class represents a <tf:parentFilter> resource in the formula linkbase.

Public classParentFilterParentData

This class represents the <tf:parent> child element of a <tf:parentFilter> filter resource.

Public classPeriodEndFilter

An PeriodEndFilter class represents a <pf:periodEnd> filter resource in the formula linkbase.

Public classPeriodFilter

An PeriodFilter class represents a <pf:period> filter resource in the formula linkbase.

Public classPeriodInstantFilter

An PeriodInstantFilter class represents a <pf:periodInstant> filter resource in the formula linkbase.

Public classPeriodRule

An PeriodRule class represents a period rule in a <formula:formula> or <table:table> resource.

Public classPeriodRuleDurationData

An PeriodRuleDurationData class represents the <formula:duration> child element of a period rule.

Public classPeriodRuleForeverData

An PeriodRuleForeverData class represents the <formula:forever> child element of a period rule.

Public classPeriodRuleInstantData

An PeriodRuleInstantData class represents the <formula:instant> child element of a period rule.

Public classPeriodStartFilter

An PeriodStartFilter class represents a <pf:periodStart> filter resource in the formula linkbase.

Public classPrecisionFilter

An PrecisionFilter class represents a <vf:precision> filter resource in the formula linkbase.

Public classPrecondition

An Precondition class represents a <variable:precondition> resource in the formula linkbase.

Public classReferencedParameterCollection
The ReferencedParameterCollection class represents a collection of Parameter objects.
Public classRegexpIdentifierFilter

An RegexpIdentifierFilter class represents a <ef:regexpIdentifier> filter resource in the formula linkbase.

Public classRegexpSchemeFilter

An RegexpSchemeFilter class represents a <ef:regexpScheme> filter resource in the formula linkbase.

Public classRelativeFilter

An RelativeFilter class represents a <rf:relativeFilter> filter resource in the formula linkbase.

Public classScenarioFilter

An ScenarioFilter class represents a <ssf:scenario> filter resource in the formula linkbase.

Public classSegmentFilter

An SegmentFilter class represents a <ssf:segment> filter resource in the formula linkbase.

Public classSeverity

A Severity class represents a <sev:severity> resource in the formula linkbase.

Public classSiblingFilter

An SiblingFilter class represents a <uf:siblingFilter> filter resource in the formula linkbase.

Public classSingleMeasureFilter

An SingleMeasureFilter class represents a <uf:singleMeasure> resource in the formula linkbase.

Public classSingleMeasureFilterMeasureData

This class represents the <uf:measure> child element of a <uf:singleMeasure> filter resource.

Public classSpecificIdentifierFilter

An SpecificIdentifierFilter class represents a <ef:specificIdentifier> filter resource in the formula linkbase.

Public classSpecificSchemeFilter

An SpecificSchemeFilter class represents a <ef:specificScheme> filter resource in the formula linkbase.

Public classTypedDimensionFilter

An TypedDimensionFilter class represents a <df:typedDimension> filter resource in the formula linkbase.

Public classTypedDimensionRule

An TypedDimensionRule class represents a typed dimension rule in a <formula:formula> or <table:table> resource.

Public classUnitRule

An UnitRule class represents an unit rule in a <formula:formula> or <table:table> resource.

Public classUnitRuleDivideByData

This class represents the <formula:divideBy> child element of an unit rule.

Public classUnitRuleMultiplyByData

This class represents the <formula:multiplyBy> child element of an unit rule.

Public classUnitRuleDivideByCollection
Public classUnitRuleMultiplyByCollection
Public classValueAssertion

An ValueAssertion class represents a <va:valueAsertion> resource in the formula linkbase.

Public classVariable

An Variable class represents a <variable:variable> resource in the formula network.

Public classVariableFilterRelationship

An VariableFilterRelationship class represents a variable-filter relationship in the DTS network of relationships.

Public classVariableFilterRelationshipCollection
The VariableFilterRelationshipCollection class represents a collection of VariableFilterRelationship objects.
Public classVariableSet

An VariableSet class represents a <variable:variableSet> resource in the formula network.

Public classVariableSetAssertion

An VariableSetAssertion class represents a <validation:variableSetAsertion> resource in the formula linkbase.

Public classVariableSetFilterRelationship

An VariableSetFilterRelationship class represents a variable-set-filter relationship in the DTS network of relationships.

Public classVariableSetFilterRelationshipCollection
The VariableSetFilterRelationshipCollection class represents a collection of VariableSetFilterRelationship objects.
Public classVariableSetPreconditionRelationship

An VariableSetPreconditionRelationship class represents a variable-set-precondition relationship in the DTS network of relationships.

Public classVariableSetPreconditionRelationshipCollection
Public classVariableSetRelationship

An VariableSetRelationship class represents a variable-set relationship in the DTS network of relationships.

Public classVariableSetRelationshipCollection
The VariableSetRelationshipCollection class represents a collection of VariableSetRelationship objects.
Enumerations
  EnumerationDescription
Public enumerationAspectModel

The AspectModel enumeration is used to represent the aspectModel attribute on <variable:variableSet> resources.

Public enumerationAxisType

The AxisType enumeration defines the tree walk direction. See here for more details.

Public enumerationBoundary

The Boundary enumeration is used to represent the boundary attribute on <pf:instantDurationFilter> filter resources.

Public enumerationOccType

The OccType enumeration represents the type of the OCC rule.

Public enumerationPeriodRuleType

The PeriodRuleType enumeration determines how the RAV for the period rule is the calculated. See here for more details.

Public enumerationSeverityLevel

The SeverityLevel enumeration represents the value of the 'level' attribute on an <sev:severity> resource. See here for more details.

See Also