X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.browsing.ui.common%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcommon%2Fprocessors%2FProcessorLifecycle.java;fp=bundles%2Forg.simantics.browsing.ui.common%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcommon%2Fprocessors%2FProcessorLifecycle.java;h=1cade9189e86fee42aa9ab75852b8c9c7f7533cb;hp=0000000000000000000000000000000000000000;hb=969bd23cab98a79ca9101af33334000879fb60c5;hpb=866dba5cd5a3929bbeae85991796acb212338a08

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ProcessorLifecycle.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ProcessorLifecycle.java
new file mode 100644
index 000000000..1cade9189
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ProcessorLifecycle.java
@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.browsing.ui.common.processors;
+
+import org.simantics.browsing.ui.GraphExplorer;
+import org.simantics.browsing.ui.PrimitiveQueryProcessor;
+
+/**
+ * An interface that {@link PrimitiveQueryProcessor} implementations may
+ * implement in order to receive lifecycle-related notifications that can be
+ * used e.g. for internal housekeeping.
+ * 
+ * @author Tuukka Lehtonen
+ */
+public interface ProcessorLifecycle {
+
+    /**
+     * This processor has been attached to the specified {@link GraphExplorer}
+     * via {@link GraphExplorer#setPrimitiveProcessor(PrimitiveQueryProcessor)}
+     * 
+     * @param explorer the explorer to which this processor was just attached
+     */
+    void attached(GraphExplorer explorer);
+
+    /**
+     * This processor has been detached from the specified {@link GraphExplorer}
+     * for one of these reasons:
+     * <ul>
+     * <li>replaced by another {@link PrimitiveQueryProcessor} through an
+     * invocation to
+     * {@link GraphExplorer#setPrimitiveProcessor(PrimitiveQueryProcessor)}</li>
+     * <li>the graph explorer was disposed and all primitive processors are
+     * being detached from it</li>
+     * </ul>
+     * 
+     * @param explorer the explorer from which this processor was just detached
+     */
+    void detached(GraphExplorer explorer);
+
+    /**
+     * Invoked by GraphExplorer when its input is reset through
+     * {@link GraphExplorer#setRoot(Object)}. Allows the processor to do
+     * cleanup if necessary, e.g. for internal caches.
+     */
+    void clear();
+
+}