aboutsummaryrefslogtreecommitdiff
path: root/src/batchtools/rsTester/src/main/java/com/galois/fiveui/RuleTest.java
blob: acf67438cbfbcffdb63af0ddae979c2fd819840b (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
/**
 * Module     : RuleTest.java
 * Copyright  : (c) 2011-2012, Galois, Inc.
 *
 * Maintainer :
 * Stability  : Provisional
 * Portability: Portable
 *
 * 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.
 */
package com.galois.fiveui;

import java.net.URI;
import java.util.Collection;

import com.google.common.collect.ImmutableMultiset;

/**
 * A RuleTest object encapsulates the following data: 
 * <ol>
 *   <li> a URI on which to run rules, accessed using {@code getUri}</li>
 *   <li> a RuleSet object encapsulating the rule to run on the URI</li>
 *   <li> a rule ID, signifying we expect results for the corresponding rule
 *        (defined in the rule set) of the type(s) given in the oracle</li>
 *   <li> an oracle, the expected results of the test</li>
 * </ol>
 *
 * @author creswick
 *
 */
public class RuleTest {
    
    private final URI _uri;
    private final RuleSet _ruleSet;
    private final String _ruleName;
    private final ImmutableMultiset<ResType> _oracle;

    public RuleTest(URI uri, RuleSet ruleSet, String ruleName, Collection<ResType> oracle) {
        _uri = uri;
        _ruleSet = ruleSet;
        _ruleName = ruleName;
        _oracle = ImmutableMultiset.copyOf(oracle);
    }
    
    public Rule getRule() {
      return _ruleSet.getRule(_ruleName);
    }

    public URI getUri() {
        return _uri;
    }

    public RuleSet getRuelSet() {
        return _ruleSet;
    }

    public String getRuleName() {
        return _ruleName;
    }

    public ImmutableMultiset<ResType> getOracle() {
        return _oracle;
    }

    
}