Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added filtering and other options to SampleView of Databrowser #2840

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added filtering and other options to SampleView of Databrowser #2840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7a2ac6
Added filtering and other options to SampleView of Databrowser
Sep 28, 2023
ed2bc88
filter options in sampleview
Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions app/databrowser/src/main/java/org/csstudio/trends/databrowser3/Messages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ public class Messages
PointTypeTT,
PosErrColumn,
PropertiesTabName,
PVColumn,
PVName,
PVUsedInFormulaFmt,
Refresh,
Expand All @@ -246,7 +247,19 @@ public class Messages
RequestTypeWarning,
RequestTypeWarningDetail,
SampleView_Count,
SampleView_Count_Visible,
SampleView_Filter_Change,
SampleView_FilterTypeTT,
SampleView_FilterValueTT,
SampleView_Item,
SampleView_ItemFilter_ALARM_CHANGES,
SampleView_ItemFilter_ALARM_UP,
SampleView_ItemFilter_NO_FILTER,
SampleView_ItemFilter_THRESHOLD_CHANGES,
SampleView_ItemFilter_THRESHOLD_DOWN,
SampleView_ItemFilter_THRESHOLD_UP,
SampleView_Move_Down,
SampleView_Move_Up ,
SampleView_Refresh,
SampleView_RefreshTT,
SampleView_SelectItem,
Expand Down Expand Up @@ -291,6 +304,10 @@ public class Messages
TraceLineStyleTT,
TraceLineWidth,
TraceLineWidthTT,
TracesFilterType,
TracesFilterTypeTT,
TracesFilterValue,
TracesFilterValueTT,
TracesTab,
TraceTableEmpty,
TraceType,
Expand Down
56 changes: 56 additions & 0 deletions app/databrowser/src/main/java/org/csstudio/trends/databrowser3/model/ModelItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.csstudio.javafx.rtplot.data.PlotDataItem;
import org.csstudio.trends.databrowser3.persistence.XMLPersistence;
import org.csstudio.trends.databrowser3.preferences.Preferences;
import org.csstudio.trends.databrowser3.ui.sampleview.ItemSampleViewFilter;
import org.phoebus.framework.persistence.XMLUtil;
import org.w3c.dom.Element;

Expand Down Expand Up @@ -84,6 +85,9 @@ abstract public class ModelItem
*/
private String uniqueId;

/** Item specific settings for SampleView filter*/
private ItemSampleViewFilter sample_view_filter = new ItemSampleViewFilter();

/** Initialize
* @param name Name of the PV or the formula
*/
Expand Down Expand Up @@ -359,6 +363,25 @@ public void setWaveformIndex(int index)
// Do nothing.
}

/**
*
* @return Current SampleView Filter
*/
public ItemSampleViewFilter getSampleViewFilter()
{
return sample_view_filter;
}

/**
*
* @param sample_view_filter New Filter object to be used for the SampleView display of this item
*/
public void setSampleViewFilter(ItemSampleViewFilter sample_view_filter)
{
this.sample_view_filter = sample_view_filter;
fireItemLookChanged();
}

/** @return Samples held by this item */
abstract public PlotSamples getSamples();

Expand Down Expand Up @@ -427,6 +450,14 @@ protected void writeCommonConfig(final XMLStreamWriter writer) throws Exception
writer.writeStartElement(XMLPersistence.TAG_WAVEFORM_INDEX);
writer.writeCharacters(Integer.toString(getWaveformIndex()));
writer.writeEndElement();

writer.writeStartElement(XMLPersistence.TAG_FILTER_TYPE);
writer.writeCharacters(getSampleViewFilter().getFilterType().name());
writer.writeEndElement();

writer.writeStartElement(XMLPersistence.TAG_FILTER_VALUE);
writer.writeCharacters(Double.toString(getSampleViewFilter().getFilterValue()));
writer.writeEndElement();
}

/** Load common XML configuration elements into this item
Expand Down Expand Up @@ -490,6 +521,31 @@ else if (type.equals("CROSSES"))
}
}
setWaveformIndex(XMLUtil.getChildInteger(node, XMLPersistence.TAG_WAVEFORM_INDEX).orElse(0));

try
{
String filter_type_from_document =
XMLUtil.getChildString(node, XMLPersistence.TAG_FILTER_TYPE)
.orElse(ItemSampleViewFilter.FilterType.NO_FILTER.name());
sample_view_filter.setFilterType(ItemSampleViewFilter.FilterType.valueOf(filter_type_from_document));
}
catch (Throwable ex)
{
sample_view_filter.setFilterType(ItemSampleViewFilter.FilterType.NO_FILTER); // Default to no filter
}

try
{
double filter_value_from_document =
XMLUtil.getChildDouble(node, XMLPersistence.TAG_FILTER_VALUE)
.orElse(0.0);
sample_view_filter.setFilterValue(filter_value_from_document);
}
catch (Throwable ex)
{
sample_view_filter.setFilterValue(0.0); // Default to 0.0
}

}

/** Dispose all data */
Expand Down
2 changes: 2 additions & 0 deletions ...atabrowser/src/main/java/org/csstudio/trends/databrowser3/persistence/XMLPersistence.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ public class XMLPersistence
TAG_POINT_TYPE = "point_type",
TAG_POINT_SIZE = "point_size",
TAG_WAVEFORM_INDEX = "waveform_index",
TAG_FILTER_TYPE = "filter_type",
TAG_FILTER_VALUE = "filter_value",
TAG_SCAN_PERIOD = "period",
TAG_LIVE_SAMPLE_BUFFER_SIZE = "ring_size",
TAG_REQUEST = "request",
Expand Down
131 changes: 115 additions & 16 deletions app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/Perspective.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.logging.Level;
import java.util.prefs.BackingStoreException;
import java.util.prefs.Preferences;
import java.util.stream.Collectors;

import javafx.scene.layout.Pane;
import javafx.scene.layout.StackPane;
import org.csstudio.trends.databrowser3.Activator;
import org.csstudio.trends.databrowser3.Messages;
import org.csstudio.trends.databrowser3.imports.SampleImportAction;
Expand All @@ -32,6 +33,7 @@
import org.csstudio.trends.databrowser3.ui.properties.PropertyPanel;
import org.csstudio.trends.databrowser3.ui.properties.RemoveUnusedAxes;
import org.csstudio.trends.databrowser3.ui.sampleview.SampleView;
import org.csstudio.trends.databrowser3.ui.sampleview.ToggleSampleViewPositionMenuItem;
import org.csstudio.trends.databrowser3.ui.search.SearchView;
import org.csstudio.trends.databrowser3.ui.selection.DatabrowserSelection;
import org.csstudio.trends.databrowser3.ui.waveformview.WaveformView;
Expand Down Expand Up @@ -71,28 +73,35 @@ public class Perspective extends SplitPane
SHOW_SEARCH = "show_search",
SHOW_PROPERTIES = "show_properties",
SHOW_EXPORT = "show_export",
SHOW_WAVEFORM = "show_waveform";
SHOW_WAVEFORM = "show_waveform",
SHOW_SAMPLEVIEW = "show_sampleview",
SAMPLEVIEW_IN_BOTTOM_TABS = "sampleview_in_bottom_tabs";

private static final Preferences prefs = PhoebusPreferenceService.userNodeForClass(Perspective.class);

private final Model model = new Model();
private final ModelBasedPlot plot = new ModelBasedPlot(true);
private SearchView search;
private SearchView search = null;
private ExportView export = null;
private SampleView inspect = null;
private SampleView sampleview = null;
private WaveformView waveform = null;
private final PropertyPanel property_panel;


private final Controller controller;
private final TabPane left_tabs = new TabPane(),
bottom_tabs = new TabPane();
private final SplitPane plot_and_tabs = new SplitPane(plot.getPlot(), bottom_tabs);
private PropertyPanel property_panel;
private Tab search_tab, properties_tab, export_tab, inspect_tab, waveform_tab = null;
private final Pane top_pane = new StackPane();
private final SplitPane plot_and_tabs = new SplitPane(top_pane, bottom_tabs);
private Tab search_tab, properties_tab, export_tab, sampleview_tab, waveform_tab;


/** @param minimal Only show the essentials? */
public Perspective(final boolean minimal)
{
top_pane.getChildren().setAll(plot.getPlot());


property_panel = new PropertyPanel(model, plot.getPlot().getUndoableActionManager());
properties_tab = new Tab(Messages.PropertiesTabName, property_panel);
properties_tab.setGraphic(Activator.getIcon("properties"));
Expand Down Expand Up @@ -174,8 +183,8 @@ private void createContextMenu()
final MenuItem show_samples = new MenuItem(Messages.InspectSamples, Activator.getIcon("search"));
show_samples.setOnAction(event ->
{
createInspectionTab();
showBottomTab(inspect_tab);
createSampleViewTab(plot.getPlot().getUndoableActionManager());
showBottomTab(sampleview_tab);
});

final MenuItem show_waveform = new MenuItem(Messages.OpenWaveformView, Activator.getIcon("wavesample"));
Expand All @@ -202,7 +211,7 @@ private void createContextMenu()
items.add(new PrintAction(plot.getPlot().getCenter()));
items.add(new SaveSnapshotAction(plot.getPlot().getCenter()));

SelectionService.getInstance().setSelection(this, Arrays.asList(DatabrowserSelection.of(model, plot)));
SelectionService.getInstance().setSelection(this, List.of(DatabrowserSelection.of(model, plot)));
List<ContextMenuEntry> supported = ContextMenuService.getInstance().listSupportedContextMenuEntries();
supported.stream().forEach(action -> {
MenuItem menuItem = new MenuItem(action.getName(), new ImageView(action.getIcon()));
Expand All @@ -227,6 +236,57 @@ private void createContextMenu()
});
}

private void createSampleViewContextMenu() {
final ContextMenu menu = new ContextMenu();
final ObservableList<MenuItem> items = menu.getItems();

final UndoableActionManager undo = plot.getPlot().getUndoableActionManager();

final List<MenuItem> add_data = new ArrayList<>();
add_data.add(new AddPVorFormulaMenuItem(sampleview, model, undo, false));
add_data.add(new AddPVorFormulaMenuItem(sampleview, model, undo, true));

for (String type : SampleImporters.getTypes())
add_data.add(new SampleImportAction(model, type, undo));

final MenuItem show_search = new MenuItem(Messages.OpenSearchView, Activator.getIcon("search"));
show_search.setOnAction(event -> showSearchTab());

final MenuItem show_properties = new MenuItem(Messages.OpenPropertiesView, Activator.getIcon("properties"));
show_properties.setOnAction(event ->
{
// Update pref that properties were last opened
prefs.putBoolean(SHOW_PROPERTIES, true);
showBottomTab(properties_tab);
});

final MenuItem show_export = new MenuItem(Messages.OpenExportView, Activator.getIcon("export"));
show_export.setOnAction(event ->
{
createExportTab();
showBottomTab(export_tab);
});

final MenuItem show_waveform = new MenuItem(Messages.OpenWaveformView, Activator.getIcon("wavesample"));
show_waveform.setOnAction(event ->
{
createWaveformTab();
showBottomTab(waveform_tab);
});
final MenuItem refresh = new MenuItem(Messages.Refresh, Activator.getIcon("refresh_remote"));
refresh.setOnAction(event -> sampleview.update());


sampleview.setOnContextMenuRequested(event -> {
items.clear();
items.addAll(new ToggleSampleViewPositionMenuItem(this), new SeparatorMenuItem());
items.addAll(add_data);
items.addAll(new SeparatorMenuItem(), show_search, show_properties, show_export, show_waveform, refresh);

menu.show(getScene().getWindow(), event.getScreenX(), event.getScreenY());
});
}

private void createSearchTab()
{
if (search_tab == null)
Expand All @@ -249,17 +309,35 @@ private void createExportTab()
}
}

private void createInspectionTab()
private void createSampleViewTab(UndoableActionManager undo)
{
if (inspect_tab == null)
if (sampleview_tab == null)
{
inspect = new SampleView(model);
inspect_tab = new Tab(Messages.InspectSamples, inspect);
inspect_tab.setGraphic(Activator.getIcon("search"));
inspect_tab.setOnClosed(evt -> autoMinimizeBottom());
sampleview = new SampleView(model, undo);
sampleview_tab = new Tab(Messages.InspectSamples, sampleview);
sampleview_tab.setGraphic(Activator.getIcon("search"));
sampleview_tab.setOnClosed(evt -> autoMinimizeBottom());

createSampleViewContextMenu();
}
}

// Gets called from the SampleView contextmenu, so we can assume it's not null
public void setSampleviewLocation(boolean set_in_bottom_tabs) {
if (set_in_bottom_tabs) {
top_pane.getChildren().setAll(plot.getPlot());
showBottomTab(sampleview_tab);
}
else {
bottom_tabs.getTabs().remove(sampleview_tab);
top_pane.getChildren().setAll(sampleview);
}
}

public boolean isSampleViewInBottomTabs() {
return bottom_tabs.getTabs().contains(sampleview_tab);
}

private void createWaveformTab()
{
if (waveform_tab == null)
Expand Down Expand Up @@ -442,6 +520,17 @@ public void restore(final Memento memento)
}
});

memento.getBoolean(SHOW_SAMPLEVIEW).ifPresent(show ->
{
if (show)
{
createSampleViewTab(plot.getPlot().getUndoableActionManager());
memento.getBoolean(SAMPLEVIEW_IN_BOTTOM_TABS).ifPresent(in_bottom_tabs -> {
setSampleviewLocation(in_bottom_tabs);
});
}
});

// Has no effect when run right now?
Platform.runLater(() ->
{
Expand Down Expand Up @@ -473,6 +562,7 @@ public void save(final Memento memento)
if (left_tabs.getTabs().contains(search_tab))
memento.setBoolean(SHOW_SEARCH, true);

// properties open by default. save only if closed
if (! bottom_tabs.getTabs().contains(properties_tab))
memento.setBoolean(SHOW_PROPERTIES, false);

Expand All @@ -481,6 +571,15 @@ public void save(final Memento memento)

if (bottom_tabs.getTabs().contains(waveform_tab))
memento.setBoolean(SHOW_WAVEFORM, true);

if (top_pane.getChildren().contains(sampleview)) {
memento.setBoolean(SHOW_SAMPLEVIEW, true);
memento.setBoolean(SAMPLEVIEW_IN_BOTTOM_TABS, false);
}
if (bottom_tabs.getTabs().contains(sampleview_tab)) {
memento.setBoolean(SHOW_SAMPLEVIEW, true);
memento.setBoolean(SAMPLEVIEW_IN_BOTTOM_TABS, true);
}
}

/** Reclaim resources */
Expand Down
Loading
Loading