Package org.knime.core.ui.workflowcoach.data

Interface NodeTripleProvider

All Known Subinterfaces:
UpdatableNodeTripleProvider
public interface NodeTripleProvider
Class that provides triples of nodes and their count. The statistics of node triples are used to generate NodeRecommendationManager.NodeRecommendations, e.g. based on a currently selected node. Those recommendations are displayed in a table within the workflow coach UI thats currently active.
Author:
Martin Horn, University of Konstanz

  • Field Details

    • LAST_UPDATE_FORMAT

      static final DateTimeFormatter LAST_UPDATE_FORMAT
      A common date format for the last update timestamp.

  • Method Details

    • getName

      String getName()
      Returns:
      a name for the provider (that will, e.g., appear in the header of the frequency column in the node recommendation table

    • getDescription

      String getDescription()
      A short description of the node triple provide, e.g. where it is generated from etc. It appears, e.g. as tool tip of the frequency column header.
      Returns:
      the description

    • isEnabled

      boolean isEnabled()
      Returns:
      whether the triple provider is enabled. This is usually configured by the user via the provider's preference page

    • getNodeTriples

      Stream<org.knime.core.node.NodeTriple> getNodeTriples() throws IOException
      Returns all available NodeTriples as a Stream.
      Returns:
      a stream of all NodeTriples
      Throws:
      IOException - a possible exception thrown usually when something went wrong to access the underlying source of the node triples (e.g. a corrupt file)

    • getLastUpdate

      Optional<LocalDateTime> getLastUpdate()
      Returns the time when this provider was last updated. If the provider hasn't been updated at all (i.e. its data is missing) then an empty optional is returned.
      Returns:
      the last update time or an empty optional