Trait

eu.cdevreeze.tqa.base.queryapi

InterConceptRelationshipContainerApi

Related Doc: package queryapi

Permalink

trait InterConceptRelationshipContainerApi extends AnyRef

Purely abstract trait offering an inter-concept relationship query API.

Implementations should make sure that looking up relationships by source (or target) EName is fast.

Implementations may be strict or lenient in enforced requirements on the relationship container.

For some of the graph theory terms used, see http://artint.info/html/ArtInt_50.html.

Linear Supertypes
AnyRef, Any
Known Subclasses
BasicTaxonomy, InterConceptRelationshipContainerLike, TaxonomyApi, TaxonomyLike
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InterConceptRelationshipContainerApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def filterIncomingConsecutiveInterConceptRelationshipPaths[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Calls method filterIncomingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Calls method filterIncomingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Typically this method should be preferred over method filterIncomingUnrestrictedInterConceptRelationshipPaths.

  2. abstract def filterIncomingInterConceptRelationships(targetConcept: EName)(p: (InterConceptRelationship) ⇒ Boolean): IndexedSeq[InterConceptRelationship]

    Permalink

    Filters inter-concept relationships that are incoming to the given concept.

  3. abstract def filterIncomingInterConceptRelationshipsOfType[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

    Filters inter-concept relationships of the given type that are incoming to the given concept.

  4. abstract def filterIncomingUnrestrictedInterConceptRelationshipPaths[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Filters the inter-concept relationship paths that are incoming to the given concept and whose relationships are of the given type.

    Filters the inter-concept relationship paths that are incoming to the given concept and whose relationships are of the given type. Only relationship paths for which all (non-empty) "tails" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    This method can be useful for finding relationship paths that are not consecutive and therefore not allowed, when we do not yet know that the taxonomy is XBRL-valid.

    This is a very general method that is used to implement specific methods in more specific relationship query API traits. Typically prefer method filterIncomingConsecutiveInterConceptRelationshipPaths instead.

  5. abstract def filterInterConceptRelationships(p: (InterConceptRelationship) ⇒ Boolean): IndexedSeq[InterConceptRelationship]

    Permalink

  6. abstract def filterInterConceptRelationshipsOfType[A <: InterConceptRelationship](relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

  7. abstract def filterOutgoingConsecutiveInterConceptRelationshipPaths[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Calls method filterOutgoingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Calls method filterOutgoingUnrestrictedInterConceptRelationshipPaths, adding sub-predicate isConsecutiveRelationshipPath to the relationship path predicate.

    Typically this method should be preferred over method filterOutgoingUnrestrictedInterConceptRelationshipPaths.

  8. abstract def filterOutgoingInterConceptRelationships(sourceConcept: EName)(p: (InterConceptRelationship) ⇒ Boolean): IndexedSeq[InterConceptRelationship]

    Permalink

    Filters inter-concept relationships that are outgoing from the given concept.

  9. abstract def filterOutgoingInterConceptRelationshipsOfType[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (A) ⇒ Boolean): IndexedSeq[A]

    Permalink

    Filters inter-concept relationships of the given type that are outgoing from the given concept.

  10. abstract def filterOutgoingUnrestrictedInterConceptRelationshipPaths[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A])(p: (InterConceptRelationshipPath[A]) ⇒ Boolean): IndexedSeq[InterConceptRelationshipPath[A]]

    Permalink

    Filters the inter-concept relationship paths that are outgoing from the given concept and whose relationships are of the given type.

    Filters the inter-concept relationship paths that are outgoing from the given concept and whose relationships are of the given type. Only relationship paths for which all (non-empty) "inits" pass the predicate are accepted by the filter! The relationship paths are as long as possible, but on encountering a cycle in a path it stops growing.

    This method can be useful for finding relationship paths that are not consecutive and therefore not allowed, when we do not yet know that the taxonomy is XBRL-valid.

    This is a very general method that is used to implement specific methods in more specific relationship query API traits. Typically prefer method filterOutgoingConsecutiveInterConceptRelationshipPaths instead.

  11. abstract def findAllConsecutiveInterConceptRelationshipsOfType[A <: InterConceptRelationship](relationship: InterConceptRelationship, resultRelationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all "following" ("consecutive") inter-concept relationships of the given result type.

    Finds all "following" ("consecutive") inter-concept relationships of the given result type.

    Two relationships "follow" each other if method InterConceptRelationship.isFollowedBy says so.

    Note that for non-dimensional relationships this implies that the parameter and result relationship types must be the same, or else no relationships are returned.

    This method is shorthand for:

    filterOutgoingInterConceptRelationshipsOfType(relationship.targetConceptEName, resultRelationshipType) { rel =>
  relationship.isFollowedBy(rel)
}

  12. abstract def findAllIncomingInterConceptRelationships(targetConcept: EName): IndexedSeq[InterConceptRelationship]

    Permalink

    Finds all inter-concept relationships that are incoming to the given concept.

  13. abstract def findAllIncomingInterConceptRelationshipsOfType[A <: InterConceptRelationship](targetConcept: EName, relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all inter-concept relationships of the given type that are incoming to the given concept.

  14. abstract def findAllInterConceptRelationships: IndexedSeq[InterConceptRelationship]

    Permalink

  15. abstract def findAllInterConceptRelationshipsOfType[A <: InterConceptRelationship](relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

  16. abstract def findAllOutgoingInterConceptRelationships(sourceConcept: EName): IndexedSeq[InterConceptRelationship]

    Permalink

    Finds all inter-concept relationships that are outgoing from the given concept.

  17. abstract def findAllOutgoingInterConceptRelationshipsOfType[A <: InterConceptRelationship](sourceConcept: EName, relationshipType: ClassTag[A]): IndexedSeq[A]

    Permalink

    Finds all inter-concept relationships of the given type that are outgoing from the given concept.

Concrete 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. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped