-/*******************************************************************************\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.modeling.services;\r
-\r
-import java.util.Collections;\r
-import java.util.List;\r
-import java.util.Set;\r
-\r
-import org.simantics.databoard.Bindings;\r
-import org.simantics.databoard.util.URIStringUtils;\r
-import org.simantics.db.ReadGraph;\r
-import org.simantics.db.Resource;\r
-import org.simantics.db.common.primitiverequest.PossibleRelatedValueImplied2;\r
-import org.simantics.db.common.procedure.adapter.TransientCacheListener;\r
-import org.simantics.db.common.utils.NameUtils;\r
-import org.simantics.db.exception.DatabaseException;\r
-import org.simantics.layer0.Layer0;\r
-import org.simantics.operation.Layer0X;\r
-import org.simantics.project.IProject;\r
-import org.simantics.structural.stubs.StructuralResource2;\r
-\r
-/**\r
- * @author Tuukka Lehtonen\r
- */\r
-public final class ComponentNamingUtil {\r
-\r
- private final static boolean DEBUG = false;\r
-\r
- public static final String validateInstanceName(ReadGraph graph, IProject project, Resource configurationRoot,\r
- Resource composite, Resource componentType, String proposition, boolean acceptProposition) throws DatabaseException, NamingException {\r
- if (DEBUG) {\r
- System.out.println("validateInstanceName(project=" + project + ", configurationRoot=" + configurationRoot\r
- + ", composite=" + composite + ", componentType=" + componentType + ", proposition=" + proposition + ")");\r
- System.out.println(" INVOKED FROM: " + new Exception().getStackTrace()[1].toString());\r
- }\r
-\r
- ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);\r
- if (strategy != null) {\r
- proposition = strategy.validateInstanceName(graph, configurationRoot, composite, componentType, proposition, acceptProposition);\r
- }\r
-\r
- // As a fallback method, try to deduce the name based on type properties.\r
- if (proposition == null) {\r
- proposition = fallbackNameGeneration(graph, composite, componentType);\r
- }\r
-\r
- return proposition;\r
- }\r
-\r
- public static final String validateInstanceName(ReadGraph graph, IProject project, Resource configurationRoot, Resource component, String proposition, boolean acceptProposition) throws DatabaseException, NamingException {\r
- \r
- Layer0 L0 = Layer0.getInstance(graph);\r
- Resource composite = graph.getPossibleObject(component, L0.PartOf);\r
- \r
- ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);\r
- if (strategy != null) {\r
- return strategy.validateInstanceName(graph, configurationRoot, component, proposition, acceptProposition);\r
- } else {\r
- return null;\r
- }\r
- \r
- }\r
- \r
- public static final String findFreshInstanceName(ReadGraph graph, IProject project, Resource configurationRoot,\r
- Resource composite, Resource componentType) throws DatabaseException, NamingException {\r
-\r
- String proposition = null;\r
-\r
- if (DEBUG) {\r
- System.out.println("findFreshInstanceName(project=" + project + ", configurationRoot=" + configurationRoot\r
- + ", composite=" + composite + ", componentType=" + componentType + ")");\r
- System.out.println(" INVOKED FROM: " + new Exception().getStackTrace()[1].toString());\r
- }\r
-\r
- ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);\r
- if (strategy != null) {\r
- proposition = strategy.findFreshInstanceName(graph, configurationRoot, composite, componentType);\r
- }\r
-\r
- // As a fallback method, try to deduce the name based on type properties.\r
- if (proposition == null) {\r
- proposition = fallbackNameGeneration(graph, composite, componentType);\r
- }\r
-\r
- return proposition;\r
- }\r
-\r
- public static final String findFreshEscapedInstanceName(ReadGraph graph, IProject project, Resource configurationRoot,\r
- Resource composite, Resource componentType) throws DatabaseException, NamingException {\r
- if (DEBUG) {\r
- System.out.println("findFreshEscapedInstanceName(project=" + project + ", configurationRoot=" + configurationRoot\r
- + ", composite=" + composite + ", componentType=" + componentType + ")");\r
- new Exception("trace").printStackTrace();\r
- }\r
- String proposition = findFreshInstanceName(graph, project, configurationRoot, composite, componentType);\r
- proposition = URIStringUtils.escape(proposition);\r
- return proposition;\r
- }\r
-\r
- /**\r
- * @param graph\r
- * @param project\r
- * @param configurationRoot\r
- * @param composite\r
- * @param componentType\r
- * @param externallyReserved\r
- * @return\r
- * @throws DatabaseException\r
- * @throws NamingException\r
- */\r
- public static final String validateInstanceName(\r
- ReadGraph graph,\r
- IProject project,\r
- Resource configurationRoot,\r
- Resource composite,\r
- Resource componentType,\r
- Set<String> externallyReserved)\r
- throws DatabaseException, NamingException\r
- {\r
- if (DEBUG) {\r
- System.out.println("validateInstanceName(project=" + project + ", configurationRoot=" + configurationRoot\r
- + ", composite=" + composite + ", componentType=" + componentType + ")");\r
- System.out.println(" INVOKED FROM: " + new Exception().getStackTrace()[1].toString());\r
- }\r
-\r
- ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);\r
- if (strategy == null)\r
- throw new NamingException("No naming strategy available, project=" + project + ", composite=" + composite + ", componentType=" + componentType);\r
-\r
- String proposition = ComponentNamingUtil.generateProposition(graph, composite, componentType);\r
- List<String> validated = strategy.validateInstanceNames(graph, configurationRoot, Collections.singletonList(proposition), true, externallyReserved);\r
- proposition = validated.get(0);\r
-\r
- return proposition;\r
- }\r
-\r
- /**\r
- * @param graph\r
- * @param project\r
- * @param configurationRoot\r
- * @param propositions\r
- * @param externallyReserved\r
- * @return\r
- * @throws DatabaseException\r
- * @throws NamingException\r
- */\r
- public static final List<String> validateInstanceNames(\r
- ReadGraph graph,\r
- IProject project,\r
- Resource configurationRoot,\r
- List<String> propositions,\r
- boolean acceptProposition,\r
- Set<String> externallyReserved)\r
- throws DatabaseException, NamingException\r
- {\r
- ComponentNamingStrategy strategy = findNamingStrategy(graph, project, configurationRoot);\r
- if (strategy == null)\r
- throw new NamingException("No naming strategy available, project=" + project);\r
- return strategy.validateInstanceNames(graph, configurationRoot, propositions, acceptProposition, externallyReserved);\r
- }\r
-\r
- /**\r
- * This is a fallback name generation method that deduces propositions\r
- * container-locally based on component type prefixes or names.\r
- * \r
- * @param graph\r
- * @param composite\r
- * @param componentType\r
- * @return\r
- * @throws DatabaseException\r
- */\r
- private static String fallbackNameGeneration(ReadGraph graph, Resource container, Resource componentType)\r
- throws DatabaseException {\r
- return NameUtils.findFreshName(graph, generateProposition(graph, container, componentType), container);\r
- }\r
-\r
- public static String generateProposition(ReadGraph graph, String containerGeneratedNamePrefix, Resource componentType) throws DatabaseException {\r
- Layer0X L0X = Layer0X.getInstance(graph);\r
- StringBuilder proposition = new StringBuilder();\r
- if (containerGeneratedNamePrefix != null)\r
- proposition.append(containerGeneratedNamePrefix);\r
- String componentPrefix = graph.getPossibleRelatedValue(componentType, L0X.HasGeneratedNamePrefix, Bindings.STRING);\r
- if (componentPrefix == null) {\r
- Layer0 L0 = Layer0.getInstance(graph);\r
- componentPrefix = graph.getPossibleRelatedValue(componentType, L0.HasName);\r
- if (componentPrefix == null)\r
- componentPrefix = "Entity";\r
- }\r
- proposition.append(componentPrefix);\r
- return proposition.toString();\r
- }\r
-\r
- public static String generateProposition(ReadGraph graph, Resource container, Resource componentType) throws DatabaseException {\r
- Layer0X L0X = Layer0X.getInstance(graph);\r
- String containerPrefix = graph.getPossibleRelatedValue(container, L0X.HasGeneratedNamePrefix, Bindings.STRING);\r
- return generateProposition(graph, containerPrefix != null ? containerPrefix : "", componentType);\r
- }\r
-\r
- public static final ComponentNamingStrategy findNamingStrategy(ReadGraph graph, IProject project, Resource composite) throws DatabaseException {\r
- // Primarily, use naming function from composite\r
- ComponentNamingStrategy strategy = graph.syncRequest(\r
- new PossibleRelatedValueImplied2<ComponentNamingStrategy>(composite, StructuralResource2.getInstance(graph).Composite_namingFunction),\r
- TransientCacheListener.<ComponentNamingStrategy>instance());\r
- if (strategy == null && project != null) {\r
- // If not available, try to find ComponentNamingStrategy for project\r
- strategy = project.getHint(ComponentNamingStrategy.PROJECT_KEY);\r
- }\r
- return strategy;\r
- }\r
-\r
-}\r
+/*******************************************************************************
+ * 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.modeling.services;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+import org.simantics.databoard.Bindings;
+import org.simantics.databoard.util.URIStringUtils;
+import org.simantics.db.ReadGraph;
+import org.simantics.db.Resource;
+import org.simantics.db.common.primitiverequest.PossibleRelatedValueImplied2;
+import org.simantics.db.common.procedure.adapter.TransientCacheListener;
+import org.simantics.db.common.utils.NameUtils;
+import org.simantics.db.exception.DatabaseException;
+import org.simantics.layer0.Layer0;
+import org.simantics.operation.Layer0X;
+import org.simantics.project.IProject;
+import org.simantics.structural.stubs.StructuralResource2;
+
+/**
+ * @author Tuukka Lehtonen
+ */
+public final class ComponentNamingUtil {
+
+ private final static boolean DEBUG = false;
+
+ public static final String validateInstanceName(ReadGraph graph, IProject project, Resource configurationRoot,
+ Resource composite, Resource componentType, String proposition, boolean acceptProposition) throws DatabaseException, NamingException {
+ if (DEBUG) {
+ System.out.println("validateInstanceName(project=" + project + ", configurationRoot=" + configurationRoot
+ + ", composite=" + composite + ", componentType=" + componentType + ", proposition=" + proposition + ")");
+ System.out.println(" INVOKED FROM: " + new Exception().getStackTrace()[1].toString());
+ }
+
+ ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);
+ if (strategy != null) {
+ proposition = strategy.validateInstanceName(graph, configurationRoot, composite, componentType, proposition, acceptProposition);
+ }
+
+ // As a fallback method, try to deduce the name based on type properties.
+ if (proposition == null) {
+ proposition = fallbackNameGeneration(graph, composite, componentType);
+ }
+
+ return proposition;
+ }
+
+ public static final String validateInstanceName(ReadGraph graph, IProject project, Resource configurationRoot, Resource component, String proposition, boolean acceptProposition) throws DatabaseException, NamingException {
+
+ Layer0 L0 = Layer0.getInstance(graph);
+ Resource composite = graph.getPossibleObject(component, L0.PartOf);
+
+ ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);
+ if (strategy != null) {
+ return strategy.validateInstanceName(graph, configurationRoot, component, proposition, acceptProposition);
+ } else {
+ return null;
+ }
+
+ }
+
+ public static final String findFreshInstanceName(ReadGraph graph, IProject project, Resource configurationRoot,
+ Resource composite, Resource componentType) throws DatabaseException, NamingException {
+
+ String proposition = null;
+
+ if (DEBUG) {
+ System.out.println("findFreshInstanceName(project=" + project + ", configurationRoot=" + configurationRoot
+ + ", composite=" + composite + ", componentType=" + componentType + ")");
+ System.out.println(" INVOKED FROM: " + new Exception().getStackTrace()[1].toString());
+ }
+
+ ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);
+ if (strategy != null) {
+ proposition = strategy.findFreshInstanceName(graph, configurationRoot, composite, componentType);
+ }
+
+ // As a fallback method, try to deduce the name based on type properties.
+ if (proposition == null) {
+ proposition = fallbackNameGeneration(graph, composite, componentType);
+ }
+
+ return proposition;
+ }
+
+ public static final String findFreshEscapedInstanceName(ReadGraph graph, IProject project, Resource configurationRoot,
+ Resource composite, Resource componentType) throws DatabaseException, NamingException {
+ if (DEBUG) {
+ System.out.println("findFreshEscapedInstanceName(project=" + project + ", configurationRoot=" + configurationRoot
+ + ", composite=" + composite + ", componentType=" + componentType + ")");
+ new Exception("trace").printStackTrace();
+ }
+ String proposition = findFreshInstanceName(graph, project, configurationRoot, composite, componentType);
+ proposition = URIStringUtils.escape(proposition);
+ return proposition;
+ }
+
+ /**
+ * @param graph
+ * @param project
+ * @param configurationRoot
+ * @param composite
+ * @param componentType
+ * @param externallyReserved
+ * @return
+ * @throws DatabaseException
+ * @throws NamingException
+ */
+ public static final String validateInstanceName(
+ ReadGraph graph,
+ IProject project,
+ Resource configurationRoot,
+ Resource composite,
+ Resource componentType,
+ Set<String> externallyReserved)
+ throws DatabaseException, NamingException
+ {
+ if (DEBUG) {
+ System.out.println("validateInstanceName(project=" + project + ", configurationRoot=" + configurationRoot
+ + ", composite=" + composite + ", componentType=" + componentType + ")");
+ System.out.println(" INVOKED FROM: " + new Exception().getStackTrace()[1].toString());
+ }
+
+ ComponentNamingStrategy strategy = findNamingStrategy(graph, project, composite);
+ if (strategy == null)
+ throw new NamingException("No naming strategy available, project=" + project + ", composite=" + composite + ", componentType=" + componentType);
+
+ String proposition = ComponentNamingUtil.generateProposition(graph, composite, componentType);
+ List<String> validated = strategy.validateInstanceNames(graph, configurationRoot, Collections.singletonList(proposition), true, externallyReserved);
+ proposition = validated.get(0);
+
+ return proposition;
+ }
+
+ /**
+ * @param graph
+ * @param project
+ * @param configurationRoot
+ * @param propositions
+ * @param externallyReserved
+ * @return
+ * @throws DatabaseException
+ * @throws NamingException
+ */
+ public static final List<String> validateInstanceNames(
+ ReadGraph graph,
+ IProject project,
+ Resource configurationRoot,
+ List<String> propositions,
+ boolean acceptProposition,
+ Set<String> externallyReserved)
+ throws DatabaseException, NamingException
+ {
+ ComponentNamingStrategy strategy = findNamingStrategy(graph, project, configurationRoot);
+ if (strategy == null)
+ throw new NamingException("No naming strategy available, project=" + project);
+ return strategy.validateInstanceNames(graph, configurationRoot, propositions, acceptProposition, externallyReserved);
+ }
+
+ /**
+ * This is a fallback name generation method that deduces propositions
+ * container-locally based on component type prefixes or names.
+ *
+ * @param graph
+ * @param composite
+ * @param componentType
+ * @return
+ * @throws DatabaseException
+ */
+ private static String fallbackNameGeneration(ReadGraph graph, Resource container, Resource componentType)
+ throws DatabaseException {
+ return NameUtils.findFreshName(graph, generateProposition(graph, container, componentType), container);
+ }
+
+ public static String generateProposition(ReadGraph graph, String containerGeneratedNamePrefix, Resource componentType) throws DatabaseException {
+ Layer0X L0X = Layer0X.getInstance(graph);
+ StringBuilder proposition = new StringBuilder();
+ if (containerGeneratedNamePrefix != null)
+ proposition.append(containerGeneratedNamePrefix);
+ String componentPrefix = graph.getPossibleRelatedValue(componentType, L0X.HasGeneratedNamePrefix, Bindings.STRING);
+ if (componentPrefix == null) {
+ Layer0 L0 = Layer0.getInstance(graph);
+ componentPrefix = graph.getPossibleRelatedValue(componentType, L0.HasName);
+ if (componentPrefix == null)
+ componentPrefix = "Entity";
+ }
+ proposition.append(componentPrefix);
+ return proposition.toString();
+ }
+
+ public static String generateProposition(ReadGraph graph, Resource container, Resource componentType) throws DatabaseException {
+ Layer0X L0X = Layer0X.getInstance(graph);
+ String containerPrefix = graph.getPossibleRelatedValue(container, L0X.HasGeneratedNamePrefix, Bindings.STRING);
+ return generateProposition(graph, containerPrefix != null ? containerPrefix : "", componentType);
+ }
+
+ public static final ComponentNamingStrategy findNamingStrategy(ReadGraph graph, IProject project, Resource composite) throws DatabaseException {
+ // Primarily, use naming function from composite
+ ComponentNamingStrategy strategy = graph.syncRequest(
+ new PossibleRelatedValueImplied2<ComponentNamingStrategy>(composite, StructuralResource2.getInstance(graph).Composite_namingFunction),
+ TransientCacheListener.<ComponentNamingStrategy>instance());
+ if (strategy == null && project != null) {
+ // If not available, try to find ComponentNamingStrategy for project
+ strategy = project.getHint(ComponentNamingStrategy.PROJECT_KEY);
+ }
+ return strategy;
+ }
+
+}
Code Review / simantics / platform.git / blobdiff