java.lang.Object
com.dassault_systemes.modeler.kerml.model.Flows

@OpenApiAll public class Flows extends Object
Utility class to work with Flow
  • Constructor Details

    • Flows

      public Flows()
  • Method Details

    • getSourceFlowEnd

      @CheckForNull public static Feature getSourceFlowEnd(Flow flow)
      Returns the source end feature of the given flow.
      Parameters:
      flow - the flow
      Returns:
      source flow end, or null if not present
    • getTargetFlowEnd

      @CheckForNull public static Feature getTargetFlowEnd(Flow flow)
      Returns the target end feature of the given flow.
      Parameters:
      flow - the flow
      Returns:
      target flow end, or null if not present
    • getFirstOwnedFeature

      @CheckForNull public static Feature getFirstOwnedFeature(Feature end)
      Returns the first owned feature of the given flow end.
      Parameters:
      end - the flow end
      Returns:
      first owned feature, or null
    • getRedefinedFeature

      @CheckForNull public static Feature getRedefinedFeature(Feature end)
      Returns the redefined feature of the given flow end.
      Parameters:
      end - the flow end
      Returns:
      redefined feature, or null
    • setRedefinedSourceOutputFeature

      public static boolean setRedefinedSourceOutputFeature(Flow flow, @CheckForNull Feature feature)
      Sets the redefined source output feature of the flow.
      Parameters:
      flow - the flow
      feature - feature to redefine to, or null
      Returns:
      always true
    • getRedefinedSourceOutputFeature

      @CheckForNull public static Feature getRedefinedSourceOutputFeature(Flow flow)
      Returns the redefined source output feature of the flow.
      Parameters:
      flow - the flow
      Returns:
      redefined feature, or null
    • setRedefinedTargetInputFeature

      public static boolean setRedefinedTargetInputFeature(Flow flow, @CheckForNull Feature feature)
      Sets the redefined target input feature of the flow.
      Parameters:
      flow - the flow
      feature - feature to redefine to, or null
      Returns:
      always true
    • getRedefinedTargetInputFeature

      @CheckForNull public static Feature getRedefinedTargetInputFeature(Flow flow)
      Returns the redefined target input feature of the flow.
      Parameters:
      flow - the flow
      Returns:
      redefined feature, or null
    • setRedefinedFeature

      public static void setRedefinedFeature(int endIndex, Flow flow, @CheckForNull Feature feature)
      Sets or clears the redefined feature for the given flow end.
      Parameters:
      endIndex - index of the flow end
      flow - the flow
      feature - feature to redefine to, or null to remove
    • isMessage

      public static boolean isMessage(Flow type)
      Checks whether the flow represents a message.
      Parameters:
      type - the flow
      Returns:
      true if the flow has no end features
    • isFlowEnd

      public static boolean isFlowEnd(Feature feature)
      Checks whether the given feature is a flow end.
      Parameters:
      feature - the feature
      Returns:
      true if the feature is a flow end
    • refactorFromShorthandNotationToFullNotation

      public static void refactorFromShorthandNotationToFullNotation(Flow flow)
      Converts shorthand flow notation to full notation for all end features.
      Parameters:
      flow - the flow
    • refactorFromFullNotationToShorthandNotation

      public static void refactorFromFullNotationToShorthandNotation(Flow flow)
      Converts full flow notation to shorthand notation for all end features.
      Parameters:
      flow - the flow