A eu.cdevreeze.tqa.base.relationship.DimensionalRelationship with arcrole "http://xbrl.org/int/dim/arcrole/all".
Calculation relationship.
Calculation relationship. Its underlying arc is of type eu.cdevreeze.tqa.base.dom.CalculationArc.
Concept-label relationship.
Concept-label relationship. Its underlying arc is of type eu.cdevreeze.tqa.base.dom.LabelArc.
Concept-reference relationship.
Concept-reference relationship. Its underlying arc is of type eu.cdevreeze.tqa.base.dom.ReferenceArc.
Standard concept-resource relationship.
Standard concept-resource relationship. Either an eu.cdevreeze.tqa.base.relationship.ConceptLabelRelationship, or a eu.cdevreeze.tqa.base.relationship.ConceptReferenceRelationship.
Default extractor of relationships from a "taxonomy base".
Default extractor of relationships from a "taxonomy base".
When choosing for lenient processing, XLink arcs may be broken in that the XLink labels are corrupt, and XLink locators may be broken in that the locator href URIs cannot be resolved. When choosing for strict processing, XLink arcs and locators may not be broken.
Lenient processing makes sense when the taxonomy base has not yet been validated. Strict processing makes sense when the taxonomy is XBRL valid, and we want to use that fact, for example when validating XBRL instances against it.
Definition relationship.
Definition relationship. Its underlying arc is of type eu.cdevreeze.tqa.base.dom.DefinitionArc.
A eu.cdevreeze.tqa.base.relationship.DimensionalRelationship with arcrole "http://xbrl.org/int/dim/arcrole/dimension-default".
A eu.cdevreeze.tqa.base.relationship.DimensionalRelationship with arcrole "http://xbrl.org/int/dim/arcrole/dimension-domain".
Dimensional definition relationship.
Either an eu.cdevreeze.tqa.base.relationship.DimensionDomainRelationship or a eu.cdevreeze.tqa.base.relationship.DomainMemberRelationship.
A eu.cdevreeze.tqa.base.relationship.DimensionalRelationship with arcrole "http://xbrl.org/int/dim/arcrole/domain-member".
A eu.cdevreeze.tqa.base.relationship.NonStandardRelationship with arcrole "http://xbrl.org/arcrole/2008/element-label".
A eu.cdevreeze.tqa.base.relationship.NonStandardRelationship whose target is a msg:message element.
A eu.cdevreeze.tqa.base.relationship.NonStandardRelationship with arcrole "http://xbrl.org/arcrole/2008/element-reference".
Either an eu.cdevreeze.tqa.base.relationship.ElementLabelRelationship or an eu.cdevreeze.tqa.base.relationship.ElementReferenceRelationship.
A eu.cdevreeze.tqa.base.relationship.DefinitionRelationship with arcrole "http://www.xbrl.org/2003/arcrole/essence-alias".
A eu.cdevreeze.tqa.base.relationship.DefinitionRelationship with arcrole "http://www.xbrl.org/2003/arcrole/general-special".
Either an eu.cdevreeze.tqa.base.relationship.AllRelationship or a eu.cdevreeze.tqa.base.relationship.NotAllRelationship.
A eu.cdevreeze.tqa.base.relationship.DimensionalRelationship with arcrole "http://xbrl.org/int/dim/arcrole/hypercube-dimension".
Standard inter-concept relationship.
Standard inter-concept relationship. Either an eu.cdevreeze.tqa.base.relationship.DefinitionRelationship, eu.cdevreeze.tqa.base.relationship.PresentationRelationship, or a eu.cdevreeze.tqa.base.relationship.CalculationRelationship.
Inter-concept relationship path.
Inter-concept relationship path. Subsequent relationships in the path must match in target and source concept, respectively. It is not required that the arc role remains the same, or that targetRole attributes are followed, although in practice this will be the case. A relationship path must have at least one relationship.
In practice, inter-concept relationship paths are "ELR-valid", that is, their relationships are in the same ELR, or, in the case of dimensional relationship paths, their relationships are consecutive relationships.
The non-exempt attributes in a relationship key.
The non-exempt attributes in a relationship key. It is designed for (fast) value equality, thus supporting fast value equality for relationship keys.
Equality of non-exempt attributes is sensitive. Why?
Non-standard relationship.
Non-standard relationship. Typically a generic relationship.
Non-standard relationship path.
Non-standard relationship path. Subsequent relationships in the path must match in target and source XML element (key), respectively. It is not required that the arc role remains the same, or that ELRs remain the same, although in practice the latter will be the case. A relationship path must have at least one relationship.
In practice, non-standard relationship paths are "ELR-valid", that is, their relationships are in the same ELR.
A eu.cdevreeze.tqa.base.relationship.DimensionalRelationship with arcrole "http://xbrl.org/int/dim/arcrole/notAll".
A eu.cdevreeze.tqa.base.relationship.NonStandardRelationship not falling in the other categories of non-standard relationships.
A eu.cdevreeze.tqa.base.relationship.PresentationRelationship with arcrole "http://www.xbrl.org/2003/arcrole/parent-child".
Presentation relationship.
Presentation relationship. Its underlying arc is of type eu.cdevreeze.tqa.base.dom.PresentationArc.
Any relationship.
Any relationship. Relationships are like their underlying arcs, but resolving the locators. Note that an underlying arc may represent more than 1 relationship.
These objects must be very efficient to create.
Like for the underlying taxonomy elements, relationship creation is designed not to fail, but the type may be of an unexpected "catch-all relationship type". There is an exception to this leniency, though, and that is that each arc must have an XLink arcole attribute, or else an exception is thrown. This can be circumvented in practice by using an arc filter when instantiating a taxonomy object.
Unlike relationship creation (with the missing arcrole exception), instance methods on relationships may fail, however.
This relationship type hierarchy knows about standard relationships, including dimensional relationships. It also knows about a few specific generic relationships. It does not know about table and formula relationships, which are only seen as non-standard or unknown relationships.
Each relationship is either a eu.cdevreeze.tqa.base.relationship.StandardRelationship, a eu.cdevreeze.tqa.base.relationship.NonStandardRelationship, or an eu.cdevreeze.tqa.base.relationship.UnknownRelationship.
Extractor of relationships from a "taxonomy base".
Relationship key.
Relationship key. It has been designed for value equality.
Relationships are equivalent if they have the same relationship key. Prohibition/overriding resolution is performed on equivalent relationships. After prohibition/overriding resolution, the remaining relationships form networks of relationships, one network per base set key.
A eu.cdevreeze.tqa.base.relationship.DefinitionRelationship with arcrole "http://www.xbrl.org/2003/arcrole/requires-element".
Resolved locator or resource.
Resolved locator or resource. This can act as the resolved "from" or "to" side of a relationship.
It holds both the XLink locator or XLink resource and the resolved element. Sub-type ResolvedLocatorOrResource.Locator
is used for resolved XLink locators, and sub-type ResolvedLocatorOrResource.Resource
is used for XLink resources, where
the XLink resource and its "resolution" are one and the same element.
A "remote resource" (XLink locator to an XLink resource) is a specific Locator
where the
resolved element type is an XLink resource type.
These objects must be very efficient to create, in order to make relationship creation fast.
A eu.cdevreeze.tqa.base.relationship.DefinitionRelationship with arcrole "http://www.xbrl.org/2003/arcrole/similar-tuples".
Standard relationship.
Standard relationship. Either an eu.cdevreeze.tqa.base.relationship.InterConceptRelationship or a eu.cdevreeze.tqa.base.relationship.ConceptResourceRelationship.
A eu.cdevreeze.tqa.base.relationship.CalculationRelationship with arcrole "http://www.xbrl.org/2003/arcrole/summation-item".
Typed attribute value, as used in the non-exempt attributes in a relationship key.
Typed attribute value, as used in the non-exempt attributes in a relationship key. The sub-classes are designed for value equality.
See http://www.xbrl.org/Specification/XBRL-2.1/REC-2003-12-31/XBRL-2.1-REC-2003-12-31+corrected-errata-2013-02-20.html#_4.10.
Unknown relationship, so a relationship that is neither a standard nor a non-standard relationship.
Unknown relationship, so a relationship that is neither a standard nor a non-standard relationship. It may be an invalid relationship.
This package contains relationships. Relationships are like their underlying arcs, but resolving the locators. Note that an arc may represent more than 1 relationship.
This package mainly contains:
Relationship factories extract relationships from a eu.cdevreeze.tqa.base.dom.TaxonomyBase. They can be used directly, but typically they are used implicitly when creating a eu.cdevreeze.tqa.base.taxonomy.BasicTaxonomy.
This package has no knowledge about and dependency on XPath processing.
For the usage of this API, see packages eu.cdevreeze.tqa.base.queryapi and eu.cdevreeze.tqa.base.taxonomy.
This package unidirectionally depends on the eu.cdevreeze.tqa.base.dom package.