Welcome to mirror list, hosted at ThFree Co, Russian Federation.

IdentifierProvider.js « identifiers « src « core « platform - github.com/nasa/openmct.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 82c20b2194bbcac0ddd6eef72f7b638dc6f7a8a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2021, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

define(
    ["uuid", "./Identifier"],
    function (uuid, Identifier) {

        /**
         * Parses and generates domain object identifiers.
         * @param {string} defaultSpace the default persistence space
         * @constructor
         * @memberof {platform/core}
         */
        function IdentifierProvider(defaultSpace) {
            this.defaultSpace = defaultSpace;
        }

        /**
         * Generate a new domain object identifier. A persistence space
         * may optionally be included; if not specified, no space will
         * be encoded into the identifier.
         * @param {string} [space] the persistence space to encode
         *        in this identifier
         * @returns {string} a new domain object identifier
         */
        IdentifierProvider.prototype.generate = function (space) {
            var id = uuid();
            if (space !== undefined) {
                id = space + ":" + id;
            }

            return id;
        };

        /**
         * Parse a domain object identifier to examine its component
         * parts (e.g. its persistence space.)
         * @returns {platform/core.Identifier} the parsed identifier
         */
        IdentifierProvider.prototype.parse = function (id) {
            return new Identifier(id, this.defaultSpace);
        };

        return IdentifierProvider;
    }
);