Package com.comsol.api.database

Class DatabaseApiValueFactory

  • public final class DatabaseApiValueFactory
extends java.lang.Object
    Factory for creating various value types in the Model Manager database API.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BranchKey branchKey​(java.lang.String value)
      Create a key used to uniquely identify a branch in a repository.
      static CommitKey commitKey​(java.lang.String value)
      Create a key used to uniquely identify a saved commit in a branch.
      static DatabaseConfigurationKey databaseConfigurationKey​(java.lang.String value)
      Create a key used to uniquely identify a configuration for a Model Manager database.
      static DatabaseKey databaseKey​(java.lang.String value)
      Create a key used to uniquely identify a Model Manager database.
      static FileResourcePath fileResourcePath​(java.lang.String... fileResourcePathSegments)
      Create a new file resource path from the provided file resource path segments.
      static FileResourcePath fileResourcePathOfLocationUri​(java.lang.String fileLocationUri)
      Extract the file resource path from the provided file location URI.
      static ItemKey generateItemKey​(ItemType itemType)
      Generate a new key to uniquely identify an item (a tag, model, or a file) in a Model Manager database.
      static ItemVersionKey generateItemVersionKey​(ItemType itemType)
      Generate a new key to uniquely identify a specific version of an item (a tag, model, or a file) in a Model Manager database.
      static ItemKey itemKey​(ItemType itemType, java.lang.String value)
      Create a key to uniquely identify an item (a tag, model, or a file) in a Model Manager database.
      static ItemVersionKey itemVersionKey​(ItemType itemType, java.lang.String value)
      Create a key to uniquely identify a specific version of an item (a tag, model, or a file) in a Model Manager database.
      static RepositoryKey repositoryKey​(java.lang.String value)
      Create a key used to uniquely identify a repository in a Model Manager database.
      static SnapshotKey snapshotKey​(java.lang.String value)
      Create a key used to uniquely identify a snapshot in a repository.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DatabaseApiValueFactory

        private DatabaseApiValueFactory()

    • Method Detail

      • branchKey

        public static BranchKey branchKey​(java.lang.String value)
        Create a key used to uniquely identify a branch in a repository.
        Parameters:
        value - The raw string value for the key.
        Returns:
        A new key.

      • commitKey

        public static CommitKey commitKey​(java.lang.String value)
        Create a key used to uniquely identify a saved commit in a branch.
        Parameters:
        value - The raw string value for the key.
        Returns:
        A new key.

      • databaseConfigurationKey

        public static DatabaseConfigurationKey databaseConfigurationKey​(java.lang.String value)
        Create a key used to uniquely identify a configuration for a Model Manager database.
        Parameters:
        value - The raw string value for the key.
        Returns:
        A new key.

      • databaseKey

        public static DatabaseKey databaseKey​(java.lang.String value)
        Create a key used to uniquely identify a Model Manager database.
        Parameters:
        value - The raw string value for the key.
        Returns:
        A new key.

      • generateItemKey

        public static ItemKey generateItemKey​(ItemType itemType)
        Generate a new key to uniquely identify an item (a tag, model, or a file) in a Model Manager database.
        Parameters:
        itemType - The type of the item.
        Returns:
        A new key.
        Since:
        6.3

      • generateItemVersionKey

        public static ItemVersionKey generateItemVersionKey​(ItemType itemType)
        Generate a new key to uniquely identify a specific version of an item (a tag, model, or a file) in a Model Manager database.
        Parameters:
        itemType - The type of the item.
        Returns:
        A new key.
        Since:
        6.3

      • itemKey

        public static ItemKey itemKey​(ItemType itemType,
                              java.lang.String value)
        Create a key to uniquely identify an item (a tag, model, or a file) in a Model Manager database.
        Parameters:
        itemType - The type of the item.
        value - The raw string value for the key.
        Returns:
        A new key.

      • itemVersionKey

        public static ItemVersionKey itemVersionKey​(ItemType itemType,
                                            java.lang.String value)
        Create a key to uniquely identify a specific version of an item (a tag, model, or a file) in a Model Manager database.
        Parameters:
        itemType - The type of the item.
        value - The raw string value for the key.
        Returns:
        A new key.

      • repositoryKey

        public static RepositoryKey repositoryKey​(java.lang.String value)
        Create a key used to uniquely identify a repository in a Model Manager database.
        Parameters:
        value - The raw string value for the key.
        Returns:
        A new key.

      • snapshotKey

        public static SnapshotKey snapshotKey​(java.lang.String value)
        Create a key used to uniquely identify a snapshot in a repository.
        Parameters:
        value - The raw string value for the key.
        Returns:
        A new key.

      • fileResourcePath

        public static FileResourcePath fileResourcePath​(java.lang.String... fileResourcePathSegments)
        Create a new file resource path from the provided file resource path segments. Pass an empty array to create a file resource path that corresponds to the root directory for all file resources belonging to a file version.
        Parameters:
        fileResourcePathSegments - A sequence of relative path segments for the file resource path. May be an empty array.
        Returns:
        A new file resource path.

      • fileResourcePathOfLocationUri

        public static FileResourcePath fileResourcePathOfLocationUri​(java.lang.String fileLocationUri)
        Extract the file resource path from the provided file location URI.
        Parameters:
        fileLocationUri - A location URI identifying the location of a file version in a database.
        Returns:
        The file resource path of the provided file location URI.
        Since:
        6.4