bundles/org.simantics.document.server/src/org/simantics/document/server/DocumentServerUtils.java

   1 package org.simantics.document.server;
   2
   3 import java.util.ArrayList;
   4 import java.util.Collection;
   5 import java.util.Collections;
   6 import java.util.Set;
   7 import java.util.SortedMap;
   8 import java.util.TreeMap;
   9
  10 import org.simantics.databoard.Bindings;
  11 import org.simantics.db.ReadGraph;
  12 import org.simantics.db.Resource;
  13 import org.simantics.db.common.request.UnaryRead;
  14 import org.simantics.db.exception.DatabaseException;
  15 import org.simantics.db.layer0.request.VariableRead;
  16 import org.simantics.db.layer0.variable.ProxyChildVariable;
  17 import org.simantics.db.layer0.variable.Variable;
  18 import org.simantics.db.layer0.variable.Variables;
  19 import org.simantics.document.base.ontology.DocumentationResource;
  20 import org.simantics.document.server.Functions.RootVariable;
  21 import org.simantics.structural2.variables.Connection;
  22 import org.simantics.structural2.variables.VariableConnectionPointDescriptor;
  23 import org.simantics.utils.datastructures.Pair;
  24 import org.simantics.utils.strings.AlphanumComparator;
  25
  26 public class DocumentServerUtils {
  27
  28     public static Collection<Variable> getChildren(ReadGraph graph, Variable variable) throws DatabaseException {
  29
  30         DocumentationResource DOC = DocumentationResource.getInstance(graph);
  31
  32                 ArrayList<Variable> result = new ArrayList<Variable>();
  33                 for(Variable property : variable.getProperties(graph)) {
  34                         Collection<String> classifications = property.getPossiblePropertyValue(graph, Variables.CLASSIFICATIONS);
  35                         if(classifications != null) {
  36                                 if(classifications.contains(DocumentationResource.URIs.Document_ChildRelation)) {
  37                                         Connection conn = property.getValue(graph);
  38                                         Variable childConnectionPoint = DocumentServerUtils.getPossibleOtherConnectionPoint(graph, property, conn);
  39                                         if(childConnectionPoint != null) {
  40                                                 result.add(childConnectionPoint.getParent(graph));
  41                                         }
  42                                 } else if (DOC.Relations_partN.equals(property.getPossiblePredicateResource(graph))) {
  43                                         Connection conn = property.getValue(graph);
  44                                         for (Variable childConnectionPoint : DocumentServerUtils.getOtherConnectionPoints(graph, property, conn)) {
  45                                                 result.add(childConnectionPoint.getParent(graph));
  46                                         }
  47                                 }
  48                         }
  49                 }
  50                 return result;
  51
  52         }
  53
  54         public static String findManualOrdinal(ReadGraph graph, Variable v) throws DatabaseException {
  55                 DocumentationResource DOC = DocumentationResource.getInstance(graph);
  56                 Integer j = null;
  57                 while (j == null && v != null) {
  58                         j = v.getPossiblePropertyValue(graph, DOC.Components_Component_manualOrdinal);
  59                         v = v.getParent(graph);
  60                 }
  61                 if (j != null) {
  62                         return Integer.toString(j);
  63                 } else {
  64                         return null;
  65                 }
  66         }
  67
  68     public static Collection<Variable> getChildrenInOrdinalOrder(ReadGraph graph, Variable variable) throws DatabaseException {
  69         DocumentationResource DOC = DocumentationResource.getInstance(graph);
  70
  71                 SortedMap<String, Variable> childMap = new TreeMap<String, Variable>(AlphanumComparator.COMPARATOR);
  72
  73                 for(Variable property : variable.getProperties(graph)) {
  74                         Collection<String> classifications = property.getPossiblePropertyValue(graph, Variables.CLASSIFICATIONS);
  75                         if(classifications != null) {
  76                                 if(classifications.contains(DocumentationResource.URIs.Document_ChildRelation)) {
  77                                         Resource cp = property.getPossiblePredicateResource(graph);
  78                                         String i = graph.getRelatedValue(cp, DOC.Document_ChildRelation_ordinal, Bindings.STRING);
  79
  80                                         Connection conn = property.getValue(graph);
  81                                         Variable childConnectionPoint = DocumentServerUtils.getPossibleOtherConnectionPoint(graph, property, conn);
  82                                         if(childConnectionPoint != null) {
  83                                                 childMap.put(i, childConnectionPoint.getParent(graph));
  84                                         }
  85                                 } else if (DOC.Relations_partN.equals(property.getPossiblePredicateResource(graph))) {
  86                                         Connection conn = property.getValue(graph);
  87
  88                                         for (Variable childConnectionPoint : DocumentServerUtils.getOtherConnectionPoints(graph, property, conn)) {
  89                                                 Variable child = childConnectionPoint.getParent(graph);
  90                                                 String i = findManualOrdinal(graph, child);
  91                                                 if (i == null) {
  92                                                         i = "0";
  93                                                 }
  94                                                 childMap.put(i, child);
  95                                         }
  96                                 }
  97                         }
  98                 }
  99                 return childMap.values();
 100
 101         }
 102
 103         public static Collection<Variable> collectNodes(ReadGraph graph, Variable variable, Collection<Variable> nodes) throws DatabaseException {
 104
 105                 DocumentationResource DOC = DocumentationResource.getInstance(graph);
 106
 107                 Resource type = variable.getPossibleType(graph);
 108                 if(type == null) return nodes;
 109
 110                 if(!graph.isInheritedFrom(type, DOC.Components_Component)) return nodes;
 111
 112                 Boolean enabled = variable.getPossiblePropertyValue(graph, DOC.Properties_exists, Bindings.BOOLEAN);
 113                 if(enabled != null && !enabled) return nodes;
 114
 115                 if(graph.isInheritedFrom(type, DOC.Components_PrimitiveComponent)) {
 116                         nodes.add(variable);
 117                 } else {
 118                         for(Variable child : variable.getChildren(graph)) {
 119                                 collectNodes(graph, child, nodes);
 120                         }
 121                 }
 122
 123                 return nodes;
 124
 125         }
 126
 127         public static Variable getPossibleOtherConnectionPoint(ReadGraph graph, Variable connectionPoint, Connection conn) throws DatabaseException {
 128
 129                 Collection<VariableConnectionPointDescriptor> descs = conn.getConnectionPointDescriptors(graph, null);
 130                 if(descs.size() != 2) return null;
 131
 132                 for(VariableConnectionPointDescriptor desc : descs) {
 133                         if(desc.isFlattenedFrom(graph, connectionPoint)) continue;
 134                         return desc.getVariable(graph);
 135                 }
 136
 137                 return null;
 138
 139         }
 140
 141         public static Collection<Variable> getOtherConnectionPoints(ReadGraph graph, Variable connectionPoint, Connection conn) throws DatabaseException {
 142
 143                 ArrayList<Variable> connectionPoints = new ArrayList<Variable>();
 144
 145                 Collection<VariableConnectionPointDescriptor> descs = conn.getConnectionPointDescriptors(graph, null);
 146
 147                 for(VariableConnectionPointDescriptor desc : descs) {
 148                         if(desc.isFlattenedFrom(graph, connectionPoint)) continue;
 149                         connectionPoints.add(desc.getVariable(graph));
 150                 }
 151
 152                 return connectionPoints;
 153
 154         }
 155
 156         public static Variable getPossibleCommandTriggerConnectionPoint(ReadGraph graph, Variable connectionPoint, Connection conn) throws DatabaseException {
 157
 158                 Collection<Variable> cpts = conn.getConnectionPoints(graph, null);
 159
 160                 Variable result = null;
 161
 162                 for(Variable cpt : cpts) {
 163                         Set<String> classifications = cpt.getClassifications(graph);
 164                         if(classifications.contains(DocumentationResource.URIs.Relations_commandExecutorRelation)) {
 165                                 if(result != null) throw new DatabaseException("Multiple executor connection points in command connection");
 166                                 result = cpt;
 167                         }
 168                 }
 169
 170                 return result;
 171
 172         }
 173
 174         public static Collection<Variable> getPossibleOtherConnectionPoints(ReadGraph graph, Variable connectionPoint, Connection conn) throws DatabaseException {
 175
 176             Collection<Variable> cpts = conn.getConnectionPoints(graph, null);
 177             if(cpts.size() < 2)
 178                 return Collections.emptyList();
 179
 180             ArrayList<Variable> result = new ArrayList<Variable>();
 181             for(Variable cpt : cpts) {
 182                 if(!cpt.equals(connectionPoint))
 183                     result.add(cpt);
 184             }
 185             return result;
 186         }
 187
 188         public static String getId(ReadGraph graph, Variable node) throws DatabaseException {
 189
 190                 if(node == null) return "root";
 191                 else {
 192                         String uri = node.getURI(graph);
 193                         int l = uri.lastIndexOf(ProxyChildVariable.CONTEXT_END);
 194                         return uri.substring(l+4);
 195                 }
 196
 197         }
 198
 199         public static class DocumentValue extends VariableRead<Object> {
 200
 201                 public DocumentValue(Variable variable) {
 202                         super(variable);
 203                 }
 204
 205                 @Override
 206                 public Object perform(ReadGraph graph) throws DatabaseException {
 207                         return variable.getValue(graph);
 208                 }
 209
 210                 @Override
 211                 public String toString() {
 212                         return "DocumentValue[" + variable + "]";
 213                 }
 214
 215         }
 216
 217         public static Object getValue(ReadGraph graph, Variable attrib) throws DatabaseException {
 218                 return graph.syncRequest(new DocumentValue(attrib));
 219         }
 220
 221         public static Variable getParentConnectionPoint(ReadGraph graph, Variable component) throws DatabaseException {
 222
 223                 Variable connectionPoint = component.getPossibleProperty(graph, "parent");
 224                 if(connectionPoint == null) {
 225                         DocumentationResource DOC = DocumentationResource.getInstance(graph);
 226                         Collection<Variable> cps = component.getProperties(graph, DOC.Relations_parentRelation);
 227                         if(cps.size() == 1) {
 228                                 connectionPoint = cps.iterator().next();
 229                         } else {
 230                                 return null;
 231                         }
 232                 }
 233
 234                 Connection conn = connectionPoint.getValue(graph);
 235                 Variable otherCp = DocumentServerUtils.getPossibleOtherConnectionPoint(graph, connectionPoint, conn);
 236                 if (otherCp != null) {
 237                         return otherCp;
 238                 } else {
 239                         Variable parentCp = graph.sync(new UnaryRead<Connection, Variable>(conn) {
 240                     @Override
 241                     public Variable perform(ReadGraph graph) throws DatabaseException {
 242                         DocumentationResource DOC = DocumentationResource.getInstance(graph);
 243                         Collection<VariableConnectionPointDescriptor> descs = parameter.getConnectionPointDescriptors(graph, null);
 244
 245                                 for(VariableConnectionPointDescriptor desc : descs) {
 246                                         if (DOC.Relations_partN.equals(desc.getConnectionPointResource(graph))) {
 247                                                 return desc.getVariable(graph);
 248                                         }
 249                                 }
 250                                 return null;
 251                     }
 252                 });
 253                         if (parentCp != null) {
 254                                 return parentCp;
 255                         }
 256                 }
 257                 return null;
 258
 259         }
 260
 261         /* Children */
 262         public static Collection<Variable> getChildConnections(ReadGraph graph, Variable variable) throws DatabaseException {
 263                 return variable.getProperties(graph, DocumentationResource.getInstance(graph).Document_ChildRelation);
 264         }
 265
 266         /* Command sequence */
 267         public static Collection<Variable> getTriggerCommands(ReadGraph graph, Variable variable) throws DatabaseException {
 268                 ArrayList<Variable> result = new ArrayList<Variable>();
 269                 DocumentationResource DOC = DocumentationResource.getInstance(graph);
 270                 for(Variable var : variable.getProperties(graph, DOC.Document_CommandRelation)) {
 271             if(DOC.Relations_broadcasted.equals(var.getPredicateResource(graph))) continue;
 272             result.add(var);
 273                 }
 274                 return result;
 275         }
 276
 277         public static Collection<Variable> getCommands(ReadGraph graph, Variable variable) throws DatabaseException {
 278                 return variable.getProperties(graph, DocumentationResource.getInstance(graph).Document_CommandRelation);
 279         }
 280
 281         /* Data definition */
 282         public static Collection<Variable> getDataDefinitions(ReadGraph graph, Variable variable) throws DatabaseException {
 283                 return variable.getProperties(graph, DocumentationResource.getInstance(graph).Document_DataDefinitionRelation);
 284         }
 285
 286         /* Data relation */
 287         public static Collection<Variable> getDataRelations(ReadGraph graph, Variable variable) throws DatabaseException {
 288                 return variable.getProperties(graph, DocumentationResource.getInstance(graph).Document_DataRelation);
 289         }
 290
 291         /* Attributes */
 292         public static Collection<Variable> getAttributes(ReadGraph graph, DocumentationResource DOC, Variable variable) throws DatabaseException {
 293                 return variable.getProperties(graph, DOC.Document_AttributeRelation);
 294         }
 295
 296         static class AttributesRequest extends VariableRead<Pair<Collection<Variable>, Collection<Variable>>> {
 297
 298                 public AttributesRequest(Variable variable) {
 299                         super(variable);
 300                 }
 301
 302                 @Override
 303                 public Pair<Collection<Variable>,Collection<Variable>> perform(ReadGraph graph) throws DatabaseException {
 304                 ArrayList<Variable> statics = new ArrayList<Variable>();
 305                 ArrayList<Variable> dynamics = new ArrayList<Variable>();
 306                 DocumentationResource DOC = DocumentationResource.getInstance(graph);
 307                 for(Variable property : getAttributes(graph, DOC, variable)) {
 308                         Boolean defaultProperty = property.getPossiblePropertyValue(graph, "default");
 309                         if(defaultProperty != null && defaultProperty) {
 310 //                              System.err.println("" + property.getURI(graph) + " is default");
 311                                 continue;
 312                         }
 313 //                      else {
 314 //                              System.err.println("" + property.getURI(graph) + " is not default");
 315 //                      }
 316                         Boolean dynamicProperty = property.getPossiblePropertyValue(graph, DOC.Document_AttributeRelation_dynamic);
 317                         if(dynamicProperty != null && dynamicProperty) dynamics.add(property);
 318                         else statics.add(property);
 319                 }
 320                 return new Pair<Collection<Variable>, Collection<Variable>>(statics, dynamics);
 321                 }
 322
 323         }
 324
 325     public static Collection<Variable> getStaticAttributes(ReadGraph graph, DocumentationResource DOC, Variable variable) throws DatabaseException {
 326         Pair<Collection<Variable>, Collection<Variable>> attribs = graph.syncRequest(new AttributesRequest(variable));
 327         return attribs.first;
 328     }
 329
 330         public static Collection<Variable> getDynamicAttributes(ReadGraph graph, final DocumentationResource DOC, Variable variable) throws DatabaseException {
 331         Pair<Collection<Variable>, Collection<Variable>> attribs = graph.syncRequest(new AttributesRequest(variable));
 332         return attribs.second;
 333         }
 334
 335         public static Variable getPossibleDocumentRootVariable(ReadGraph graph, Variable documentPart) throws DatabaseException {
 336                 if(documentPart instanceof RootVariable) return documentPart;
 337                 Variable parent = documentPart.getParent(graph);
 338                 if(parent == null) return null;
 339                 return getPossibleDocumentRootVariable(graph, parent);
 340         }
 341
 342 }