Package se.conciliate.extensions.type

Interface EdgeType

All Superinterfaces:
Type
public interface EdgeType extends Type
Encapsulates an edge type.
Author:
Per-Erik

  • Method Details

    • getForwardName

      String getForwardName()
      Returns the name of the relation in the forward direction. For example, for an edge of type "FLOW" this could return "Flow to". If the edge goes from symbol A to symbol B, when showing information about A we can say "Flow to B".
      Returns:
      The name for the edge in the forward direction. The return value should take the current locale into account if translations are available.

    • getForwardName

      String getForwardName(Locale locale)

    • getReverseName

      String getReverseName()
      Returns the name of the relation in the reverse direction. For example, for an edge of type "FLOW" this could return "Flow from". If the edge goes from symbol A to symbol B, when showing information about B we can say "Flow from A". Note: If getReverseType does not return null then this method should return the "forward" name of the "reverse" type.
      Returns:
      The name for the edge in the reverse direction. The return value should take the current locale into account if translations are available.

    • getReverseName

      String getReverseName(Locale locale)

    • getReverseType

      EdgeType getReverseType()
      This lets the edge type define itself as the "reverse" of another edge type. For example, if a symbol "consists of" another symbol then this other symbol "is a part of" the first symbol, even though the actual type of the edge is "consists of".
      Returns:
      The reverse type or null

    • getDescription

      default Optional<String> getDescription()
      Returns an optional description for the type. If present it should describe the purpose and usage of the edge type.
      Returns:
      An optional description. The description can be formatted as html but should not include the start and end <html> tags. Any line-breaks will be automatically converted to
      tags.