RAMEN Core
    Preparing search index...

    Class RamenAdvisor

    Adds RAMEN annotation suggestions to the generic modelling advisor.

    Hierarchy (View Summary)

    Index
    • Finds one selected node that refines every other selected node.

      Parameters

      • modelId: string
      • refs: readonly string[]

      Returns NodeLineageItem | undefined

      When a selected node reference cannot be resolved.

    • Lists properties available for one annotation shape, including its own declarations.

      Parameters

      • modelId: string
      • nodeId: string
      • type: string

      Returns readonly PropertyOption[]

    • Lists existing relationships with exactly these endpoint types, including permitted predecessor definitions. Returns an empty list when no relationship matches. Unknown nodes are invalid inputs. Does not create relationships or choose between parallel definitions.

      Parameters

      • modelId: string
      • from: string
      • to: string

      Returns readonly RelationSelection[]

    • Lists the modelled relations permitted by one effective annotation shape.

      Parameters

      • modelId: string
      • annotationNodeId: string
      • type: string

      Returns readonly RelationOption[]

    • Lists valid property, relation, target and cardinality options for a new annotation definition.

      Parameters

      • modelId: string
      • annotationNodeId: string

      Returns AnnotationShapeOptions | undefined

    • Lists all reachable annotations, or only the effective variants of one Annotation node.

      Parameters

      • modelId: string
      • OptionalannotationNodeId: string

      Returns readonly AnnotationShapeSuggestion[]

    • Lists effective annotation variants attachable to one local or imported node through modelled relations.

      Parameters

      • modelId: string
      • nodeId: string
      • OptionalannotationNodeId: string

      Returns readonly AnnotationShapeSuggestion[]

    • Lists local and permitted predecessor relations compatible with both selected node types.

      Parameters

      • modelId: string
      • fromNodeId: string
      • toNodeId: string

      Returns readonly RelationSuggestion[]