aboutsummaryrefslogtreecommitdiffstats
path: root/cps-path-parser/src/main/java/org/onap/cps/cpspath/parser/CpsPathQuery.java
blob: 418b5ec55b2ddda09e26da18537fe1891b580f36 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 *  ============LICENSE_START=======================================================
 *  Copyright (C) 2021-2023 Nordix Foundation
 *  Modifications Copyright (C) 2023 TechMahindra Ltd
 *  ================================================================================
 *  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.
 *
 *  SPDX-License-Identifier: Apache-2.0
 *  ============LICENSE_END=========================================================
 */

package org.onap.cps.cpspath.parser;

import static org.onap.cps.cpspath.parser.CpsPathPrefixType.ABSOLUTE;

import java.util.List;
import java.util.Map;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter(AccessLevel.PACKAGE)
public class CpsPathQuery {

    private String xpathPrefix;
    private String normalizedParentPath;
    private String normalizedXpath;
    private List<String> containerNames;
    private CpsPathPrefixType cpsPathPrefixType = ABSOLUTE;
    private String descendantName;
    private Map<String, Object> leavesData;
    private String ancestorSchemaNodeIdentifier = "";
    private String textFunctionConditionLeafName;
    private String textFunctionConditionValue;
    private List<String> booleanOperatorsType;
    private String containsFunctionConditionLeafName;
    private String containsFunctionConditionValue;

    /**
     * Returns a cps path query.
     *
     * @param cpsPathSource cps path
     * @return a CpsPathQuery object.
     */
    public static CpsPathQuery createFrom(final String cpsPathSource) {
        return CpsPathUtil.getCpsPathQuery(cpsPathSource);
    }

    /**
     * Has ancestor axis been included in cpsPath.
     *
     * @return boolean value.
     */
    public boolean hasAncestorAxis() {
        return !(ancestorSchemaNodeIdentifier.isEmpty());
    }

    /**
     * Have leaf value conditions been included in cpsPath.
     *
     * @return boolean value.
     */
    public boolean hasLeafConditions() {
        return leavesData != null;
    }

    /**
     * Has text function condition been included in cpsPath.
     *
     * @return boolean value.
     */
    public boolean hasTextFunctionCondition() {
        return textFunctionConditionLeafName != null;
    }

    /**
     * Has contains function condition been included in cpsPath.
     *
     * @return boolean value.
     */
    public boolean hasContainsFunctionCondition() {
        return containsFunctionConditionLeafName != null;
    }

    /**
     * Returns boolean indicating xpath is an absolute path to a list element.
     *
     * @return true if xpath is an absolute path to a list element
     */
    public boolean isPathToListElement() {
        return cpsPathPrefixType == ABSOLUTE && hasLeafConditions();
    }

}