bundles/org.simantics.modeling/scl/Simantics/Rename.scl

   1 import "Simantics/Entity" hiding (findFreshName)
   2 include "Simantics/DB" (findFreshName)
   3
   4 importJava "org.simantics.modeling.Rename" where
   5     @JavaName renameNode
   6     """
   7         renameNode resource newName
   8
   9     Renames the given `resource` with the given `newName` and returns
  10     `string`
  11
  12     Example:
  13
  14         > renameNode resource "NewName"
  15         "Successfully renamed oldName to NewName"
  16
  17     or error if failed
  18     """
  19     renameNode :: Resource -> String -> <WriteGraph> String
  20
  21 """
  22     renameMBNode entity newName
  23
  24 Renames the given `entity` with the given `newName` and returns
  25 `string`
  26
  27 Example:
  28
  29     > renameMBNode entity "NewName"
  30     "Successfully renamed oldName to NewName"
  31
  32 or error if failed
  33 """
  34 @deprecated "This function is equivalent to renameNode."
  35 renameMBNode :: Resource -> String -> <WriteGraph> String
  36 renameMBNode entity newname = renameNode entity newname
  37
  38 importJava "org.simantics.db.common.utils.NameUtils" where
  39
  40     @JavaName getSafeName
  41     """
  42         getSafeName resource
  43
  44     Gets safe name for the given `resource` and returns the name
  45
  46     Example:
  47
  48         name = getSafeName (toResource model)
  49     """
  50     getSafeName :: Resource -> <ReadGraph> String