Package org.eclipse.tracecompass.tmf.ui.project.model

Class TmfAnalysisElement

java.lang.Object
org.eclipse.tracecompass.tmf.ui.project.model.TmfProjectModelElement
org.eclipse.tracecompass.tmf.ui.project.model.TmfAnalysisElement
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, ITmfProjectModelElement, ITmfStyledProjectModelElement, org.eclipse.ui.views.properties.IPropertySource, org.eclipse.ui.views.properties.IPropertySource2
Direct Known Subclasses:
TmfAggregateAnalysisElement
public class TmfAnalysisElement extends TmfProjectModelElement implements ITmfStyledProjectModelElement, org.eclipse.ui.views.properties.IPropertySource2
Class for project elements of type analysis modules
Since:
2.0
Author:
Geneviève Bastien

  • Method Details

    • getParent

      public TmfViewsElement getParent()
      Description copied from interface: ITmfProjectModelElement
      Returns the parent of this model element.
      Specified by:
      getParent in interface ITmfProjectModelElement
      Overrides:
      getParent in class TmfProjectModelElement
      Returns:
      the parent of this model element.
      Since:
      2.0

    • getIcon

      public org.eclipse.swt.graphics.Image getIcon()
      Description copied from interface: ITmfProjectModelElement
      Returns the icon of this element.
      Specified by:
      getIcon in interface ITmfProjectModelElement
      Returns:
      The icon
      Since:
      2.0

    • getStyler

      public org.eclipse.jface.viewers.StyledString.Styler getStyler()
      Description copied from interface: ITmfStyledProjectModelElement
      Return the styler who will apply its style to the text string.
      Specified by:
      getStyler in interface ITmfStyledProjectModelElement
      Returns:
      The style object, or 'null' for no special style

    • getAvailableOutputs

      public List<TmfAnalysisOutputElement> getAvailableOutputs()
      Get the list of analysis output model elements under this analysis
      Returns:
      Array of analysis output elements

    • getAnalysisId

      public String getAnalysisId()
      Gets the analysis id of this module
      Returns:
      The analysis id

    • getHelpMessage

      public String getHelpMessage()
      Gets the help message for this analysis
      Returns:
      The help message

    • getIconFile

      public String getIconFile()
      Gets the icon file name for the analysis
      Returns:
      The analysis icon file name

    • getBundle

      public org.osgi.framework.Bundle getBundle()
      Gets the bundle this analysis is from
      Returns:
      The analysis bundle

    • activateParentTrace

      public void activateParentTrace()
      Make sure the trace this analysis is associated to is the currently selected one
      Since:
      2.0

    • canExecute

      public boolean canExecute()
      Checks whether the analysis can be executed or not.
      Returns:
      true if analysis can be executed else false
      Since:
      3.0

    • scheduleAnalysis

      public org.eclipse.core.runtime.IStatus scheduleAnalysis()
      Schedule an analysis
      Returns:
      the status of the analysis scheduling
      Since:
      5.2

    • getEditableValue

      public Object getEditableValue()
      Specified by:
      getEditableValue in interface org.eclipse.ui.views.properties.IPropertySource
      Since:
      2.0

    • getPropertyDescriptors

      public org.eclipse.ui.views.properties.IPropertyDescriptor[] getPropertyDescriptors()
      Specified by:
      getPropertyDescriptors in interface org.eclipse.ui.views.properties.IPropertySource
      Since:
      2.0

    • getPropertyValue

      public Object getPropertyValue(Object id)
      Specified by:
      getPropertyValue in interface org.eclipse.ui.views.properties.IPropertySource
      Since:
      2.0

    • resetPropertyValue

      public final void resetPropertyValue(Object id)
      Specified by:
      resetPropertyValue in interface org.eclipse.ui.views.properties.IPropertySource
      Since:
      2.0

    • setPropertyValue

      public final void setPropertyValue(Object id, Object value)
      Specified by:
      setPropertyValue in interface org.eclipse.ui.views.properties.IPropertySource
      Since:
      2.0

    • isPropertyResettable

      public final boolean isPropertyResettable(Object id)
      Specified by:
      isPropertyResettable in interface org.eclipse.ui.views.properties.IPropertySource2
      Since:
      2.0

    • isPropertySet

      public final boolean isPropertySet(Object id)
      Specified by:
      isPropertySet in interface org.eclipse.ui.views.properties.IPropertySource
      Specified by:
      isPropertySet in interface org.eclipse.ui.views.properties.IPropertySource2
      Since:
      2.0