Class |
Line # |
Actions |
|||
---|---|---|---|---|---|
FeatureMatcherI | 32 | 0 | 0 |
1 | /* | |
2 | * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) | |
3 | * Copyright (C) $$Year-Rel$$ The Jalview Authors | |
4 | * | |
5 | * This file is part of Jalview. | |
6 | * | |
7 | * Jalview is free software: you can redistribute it and/or | |
8 | * modify it under the terms of the GNU General Public License | |
9 | * as published by the Free Software Foundation, either version 3 | |
10 | * of the License, or (at your option) any later version. | |
11 | * | |
12 | * Jalview is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty | |
14 | * of MERCHANTABILITY or FITNESS FOR A PARTICULAR | |
15 | * PURPOSE. See the GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with Jalview. If not, see <http://www.gnu.org/licenses/>. | |
19 | * The Jalview Authors are detailed in the 'AUTHORS' file. | |
20 | */ | |
21 | package jalview.datamodel.features; | |
22 | ||
23 | import jalview.datamodel.SequenceFeature; | |
24 | import jalview.util.matcher.MatcherI; | |
25 | ||
26 | /** | |
27 | * An interface for an object that can apply a match condition to a | |
28 | * SequenceFeature object | |
29 | * | |
30 | * @author gmcarstairs | |
31 | */ | |
32 | public interface FeatureMatcherI | |
33 | { | |
34 | /** | |
35 | * Answers true if the value provided for this matcher's key passes this | |
36 | * matcher's match condition | |
37 | * | |
38 | * @param feature | |
39 | * @return | |
40 | */ | |
41 | boolean matches(SequenceFeature feature); | |
42 | ||
43 | /** | |
44 | * Answers the attribute key this matcher operates on (or null if match is by | |
45 | * Label or Score) | |
46 | * | |
47 | * @return | |
48 | */ | |
49 | String[] getAttribute(); | |
50 | ||
51 | /** | |
52 | * Answers true if match is against feature label (description), else false | |
53 | * | |
54 | * @return | |
55 | */ | |
56 | boolean isByLabel(); | |
57 | ||
58 | /** | |
59 | * Answers true if match is against feature score, else false | |
60 | * | |
61 | * @return | |
62 | */ | |
63 | boolean isByScore(); | |
64 | ||
65 | /** | |
66 | * Answers true if match is against a feature attribute (text or range) | |
67 | * | |
68 | * @return | |
69 | */ | |
70 | boolean isByAttribute(); | |
71 | ||
72 | /** | |
73 | * Answers the match condition that is applied | |
74 | * | |
75 | * @return | |
76 | */ | |
77 | MatcherI getMatcher(); | |
78 | ||
79 | /** | |
80 | * Answers a string representation of this object suitable for use when | |
81 | * persisting data, in a format that can be reliably read back. Any changes to | |
82 | * the format should be backwards compatible. | |
83 | */ | |
84 | String toStableString(); | |
85 | } |