Package org.apache.juneau.console

Class Topics

java.lang.Object
org.apache.juneau.console.Topics
public final class Topics extends Object
Builds framework topic names so callers do not hand-format "family:key" strings.
Example:

Topics.selection("changes"); // "selection:changes" Topics.cmd("tasks"); // "cmd:tasks" Topics.job(ref.id()); // "job:j-91"

Since:
10.0.0

  • Field Details

    • FRAMEWORK_FAMILIES

      public static final Set<String> FRAMEWORK_FAMILIES
      The framework families, in the order JuneauViews.bus.FRAMEWORK_FAMILIES lists them (pinned by a test).

    • ID

      public static final Pattern ID
      The card and dashboard-section id grammar ($defs/id in the page schema).

  • Method Details

    • card

      public static String card(String cardId)
      Parameters:
      cardId - The card id. @return card:<cardId>.

    • selection

      public static String selection(String cardId)
      Parameters:
      cardId - The card id. @return selection:<cardId>.

    • filter

      public static String filter(String cardId)
      Parameters:
      cardId - The card id. @return filter:<cardId>.

    • redraw

      public static String redraw(String cardId)
      Parameters:
      cardId - The card id. @return redraw:<cardId>.

    • detail

      public static String detail(String cardId)
      Parameters:
      cardId - The card id. @return detail:<cardId>.

    • bulk

      public static String bulk(String cardId)
      Parameters:
      cardId - The card id. @return bulk:<cardId>.

    • cmd

      public static String cmd(String cardId)
      Parameters:
      cardId - The card id. @return cmd:<cardId>.

    • probe

      public static String probe(String groupId)
      Parameters:
      groupId - The probe group id. @return probe:<groupId>.

    • job

      public static String job(String jobId)
      Parameters:
      jobId - The async job id. @return job:<jobId>.

    • badge

      public static String badge(String badgeId)
      Parameters:
      badgeId - The badge id. @return badge:<badgeId>.

    • bridge

      public static String bridge(String bridgeId)
      Parameters:
      bridgeId - The bridge id. @return bridge:<bridgeId>.

    • data

      public static String data(String source)
      Parameters:
      source - The data source name. @return data:<source>.

    • zoom

      public static String zoom(String cardId)
      Parameters:
      cardId - The chart card id. @return zoom:<cardId>.

    • legend

      public static String legend(String cardId)
      Parameters:
      cardId - The chart card id. @return legend:<cardId>.

    • custom

      public static String custom(String ns, String name)
      Parameters:
      ns - The namespace, for example ssc.
      name - The name within it, for example focus.
      Returns:
      ns.name.
      Throws:
      IllegalArgumentException - E-45 when ns is blank; E-40 when a part is malformed.

    • custom

      public static String custom(String ns, String name, String key)
      Parameters:
      ns - The namespace.
      name - The name within it.
      key - The key, or * for a declaration pattern.
      Returns:
      ns.name:key.
      Throws:
      IllegalArgumentException - E-45 / E-40 as for custom(String, String), or E-40 on a bad key.

    • isKey

      public static boolean isKey(String key)
      Tests the topic-key grammar (the part after family:).
      Parameters:
      key - The key, or null.
      Returns:
      true if key is a valid topic key.