Package com.apama.dashboard

Interface IDashboardContext

  • public interface IDashboardContext
    IDashboardContext is an interface to an instance of a dashboard or dashboard panel. It provides methods for setting and getting the value of substitutions in the dashboard or dashboard panel.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getSubstitutionValue​(java.lang.String name)
      Get the value of a substitution provided by the name parameter.
      java.lang.String setLocalVariable​(java.lang.String name, java.lang.String value)
      Set a single local variable value.
      void setSubstitution​(java.lang.String name, java.lang.String value, boolean triggerUpdate)
      Set the value of a single dashboard substitution.
      void setSubstitutions​(java.util.Vector<java.lang.String> names, java.util.Vector<java.lang.String> values, boolean triggerUpdate)
      Set multiple dashboard substitutions.

    • Method Detail

      • setSubstitution

        void setSubstitution​(java.lang.String name,
                     java.lang.String value,
                     boolean triggerUpdate)
        Set the value of a single dashboard substitution. If the substitution is not defined it will be added.

        If the substitution is used in an attachment then triggerUpdate must be true. If the substitution is only used as a parameter to a command then triggerUpdate should be false. Not updating objects attached to a substitution can improve performance.
        Parameters:
        name - Name of the substitution.
        value - Value for the substitution.
        triggerUpdate - True if objects attached to the substitution are to be updated.

      • setSubstitutions

        void setSubstitutions​(java.util.Vector<java.lang.String> names,
                      java.util.Vector<java.lang.String> values,
                      boolean triggerUpdate)
        Set multiple dashboard substitutions. Setting multiple substitutions at once has better performance then setting each individually. If a substitution is not defined it will be added.

        If one or more of the substitutions are used in an attachment then triggerUpdate must be true. If each substitution is only used as a parameter to a command then triggerUpdate should be false. Not updating objects attached to a substitution can improve performance.
        Parameters:
        names - List of substitution names.
        values - List of substitution values.
        triggerUpdate - True if objects attached to the substitution are to be updated.

      • getSubstitutionValue

        java.lang.String getSubstitutionValue​(java.lang.String name)
        Get the value of a substitution provided by the name parameter. If name is null, empty string, or the name is an undefined substitution, then empty string will be returned. Otherwise, the current value of the substitution with the provided name will be returned.
        Parameters:
        name - of the substitution.
        Returns:
        value of substitution.

      • setLocalVariable

        java.lang.String setLocalVariable​(java.lang.String name,
                                  java.lang.String value)
        Set a single local variable value. If the variable doesn't exist, it will be added. If the local var has already been initialized, nothing will be done. That existing value will be returned
        Parameters:
        name - of the local variable
        value - to be used for the variable
        Returns:
        the current value of the local var, or the param value if local var hasn't been initialized yet