1 import "JavaBuiltin" as Java
2 include "http://www.simantics.org/Layer0-1.1" as L0
9 "org.simantics.db.ReadGraph"
13 "org.simantics.db.WriteGraph"
15 importJava "org.simantics.db.Resource" where
16 "A resource is a node in a semantic graph."
19 "Returns the 64-bit unique identifier of the resource."
20 @JavaName getResourceId
21 resourceId :: Resource -> Long
23 isPersistent :: Resource -> Boolean
25 importJava "org.simantics.db.ReadGraph" where
28 instance Ord Resource where
29 compare a b = compare (resourceId a) (resourceId b)
31 instance Show Resource where
32 show r = "#" + show (resourceId r)
34 instance Show Statement where
35 show s = "#" + show (resourceId ( subjectOf s)) + "#" + show (resourceId ( predicateOf s)) + "#" + show (resourceId ( objectOf s))
37 importJava "org.simantics.db.Statement" where
38 "A statement is an edge in a semantic graph."
42 subjectOf :: Statement -> Resource
43 @JavaName getPredicate
44 predicateOf :: Statement -> Resource
46 objectOf :: Statement -> Resource
48 isAsserted :: Statement -> Resource -> <ReadGraph> Boolean
50 importJava "org.simantics.db.ReadGraph" where
51 "Converts an absolute URI to a resource or returns `Nothing` if there is no such resource."
52 @JavaName getPossibleResource
53 possibleResource :: String -> <ReadGraph> (Maybe Resource)
55 getDataType :: Resource -> <ReadGraph> Datatype
57 @JavaName getSupertypes
58 superTypesOf :: Resource -> <ReadGraph> Set.T Resource
62 uriOfResource :: Resource -> <ReadGraph> String
65 @JavaName getPossibleURI
66 possibleUriOfResource :: Resource -> <ReadGraph> Maybe String
69 objects_ :: Resource -> Resource -> <ReadGraph> Collection Resource
71 @JavaName getStatements
72 statements_ :: Resource -> Resource -> <ReadGraph> Collection Statement
74 @JavaName hasStatement
75 existsStatement :: Resource -> Resource -> <ReadGraph> Boolean
77 @JavaName hasStatement
78 existsStatement3 :: Resource -> Resource -> Resource -> <ReadGraph> Boolean
80 "Assumes that there is exactly one object with the given subject and predicate and returns it."
81 @JavaName getSingleObject
82 singleObject :: Resource -> Resource -> <ReadGraph> Resource
85 If there is exactly one object with the given `subject` and `predicate`,
86 `possibleObject subject predicate` returns it. Otherwise, it returns
89 @JavaName getPossibleObject
90 possibleObject :: Resource -> Resource -> <ReadGraph> Maybe Resource
92 "Assumes that there is exactly one statement with the given subject and predicate and returns it."
93 @JavaName getSingleStatement
94 singleStatement :: Resource -> Resource -> <ReadGraph> Statement
96 @JavaName getPossibleStatement
97 possibleStatement :: Resource -> Resource -> <ReadGraph> Maybe Statement
99 @JavaName getRelatedVariantValue
100 relatedVariantValue :: Resource -> Resource -> <ReadGraph> Variant
102 @JavaName getRelatedValue
103 relatedValue_ :: Resource -> Resource -> Binding a -> <ReadGraph> a
105 @JavaName getRelatedValue
106 untypedRelatedValue :: Resource -> Resource -> <ReadGraph> a
108 @JavaName getRelatedValue2
109 relatedValue2 :: Resource -> Resource -> <ReadGraph> a
111 @JavaName getPossibleRelatedValue2
112 possibleRelatedValue2 :: Resource -> Resource -> <ReadGraph> Maybe a
114 @JavaName getRelatedVariantValue2
115 relatedVariantValue2 :: Resource -> Resource -> <ReadGraph> Variant
117 @JavaName getPossibleRelatedValue
118 possibleRelatedValue_ :: Resource -> Resource -> Binding a -> <ReadGraph> Maybe a
120 @JavaName getPossibleRelatedValue
121 untypedPossibleRelatedValue :: Resource -> Resource -> <ReadGraph> Maybe a
125 valueOf_ :: Resource -> Binding a -> <ReadGraph> a
128 @JavaName getVariantValue
129 variantValueOf_ :: Resource -> <ReadGraph> Variant
132 untypedValueOf :: Resource -> <ReadGraph> Dynamic
134 @JavaName getPossibleValue
135 untypedPossibleValueOf :: Resource -> <ReadGraph> Maybe Dynamic
138 inverseOf :: Resource -> <ReadGraph> Resource
139 @JavaName getPossibleInverse
140 possibleInverseOf :: Resource -> <ReadGraph> Maybe Resource
142 @JavaName getSingleType
143 singleTypeOf :: Resource -> Resource -> <ReadGraph> Resource
145 @JavaName getPossibleType
146 possibleTypeOf :: Resource -> Resource -> <ReadGraph> Maybe Resource
148 "`isInstanceOf r t` returns true, if `r` is an instance of `t`"
149 isInstanceOf :: Resource -> Resource -> <ReadGraph> Boolean
150 isSubrelationOf :: Resource -> Resource -> <ReadGraph> Boolean
151 isInheritedFrom :: Resource -> Resource -> <ReadGraph> Boolean
153 getRootLibrary :: () -> <ReadGraph> Resource
155 @JavaName getPredicates
156 predicatesOf :: Resource -> <ReadGraph> [Resource]
158 isImmutable :: Resource -> <ReadGraph> Boolean
160 importJava "org.simantics.db.layer0.util.ExtendedUris" where
161 "Converts an absolute URI to a resource"
162 @JavaName resolveAbsoluteUri
163 resource :: String -> <ReadGraph> Resource
165 "Converts a relative URI to a resource starting from the given resource"
166 @JavaName resolveRelativeUri
167 relativeResource :: Resource -> String -> <ReadGraph> Resource
169 "Reads the value of a literal that is an object with the given subject and predicate"
171 relatedValue :: Serializable a => Resource -> Resource -> <ReadGraph> a
172 relatedValue s p = relatedValue_ s p binding
175 possibleRelatedValue :: Serializable a => Resource -> Resource -> <ReadGraph> Maybe a
176 possibleRelatedValue s p = possibleRelatedValue_ s p binding
178 class Browsable a where
179 fromUri :: String -> <ReadGraph> a
181 "Returns the URI of the given value."
182 uriOf :: a -> <ReadGraph> String
184 "Returns the URI of the given value if it exists or Nothing."
185 possibleUriOf :: a -> <ReadGraph> Maybe String
187 "Reads the name of the value."
188 nameOf :: a -> <ReadGraph> String
189 possibleNameOf :: a -> <ReadGraph> Maybe String
191 valueOf :: Serializable v => a -> <ReadGraph> v
193 genericRelatedValue :: a -> Resource -> <ReadGraph> t
194 genericPossibleRelatedValue :: a -> Resource -> <ReadGraph> Maybe t
196 variantValueOf :: a -> <ReadGraph> Variant
198 children :: a -> <ReadGraph> [a]
199 parent :: a -> <ReadGraph> a
200 possibleParent :: a -> <ReadGraph> Maybe a
202 child :: a -> String -> <ReadGraph> a
203 possibleChild :: a -> String -> <ReadGraph> Maybe a
205 instance Browsable Resource where
207 uriOf = uriOfResource
208 possibleUriOf = possibleUriOfResource
209 nameOf r = relatedValue r L0.HasName
210 possibleNameOf r = possibleRelatedValue r L0.HasName
212 valueOf r = valueOf_ r binding
213 variantValueOf = variantValueOf_
215 genericRelatedValue = relatedValue2
216 genericPossibleRelatedValue = possibleRelatedValue2
218 children r = r # L0.ConsistsOf
219 parent r = singleObject r L0.PartOf
220 possibleParent r = possibleObject r L0.PartOf
222 possibleChild = possibleResourceChild
223 child r n = fromJust (possibleResourceChild r n)
225 importJava "org.simantics.db.WriteOnlyGraph" where
226 markUndoPoint :: () -> <WriteGraph> ()
228 importJava "org.simantics.db.WriteGraph" where
229 "Creates a new resource."
230 newResource :: () -> <WriteGraph> Resource
231 "Adds a statement to the semantic graph."
232 claim :: Resource -> Resource -> Resource -> <WriteGraph> ()
234 claimWithInverse :: Resource -> Resource -> Maybe Resource -> Resource -> <WriteGraph> ()
235 @JavaName claimLiteral
236 claimRelatedValue_ :: Resource -> Resource -> a -> Binding a -> <WriteGraph> ()
237 @JavaName claimLiteral
238 untypedClaimRelatedValue :: Resource -> Resource -> a -> <WriteGraph> ()
240 untypedClaimValue :: Resource -> a -> <WriteGraph> ()
241 @JavaName claimLiteral
242 claimRelatedValueWithType_ :: Resource -> Resource -> Resource -> a -> Binding a -> <WriteGraph> ()
243 "Removes a statement with the given subject, predicate and object"
244 deny :: Resource -> Resource -> Resource -> <WriteGraph> ()
246 denyByPredicate :: Resource -> Resource -> <WriteGraph> ()
248 denyAllStatements :: Resource -> <WriteGraph> ()
249 newClusterSet :: Resource -> <WriteGraph> ()
251 denyValue :: Resource -> <WriteGraph> ()
253 claimAssertion :: Resource -> Resource -> Resource -> <WriteGraph> ()
254 claimAssertion type_ predicate object = do
256 claim ass L0.HasPredicate predicate
257 claim ass L0.HasObject object
258 claim type_ L0.Asserts ass
260 "Sets the value of the literal that is an object with the given subject and predicate."
262 claimRelatedValue :: Serializable a => Resource -> Resource -> a -> <WriteGraph> ()
263 claimRelatedValue s p v = claimRelatedValue_ s p v binding
266 claimRelatedValueWithType :: Serializable a => Resource -> Resource -> Resource -> a -> <WriteGraph> ()
267 claimRelatedValueWithType s p t v = claimRelatedValueWithType_ s p t v binding
269 importJava "org.simantics.layer0.utils.direct.GraphUtils" where
270 @JavaName getPossibleChild
271 possibleResourceChild :: Resource -> String -> <ReadGraph> (Maybe Resource)
273 @deprecated "Use function children instead."
274 resourceChildrenOf :: Resource -> <ReadGraph> [Resource]
275 resourceChildrenOf r = r # L0.ConsistsOf
277 importJava "org.simantics.db.common.utils.OrderedSetUtils" where
279 addToOrderedSet :: Resource -> Resource -> <WriteGraph> Boolean
282 setOrderedSet :: Resource -> [Resource] -> <WriteGraph> Boolean
284 @JavaName getSingleOwnerList
285 parentOrderedSet :: Resource -> <ReadGraph> Resource
288 elementsOfOrderedSet :: Resource -> <ReadGraph> [Resource]
290 importJava "org.simantics.db.common.utils.ListUtils" where
291 "`elementsOfList l` returns elements of list `l`"
293 elementsOfList :: Resource -> <ReadGraph> [Resource]
295 "`createList [e]` creates a new list containing elements `[e]`"
297 createList :: [Resource] -> <WriteGraph> Resource
299 "`createListWithType t [e]` creates a new list with type `t` containing elements `[e]`"
301 createListWithType :: Resource -> [Resource] -> <WriteGraph> Resource
303 "`insertListBack l [e]` inserts elements `[e]` back to the list `l`"
305 insertListBack :: Resource -> [Resource] -> <WriteGraph> ()
307 "`insertListFront l [e]` inserts elements `[e]` front of the list `l`"
308 @JavaName insertFront
309 insertListFront :: Resource -> [Resource] -> <WriteGraph> ()
311 "`removeListElement l e` removes a element `e` from the list `l`"
312 @JavaName removeElement
313 removeListElement :: Resource -> Resource -> <WriteGraph> Boolean
315 @JavaName swapWithPrevious
316 swapListElementWithPrevious :: Resource -> Resource -> <WriteGraph> Boolean
318 @JavaName swapWithNext
319 swapListElementWithNext :: Resource -> Resource -> <WriteGraph> Boolean
322 importJava "org.simantics.db.common.utils.CommonDBUtils" where
323 isParent :: Resource -> Resource -> <ReadGraph> Boolean
324 possibleRelatedString :: Resource -> Resource -> <ReadGraph> Maybe String
325 possibleRelatedInteger :: Resource -> Resource -> <ReadGraph> Maybe Integer
326 objectsWithType :: Resource -> Resource -> Resource -> <ReadGraph> [Resource]
327 possibleObjectWithType :: Resource -> Resource -> Resource -> <ReadGraph> Maybe Resource
329 importJava "org.simantics.db.common.utils.NameUtils" where
330 findFreshName :: String -> Resource -> <ReadGraph> String
331 findFreshEscapedName :: String -> Resource -> <ReadGraph> String
333 "`subject # predicate` returns all objects with the given `subject` and `predicate`."
334 (#) :: Resource -> Resource -> <ReadGraph> [Resource]
335 subject # predicate = collectionToList $ objects_ subject predicate
337 "statements subject predicate` returns all statements with the given subject and predicate."
338 statements :: Resource -> Resource -> <ReadGraph> [Statement]
339 statements subject predicate = collectionToList $ statements_ subject predicate
341 importJava "org.simantics.scl.db.SCLFunctions" where
342 "Executes a read transaction and waits that it completes."
343 syncRead :: (() -> <Proc,ReadGraph> a) -> <Proc> a
344 "Executes a write transaction and waits that it completes."
345 syncWrite :: (() -> <Proc,ReadGraph,WriteGraph> a) -> <Proc> a
346 "Executes a delayed write transaction and waits that it completes."
347 delayedSyncWrite :: (() -> <Proc,WriteGraph> a) -> <Proc> a
349 "Begins a read transaction and immediately returns."
350 asyncRead :: (() -> <Proc,ReadGraph> a) -> <Proc> ()
351 "Begins a write transaction and immediately returns."
352 asyncWrite :: (() -> <Proc,ReadGraph,WriteGraph> a) -> <Proc> ()
354 virtualSyncWriteMem :: String -> (() -> <e,WriteGraph> a) -> <e,WriteGraph> a
355 virtualSyncWriteWS :: String -> (() -> <e,WriteGraph> a) -> <e,WriteGraph> a
357 safeExec :: (() -> <Proc> a) -> <Proc> a
358 activateOnce :: Resource -> <Proc> ()
359 syncActivateOnce :: Resource -> <WriteGraph, Proc> ()
360 resourceFromId :: Long -> <ReadGraph> Resource
361 enableDependencies :: () -> <WriteGraph> ()
362 disableDependencies :: () -> <WriteGraph> ()
364 unaryQuery :: (a -> <ReadGraph,e> b) -> a -> <ReadGraph> b
365 unaryQueryCached :: (a -> <ReadGraph,e> b) -> a -> <ReadGraph> b
367 "Makes a new read request with given procedure for calculating the result. The request is cached only if the current request is listened."
368 subquery :: (<ReadGraph,Proc> a) -> <ReadGraph,Proc> a
369 "Makes a new read request with given procedure for calculating the result. The request is always cached."
370 subqueryC :: (<ReadGraph,Proc> a) -> <ReadGraph,Proc> a
371 "Makes a new read asynchronous request with function to handle the request result. The last `isDisposed` function parameter is used to determine if the listener is still alive or not."
372 subqueryL :: (<ReadGraph,Proc> a) -> (a -> <ReadGraph, e> ()) -> (Throwable -> <ReadGraph, e> ()) -> (<e> Boolean) -> <ReadGraph, Proc, e> ()
373 "Tries to convert the given Dynamic value to a value with the inferred type"
374 possibleFromDynamic :: Typeable a => String -> Dynamic -> Maybe a
376 importJava "org.simantics.db.layer0.util.Layer0Utils" where
377 undo :: () -> <Proc> String
378 undoOperations :: Integer -> <Proc> String
379 redo :: () -> <Proc> String
380 queryDebugSupport :: String -> <Proc> String
381 queryListSupport :: String -> <Proc> String
382 addCommentMetadata :: String -> <WriteGraph> ()
383 sortByCluster :: [a] -> (a->Resource) -> <ReadGraph> [a]
384 makeSynchronous :: Boolean -> <ReadGraph> ()
385 listOntologies :: () -> <ReadGraph> [Resource]
386 emptyTrashBin :: () -> <Proc> ()
387 purgeDatabase :: () -> <Proc> ()
388 prettyPrintResource :: Resource -> Boolean -> <ReadGraph> String
392 copyTo_ :: Resource -> Resource -> <WriteGraph> Collection Resource
393 @JavaName getPossiblePredicateByName
394 possiblePredicateByName :: Resource -> String -> <ReadGraph> Maybe Resource
395 @JavaName getPossiblePredicateByNameFromType
396 possiblePredicateByNameFromType :: Resource -> String -> <ReadGraph> Maybe Resource
398 addMetadataListener :: ChangeListener -> <Proc> ()
399 removeMetadataListener :: ChangeListener -> <Proc> ()
401 copyTo :: Resource -> Resource -> <WriteGraph> Resource
402 copyTo targetContainer source = do
403 (collectionToList $ copyTo_ targetContainer source)!0
405 importJava "org.simantics.db.common.utils.CommonDBUtils" where
406 selectClusterSet :: Resource -> <WriteGraph> ()
408 importJava "org.simantics.Simantics" where
409 @JavaName getProjectResource
410 currentProject :: () -> /*<Proc>*/ Resource
412 // Move to somewhere more generic module
413 importJava "java.util.Collection" where
416 importJava "java.util.ArrayList" where
418 collectionToList :: Collection a -> [a]
420 collectionToList :: Collection a -> [a]
421 collectionToList x = Java.unsafeCoerce x
424 resourceToCollection :: a -> Collection a
425 resourceToCollection x = Java.unsafeCoerce x
427 newEntity :: [Resource -> <ReadGraph,WriteGraph> ()] -> <ReadGraph,WriteGraph> Resource
428 newEntity entitySpecs = do
429 entity = newResource ()
430 for entitySpecs (\spec -> spec entity)
433 updateEntity :: Resource -> [Resource -> <ReadGraph,WriteGraph> ()] -> <ReadGraph,WriteGraph> Resource
434 updateEntity entity entitySpecs = do
435 for entitySpecs (\spec -> spec entity)
438 hasStatement predicate object entity =
439 claim entity predicate object
440 hasProperty relation value entity =
441 claimRelatedValue entity relation value
442 hasPossibleProperty relation value entity =
444 Just v -> claimRelatedValue entity relation v
446 hasTypedProperty relation value t entity =
447 claimRelatedValueWithType entity relation t value
448 hasName (n :: String) = hasProperty L0.HasName n
449 hasLabel (l :: String) = hasProperty L0.HasLabel l
450 hasType t = hasStatement L0.InstanceOf t
451 hasParent p = hasStatement L0.PartOf p
453 importJava "org.simantics.databoard.util.URIStringUtils" where
454 @JavaName splitURISCL
455 splitURI :: String -> [String]
457 escapeURI :: String -> String
459 unescapeURI :: String -> String
462 importJava "org.simantics.db.layer0.request.ActiveModels" where
463 @JavaName getPossibleActiveModel
464 activeModel :: Resource -> <ReadGraph> Maybe Resource
466 "Gives the current active model."
467 currentModel :: <ReadGraph> Resource
468 currentModel = match activeModel (currentProject ()) with
470 Nothing -> fail "No active model."
472 "Gives the current active model if it exists or Nothing otherwise."
473 possibleCurrentModel :: <ReadGraph> Maybe Resource
474 possibleCurrentModel = activeModel (currentProject ())
476 startUndoPoint :: String -> <WriteGraph> ()
477 startUndoPoint string = do
479 addCommentMetadata (string)
483 lift1Read :: (a -> <ReadGraph,Proc> b) -> (a -> <Proc> b)
484 lift1Read f x = syncRead (\_ -> f x)
487 lift2Read :: (a -> b -> <ReadGraph,Proc> c) -> (a -> b -> <Proc> c)
488 lift2Read f x y = syncRead (\_ -> f x y)
491 lift3Read :: (a -> b -> c -> <ReadGraph,Proc> d) -> (a -> b -> c -> <Proc> d)
492 lift3Read f x y z = syncRead (\_ -> f x y z)
495 lift1Write :: (a -> <WriteGraph,Proc> b) -> (a -> <Proc> b)
496 lift1Write f x = syncWrite (\_ -> f x)
499 lift2Write :: (a -> b -> <WriteGraph,Proc> c) -> (a -> b -> <Proc> c)
500 lift2Write f x y = syncWrite (\_ -> f x y)
503 lift3Write :: (a -> b -> c -> <WriteGraph,Proc> d) -> (a -> b -> c -> <Proc> d)
504 lift3Write f x y z = syncWrite (\_ -> f x y z)
507 Returns a child Browsable of the specified parent that has that is the child
508 of the specified parent with the specified name path.
510 childWithPath :: Browsable a => a -> [String] -> <ReadGraph> a
511 childWithPath parent path =
512 foldl (\r name -> match possibleChild r name with
514 Nothing -> fail ("Didn't find " + name + ".")
519 Like `childWithPath` but returns Maybe a which will be `Nothing` if no child
522 possibleChildWithPath :: Browsable a => a -> [String] -> <ReadGraph> Maybe a
523 possibleChildWithPath parent path =
524 foldl (\r name -> match r with
525 Just c -> possibleChild c name
530 importJava "org.simantics.db.MetadataI" where
533 importJava "org.simantics.db.event.ChangeListener" where
536 importJava "org.simantics.db.layer0.genericrelation.DependencyChanges" where
537 data DependencyChanges