Package se.conciliate.extensions.store

Interface MTEdgeHeader

All Superinterfaces:
Comparable<MTNamedObject>, MTNamedObject
All Known Subinterfaces:
MTCompleteEdge, MTEdge
public interface MTEdgeHeader extends MTNamedObject
Header interface for edges. An edge defines a relation between two symbols (represented by vertices) in a model. Graphically it is displayed as an arrow defined by a list of control points and with appearance according to the type of the relation.
Since:
3.0

  • Method Details

    • getType

      EdgeType getType()
      Returns this edge's EdgeType, or null if no suitable type is found.
      Returns:
      this edge's EdgeType, or null if no suitable type is found.

    • getTypeID

      String getTypeID()
      Returns the type of this edge.
      Returns:
      The edge type.
      Since:
      3.0

    • getStrokeColor

      Color getStrokeColor()
      Returns the stroke color for the edge. This will only be used if the edge has stroke set.
      Returns:
      The stroke color for the edge.

    • getStroke

      BasicStroke getStroke()
      Returns the stroke for the edge. This will override any stroke settings specified in the currently used color scheme for this edge. It is up to the @code{Drawable} implementation used to draw the edge whether to use this stroke. There might be edge routers implemented where a stroke makes no sense when drawing the edge, in which this settings may be ignored.
      Returns:
      The stroke for the edge or null if the edge has no stroke set.

    • getRawTitle

      String getRawTitle(MTLanguageHeader lang)
      Returns the raw title in the given language. A raw title may include special characters that are not included in #getTitle, such as the soft hyphen character. This method should be used to get the title including its "formatting hints".
      Parameters:
      lang - The language to get the title for.
      Returns:
      The raw, "unformatted", title of the edge.

    • getRawTitle

      String getRawTitle()
      Returns the raw title. A raw title may include special characters that are not included in #getTitle, such as the soft hyphen character. This method should be used to get the title including its "formatting hints".
      Returns:
      The raw, "unformatted", title of the edge.

    • getFromSymbolID

      long getFromSymbolID()
      Returns the ID of the symbol that this edge starts at.
      Returns:
      The ID of the symbol that this edge starts at.
      Since:
      3.0

    • getToSymbolID

      long getToSymbolID()
      Returns the ID of the symbol that this edge ends at.
      Returns:
      The ID of the symbol that this edge ends at.
      Since:
      3.0

    • getModelID

      long getModelID()
      Returns the ID of the model that this edge is placed in.
      Returns:
      The ID of the model that this edge is placed in.
      Since:
      3.x

    • expand

      MTEdge expand() throws MTAccessException
      Returns a MTEdge for this edge. Beware that this might require querying the storage layer for more data.
      Returns:
      A MTStatus representing this edge.
      Throws:
      MTAccessException - If an MTAccessException occurs.
      Since:
      3.0

    • findBreakdowns

      List<MTModel> findBreakdowns() throws MTAccessException
      Finds all models that this edge breaks down to in the current workspace.
      Returns:
      All models that this edge breaks down to in the current workspace.
      Throws:
      MTAccessException - If an MTAccessException occurs.
      Since:
      3.0

    • findBreakdownHeaders

      List<MTModelHeader> findBreakdownHeaders() throws MTAccessException
      Finds all models that this edge breaks down to in the current workspace, as headers.
      Returns:
      All models that this edge breaks down to in the current workspace.
      Throws:
      MTAccessException - If an MTAccessException occurs.
      Since:
      3.0

    • isTranslated

      boolean isTranslated()
      Returns true if the edge is translated in every language.
      Returns:
      true if translated.
      Since:
      3.1

    • isTranslated

      boolean isTranslated(MTLanguage lang)
      Returns true if the edge is marked as translated in the given language. If lang is the current default language true is always returned.
      Parameters:
      lang - the language to check for translation
      Returns:
      true if translated
      Since:
      3.1

    • isHideArrows

      boolean isHideArrows()
      Returns true if the arrow(s) should not be shown for this edge.
      Returns:
      true if no arrows should be drawn.
      Since:
      3.1