Introduce single entity search view.
authorMathieu Baudier <mbaudier@argeo.org>
Wed, 30 Sep 2020 09:37:28 +0000 (11:37 +0200)
committerMathieu Baudier <mbaudier@argeo.org>
Wed, 30 Sep 2020 09:37:28 +0000 (11:37 +0200)
org.argeo.suite.e4/src/org/argeo/suite/e4/parts/SingleEntitySearchView.java [new file with mode: 0644]

diff --git a/org.argeo.suite.e4/src/org/argeo/suite/e4/parts/SingleEntitySearchView.java b/org.argeo.suite.e4/src/org/argeo/suite/e4/parts/SingleEntitySearchView.java
new file mode 100644 (file)
index 0000000..159dd2d
--- /dev/null
@@ -0,0 +1,265 @@
+package org.argeo.suite.e4.parts;
+
+import static org.argeo.eclipse.ui.EclipseUiUtils.notEmpty;
+
+import java.util.List;
+
+import javax.annotation.PostConstruct;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.jcr.NodeIterator;
+import javax.jcr.Repository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+import javax.jcr.observation.Event;
+import javax.jcr.observation.EventIterator;
+import javax.jcr.observation.EventListener;
+import javax.jcr.query.Query;
+import javax.jcr.query.QueryResult;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.argeo.activities.ActivitiesService;
+import org.argeo.cms.ui.util.CmsUiUtils;
+import org.argeo.connect.ConnectException;
+import org.argeo.connect.resources.ResourcesService;
+import org.argeo.connect.ui.ConnectUiConstants;
+import org.argeo.connect.ui.Refreshable;
+import org.argeo.connect.ui.SystemWorkbenchService;
+import org.argeo.connect.ui.util.BasicNodeListContentProvider;
+import org.argeo.connect.ui.util.JcrViewerDClickListener;
+import org.argeo.connect.ui.widgets.DelayedText;
+import org.argeo.connect.util.ConnectJcrUtils;
+import org.argeo.connect.util.XPathUtils;
+import org.argeo.eclipse.ui.EclipseUiUtils;
+import org.argeo.entity.EntityTypes;
+import org.argeo.jcr.JcrUtils;
+import org.argeo.people.PeopleService;
+import org.eclipse.e4.ui.di.Focus;
+import org.eclipse.e4.ui.model.application.ui.basic.MPart;
+import org.eclipse.e4.ui.workbench.modeling.ESelectionService;
+import org.eclipse.jface.layout.TableColumnLayout;
+import org.eclipse.jface.viewers.ColumnWeightData;
+import org.eclipse.jface.viewers.ILabelProvider;
+import org.eclipse.jface.viewers.ISelectionChangedListener;
+import org.eclipse.jface.viewers.IStructuredSelection;
+import org.eclipse.jface.viewers.SelectionChangedEvent;
+import org.eclipse.jface.viewers.StructuredSelection;
+import org.eclipse.jface.viewers.TableViewer;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.events.KeyEvent;
+import org.eclipse.swt.events.KeyListener;
+import org.eclipse.swt.events.ModifyEvent;
+import org.eclipse.swt.events.ModifyListener;
+import org.eclipse.swt.layout.GridData;
+import org.eclipse.swt.layout.GridLayout;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Table;
+import org.eclipse.swt.widgets.TableColumn;
+import org.eclipse.swt.widgets.Text;
+
+/** A table with a quick search field. */
+public class SingleEntitySearchView implements Refreshable {
+       public final static String ENTITY_TYPE = "entity:type";
+
+       private final static Log log = LogFactory.getLog(SingleEntitySearchView.class);
+       // public static final String ID = AsUiPlugin.PLUGIN_ID + ".quickSearchView";
+
+       /* DEPENDENCY INJECTION */
+       @Inject
+       private Repository repository;
+       @Inject
+       private ResourcesService resourcesService;
+       @Inject
+       private ActivitiesService activitiesService;
+       @Inject
+       private PeopleService peopleService;
+       @Inject
+       private SystemWorkbenchService systemWorkbenchService;
+
+       @Inject
+       private ESelectionService selectionService;
+
+       @Inject
+       private MPart mPart;
+
+       // This page widgets
+       private TableViewer entityViewer;
+       private Text filterTxt;
+
+       private Session session;
+
+       private String entityType;
+
+       // @Override
+       // public void init(IViewSite site) throws PartInitException {
+       // super.init(site);
+       // }
+
+       @PostConstruct
+       public void createPartControl(Composite parent) {
+               entityType = mPart.getProperties().get(ENTITY_TYPE);
+               if (entityType == null)
+                       throw new IllegalArgumentException("Property " + ENTITY_TYPE + " must be set.");
+
+               session = ConnectJcrUtils.login(repository);
+               // MainLayout
+               parent.setLayout(new GridLayout());
+               addFilterPanel(parent);
+               entityViewer = createListPart(parent, new EntitySingleColumnLabelProvider(resourcesService, activitiesService,
+                               peopleService, systemWorkbenchService));
+               refreshFilteredList();
+
+               try {
+                       String[] nodeTypes = entityType.contains(":") ? new String[] { entityType } : null;
+                       session.getWorkspace().getObservationManager().addEventListener(new EventListener() {
+
+                               @Override
+                               public void onEvent(EventIterator events) {
+                                       parent.getDisplay().asyncExec(() -> refreshFilteredList());
+                               }
+                       }, Event.PROPERTY_CHANGED | Event.NODE_ADDED | Event.NODE_REMOVED | Event.PROPERTY_ADDED, "/", true, null,
+                                       nodeTypes, false);
+               } catch (RepositoryException e) {
+                       throw new ConnectException("Cannot add JCR observer", e);
+               }
+
+       }
+
+       private void addFilterPanel(Composite parent) {
+               // Use a delayed text: the query won't be done until the user stop
+               // typing for 800ms
+               int style = SWT.BORDER | SWT.SEARCH | SWT.ICON_CANCEL;
+               DelayedText delayedText = new DelayedText(parent, style, ConnectUiConstants.SEARCH_TEXT_DELAY);
+               filterTxt = delayedText.getText();
+               filterTxt.setLayoutData(EclipseUiUtils.fillWidth());
+
+               // final ServerPushSession pushSession = new ServerPushSession();
+               delayedText.addDelayedModifyListener(null, new ModifyListener() {
+                       private static final long serialVersionUID = 5003010530960334977L;
+
+                       public void modifyText(ModifyEvent event) {
+                               delayedText.getText().getDisplay().asyncExec(new Runnable() {
+                                       @Override
+                                       public void run() {
+                                               refreshFilteredList();
+                                       }
+                               });
+                               // pushSession.stop();
+                       }
+               });
+
+               // Jump to the first item of the list using the down arrow
+               filterTxt.addKeyListener(new KeyListener() {
+                       private static final long serialVersionUID = -4523394262771183968L;
+
+                       @Override
+                       public void keyReleased(KeyEvent e) {
+                       }
+
+                       @Override
+                       public void keyPressed(KeyEvent e) {
+                               // boolean shiftPressed = (e.stateMask & SWT.SHIFT) != 0;
+                               // boolean altPressed = (e.stateMask & SWT.ALT) != 0;
+                               if (e.keyCode == SWT.ARROW_DOWN || e.keyCode == SWT.TAB) {
+                                       Object first = entityViewer.getElementAt(0);
+                                       if (first != null) {
+                                               entityViewer.getTable().setFocus();
+                                               entityViewer.setSelection(new StructuredSelection(first), true);
+                                       }
+                                       e.doit = false;
+                               }
+                       }
+               });
+       }
+
+       protected TableViewer createListPart(Composite parent, ILabelProvider labelProvider) {
+               parent.setLayout(new GridLayout());
+
+               Composite tableComposite = new Composite(parent, SWT.NONE);
+               GridData gd = new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.GRAB_VERTICAL
+                               | GridData.VERTICAL_ALIGN_FILL | GridData.GRAB_HORIZONTAL);
+               tableComposite.setLayoutData(gd);
+
+               TableViewer v = new TableViewer(tableComposite);
+               v.setLabelProvider(labelProvider);
+
+               TableColumn singleColumn = new TableColumn(v.getTable(), SWT.V_SCROLL);
+               TableColumnLayout tableColumnLayout = new TableColumnLayout();
+               tableColumnLayout.setColumnData(singleColumn, new ColumnWeightData(85));
+               tableComposite.setLayout(tableColumnLayout);
+
+               // Corresponding table & style
+               Table table = v.getTable();
+               table.setLinesVisible(true);
+               table.setHeaderVisible(false);
+               CmsUiUtils.markup(table);
+               CmsUiUtils.setItemHeight(table, 26);
+
+               v.setContentProvider(new BasicNodeListContentProvider());
+               v.addDoubleClickListener(new JcrViewerDClickListener(systemWorkbenchService));
+               v.addSelectionChangedListener(new ISelectionChangedListener() {
+                       public void selectionChanged(SelectionChangedEvent event) {
+                               IStructuredSelection selection = (IStructuredSelection) event.getSelection();
+                               List<?> lst = selection.toList();
+                               if (lst != null && !lst.isEmpty())
+                                       selectionService.setSelection(selection.toList());
+                               else
+                                       selectionService.setSelection(null);
+                       }
+               });
+               return v;
+       }
+
+       @PreDestroy
+       public void dispose() {
+               JcrUtils.logoutQuietly(session);
+       }
+
+       @Focus
+       public void setFocus() {
+               refreshFilteredList();
+               filterTxt.setFocus();
+       }
+
+       @Override
+       public void forceRefresh(Object object) {
+               refreshFilteredList();
+       }
+
+       protected void refreshFilteredList() {
+               try {
+                       String filter = filterTxt.getText();
+                       // Prevents the query on the full repository
+                       // if (isEmpty(filter)) {
+                       // entityViewer.setInput(null);
+                       // return;
+                       // }
+
+                       // XPATH Query
+                       String xpathQueryStr = entityType.contains(":") ? "//element(*, " + entityType + ")"
+                                       : "//element(*, " + EntityTypes.ENTITY_ENTITY + ")[@entity:type='" + entityType + "']";
+//                     String xpathQueryStr = "//element(*, " + ConnectTypes.CONNECT_ENTITY + ")";
+                       String xpathFilter = XPathUtils.getFreeTextConstraint(filter);
+                       if (notEmpty(xpathFilter))
+                               xpathQueryStr += "[" + xpathFilter + "]";
+
+                       long begin = System.currentTimeMillis();
+                       // session.refresh(false);
+                       Query xpathQuery = XPathUtils.createQuery(session, xpathQueryStr);
+
+                       xpathQuery.setLimit(ConnectUiConstants.SEARCH_DEFAULT_LIMIT);
+                       QueryResult result = xpathQuery.execute();
+
+                       NodeIterator nit = result.getNodes();
+                       entityViewer.setInput(JcrUtils.nodeIteratorToList(nit));
+                       if (log.isTraceEnabled()) {
+                               long end = System.currentTimeMillis();
+                               log.trace("Quick Search - Found: " + nit.getSize() + " in " + (end - begin)
+                                               + " ms by executing XPath query (" + xpathQueryStr + ").");
+                       }
+               } catch (RepositoryException e) {
+                       throw new ConnectException("Unable to list entities", e);
+               }
+       }
+}