Class/Object

eu.cdevreeze.tqa.base.relationship

DefaultRelationshipFactory

Related Docs: object DefaultRelationshipFactory | package relationship

Permalink

final class DefaultRelationshipFactory extends RelationshipFactory

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.

Linear Supertypes
RelationshipFactory, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultRelationshipFactory
  2. RelationshipFactory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultRelationshipFactory(config: Config)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def computeNetworks(relationships: IndexedSeq[Relationship], taxonomyBase: TaxonomyBase): Map[BaseSetKey, NetworkComputationResult]

    Permalink

    Returns the networks of relationships, computed from the given collection of relationships.

    Returns the networks of relationships, computed from the given collection of relationships. The TaxonomyBase is passed as second parameter.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  7. val config: Config

    Permalink

    The configuration used by this RelationshipFactory.

    The configuration used by this RelationshipFactory.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def extractRelationships(taxonomyBase: TaxonomyBase, arcFilter: (XLinkArc) ⇒ Boolean): IndexedSeq[Relationship]

    Permalink

    Returns all relationships in the given TaxonomyBase passing the provided arc filter.

    Returns all relationships in the given TaxonomyBase passing the provided arc filter.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  11. def extractRelationshipsFromArc(arc: XLinkArc, labeledXlinkMap: Map[String, IndexedSeq[LabeledXLink]], taxonomyBase: TaxonomyBase): IndexedSeq[Relationship]

    Permalink

    Returns all relationships (typically one) having the given underlying XLink arc in the given TaxonomyBase.

    Returns all relationships (typically one) having the given underlying XLink arc in the given TaxonomyBase. For performance a mapping from XLink labels to XLink locators and resources must be provided, and this mapping should be computed only once per extended link.

    This method must respect the configuration of this RelationshipFactory.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  12. def extractRelationshipsFromDocument(docUri: URI, taxonomyBase: TaxonomyBase, arcFilter: (XLinkArc) ⇒ Boolean): IndexedSeq[Relationship]

    Permalink

    Returns all relationships in the given document in the given TaxonomyBase passing the provided arc filter.

    Returns all relationships in the given document in the given TaxonomyBase passing the provided arc filter.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  13. def extractRelationshipsFromExtendedLink(extendedLink: ExtendedLink, taxonomyBase: TaxonomyBase, arcFilter: (XLinkArc) ⇒ Boolean): IndexedSeq[Relationship]

    Permalink

    Returns all relationships in the given extended link in the given TaxonomyBase passing the provided arc filter.

    Returns all relationships in the given extended link in the given TaxonomyBase passing the provided arc filter.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def getRelationshipKey(relationship: Relationship, taxonomyBase: TaxonomyBase): RelationshipKey

    Permalink

    Gets the key of the relationship that is the same (only) for equivalent relationships.

    Gets the key of the relationship that is the same (only) for equivalent relationships.

    Definition Classes
    DefaultRelationshipFactory → RelationshipFactory

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RelationshipFactory

Inherited from AnyRef

Inherited from Any

Ungrouped