Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui / src / org / simantics / browsing / ui / content / ComparableContextFactory.java

diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java
new file mode 100644 (file)
index 0000000..926dabb
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java
@@ -0,0 +1,45 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.browsing.ui.content;\r
+\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.NodeQueryManager;\r
+\r
+/**\r
+ * This interface can be used to determine a sorting order for the children of a\r
+ * certain node. A single ComparableContextFactory is always used for the\r
+ * children of a single parent node, i.e. a single sorting algorithm will always\r
+ * be used to sort the children.\r
+ * \r
+ * @author Antti Villberg\r
+ */\r
+public interface ComparableContextFactory {\r
+\r
+    /**\r
+     * Constructs {@link ComparableContext} instances from an array of\r
+     * {@link NodeContext}s. The input array will be in the order in which the\r
+     * viewpoint contributions happened to produce the {@link NodeContext}s in.\r
+     * \r
+     * @param manager manager for performing the necessary queries to resolve\r
+     *        the sorting order\r
+     * @param parent the parent node of the children. May be used to carry\r
+     *        constant data to guide the sorting process or just simply ignored.\r
+     * @param children the set of child nodes to make into\r
+     *        {@link ComparableContext} instances\r
+     * @return the specified {@link NodeContext}s wrapped into\r
+     *         {@link ComparableContext}s or <code>null</code> if no sorting is\r
+     *         to be performed. The result array should be of the same size as\r
+     *         the input array.\r
+     */\r
+    ComparableContext[] create(NodeQueryManager manager, NodeContext parent, NodeContext[] children);\r
+\r
+}\r