aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-server/src/main/java/org/sonar/server/rule2/RuleDoc.java
blob: 9537f169f907e97a729305822239350dce1533b4 (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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.rule2;

import org.sonar.api.rule.RuleKey;
import org.sonar.api.rule.RuleStatus;
import org.sonar.api.server.debt.DebtRemediationFunction;
import org.sonar.api.server.rule.RuleParamType;
import org.sonar.server.rule2.RuleNormalizer.RuleField;
import org.sonar.server.search.Hit;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * Implementation of Rule based on an Elasticsearch document
 */
class RuleDoc implements Rule {

  private final Map<String, Object> fields;

  RuleDoc(Map<String, Object> fields) {
    this.fields = fields;
  }

  RuleDoc(Hit hit) {
    this.fields = hit.getFields();
  }

  @Override
  public RuleKey key() {
    return RuleKey.of((String) fields.get(RuleField.REPOSITORY.key()),
      (String) fields.get(RuleField.KEY.key()));
  }

  @Override
  public String language() {
    return (String) fields.get(RuleField.LANGUAGE.key());
  }

  @Override
  public String name() {
    return (String) fields.get(RuleField.NAME.key());
  }

  @Override
  public String description() {
    return (String) fields.get(RuleField.DESCRIPTION.key());
  }

  @Override
  public String severity() {
    return (String) fields.get(RuleField.SEVERITY.key());
  }

  @Override
  public RuleStatus status() {
    return RuleStatus.valueOf((String) fields.get(RuleField.STATUS.key()));
  }

  @Override
  public boolean template() {
    return (Boolean) fields.get(RuleField.TEMPLATE.key());
  }

  @Override
  @SuppressWarnings("unchecked")
  public List<String> tags() {
    return (List<String>) fields.get(RuleField.TAGS.key());
  }

  @Override
  @SuppressWarnings("unchecked")
  public List<String> systemTags() {
    return (List<String>) fields.get(RuleField.SYSTEM_TAGS.key());
  }

  @Override
  public List<RuleParam> params() {
    List<RuleParam> params = new ArrayList<RuleParam>();
    if(this.fields.get(RuleField.PARAMS.key()) != null) {
      Collection<Object> esParams = (Collection<Object>) this.fields.get(RuleField.PARAMS.key());
      for (Object temp : esParams) {
        final Map<String, Object> param = (Map<String, Object>) temp;
        params.add(new RuleParam() {
          {
            this.fields = param;
          }

          Map<String, Object> fields;

          @Override
          public String key() {
            return (String) param.get(RuleNormalizer.RuleParamField.NAME.key());
          }

          @Override
          public String description() {
            return (String) param.get(RuleNormalizer.RuleParamField.DESCRIPTION.key());
          }

          @Override
          public String defaultValue() {
            return (String) param.get(RuleNormalizer.RuleParamField.VALUE.key());
          }

          @Override
          public RuleParamType type() {
            return RuleParamType
              .parse((String) param.get(RuleNormalizer.RuleParamField.TYPE.key()));
          }
        });
      }
    }
    return params;
  }

  @Override
  public String debtCharacteristicKey() {
    throw new UnsupportedOperationException("TODO");
  }

  @Override
  public String debtSubCharacteristicKey() {
    throw new UnsupportedOperationException("TODO");
  }

  @Override
  public DebtRemediationFunction debtRemediationFunction() {
    throw new UnsupportedOperationException("TODO");
  }

  @Override
  public Date createdAt() {
    return (Date) fields.get(RuleField.CREATED_AT.key());
  }

  @Override
  public Date updatedAt() {
    return (Date) fields.get(RuleField.UPDATED_AT.key());
  }
}