4 Copyright (c) 2018, Mungo Carstairs
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
10 * Redistributions of source code must retain the above copyright notice, this
11 list of conditions and the following disclaimer.
13 * Redistributions in binary form must reproduce the above copyright notice,
14 this list of conditions and the following disclaimer in the documentation
15 and/or other materials provided with the distribution.
17 * Neither the name of the copyright holder nor the names of its
18 contributors may be used to endorse or promote products derived from
19 this software without specific prior written permission.
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 package intervalstore.api;
34 import java.util.Collections;
35 import java.util.Comparator;
36 import java.util.List;
38 public interface IntervalI
42 * Compare intervals by start position ascending and end position descending.
44 static Comparator<? super IntervalI> COMPARATOR_BIGENDIAN = new Comparator<IntervalI>()
47 public int compare(IntervalI o1, IntervalI o2)
49 int ret = Integer.signum(o1.getBegin() - o2.getBegin());
50 return (ret == 0 ? Integer.signum(o2.getEnd() - o1.getEnd()) : ret);
55 * Compare intervals by start position ascending and end position ascending.
57 static Comparator<? super IntervalI> COMPARATOR_LITTLEENDIAN = new Comparator<IntervalI>()
60 public int compare(IntervalI o1, IntervalI o2)
62 int ret = Integer.signum(o1.getBegin() - o2.getBegin());
63 return (ret == 0 ? Integer.signum(o1.getEnd() - o2.getEnd()) : ret);
68 * a comparator for sorting intervals by start position ascending
70 static Comparator<? super IntervalI> FORWARD_STRAND = new Comparator<IntervalI>()
73 public int compare(IntervalI o1, IntervalI o2)
75 return Integer.signum(o1.getBegin() - o2.getBegin());
80 * a comparator for sorting intervals by end position descending
82 static Comparator<? super IntervalI> REVERSE_STRAND = new Comparator<IntervalI>()
85 public int compare(IntervalI o1, IntervalI o2)
87 return Integer.signum(o2.getEnd() - o1.getEnd());
91 static int NOT_CONTAINED = Integer.MIN_VALUE;
92 static int CONTAINMENT_UNKNOWN = 0;
98 * Answers true if this interval contains (or matches) the given interval
99 * based solely on start and end.
104 default boolean containsInterval(IntervalI i)
106 return i != null && i.getBegin() >= getBegin()
107 && i.getEnd() <= getEnd();
112 * Answers true if this interval properly contains the given interval, that
113 * is, it contains it and is larger than it
118 default boolean properlyContainsInterval(IntervalI i)
120 return containsInterval(i)
121 && (i.getBegin() > getBegin() || i.getEnd() < getEnd());
125 * Slower than equalsInterval; also includes type.
127 * Ensure that subclasses override equals(Object). For example:
129 * public boolean equals(Object o) { return o != null && o instanceof XXX &&
130 * equalsInterval((XXX) i); }
133 * equalsInterval also must be overridden.
135 * public boolean equalsInterval(IntervalI i) {return ((SimpleFeature)i).start
136 * == start && ((SimpleFeature)i).end == end && ((SimpleFeature)i).description
137 * == this.description; }
141 * @return true if equal, including a type check
144 abstract boolean equals(Object o);
149 * Check that two intervals are equal, in terms of end points, descriptions,
150 * or any other distinguishing features.
152 * Used in IntervalStore in searches, since it is faster than equals(), as at
153 * that point we know that we have the correct type.
156 * @return true if equal
158 abstract boolean equalsInterval(IntervalI i);
160 default boolean overlapsInterval(IntervalI i)
166 if (i.getBegin() < getBegin())
168 return i.getEnd() >= getBegin();
170 if (i.getEnd() > getEnd())
172 return i.getBegin() <= getEnd();
174 return true; // i internal to this
178 * Sorts the list by start position ascending (if forwardString==true), or by
179 * end position descending
182 * @param forwardStrand
184 static void sortIntervals(List<? extends IntervalI> intervals,
185 final boolean forwardStrand)
187 Collections.sort(intervals,
188 forwardStrand ? FORWARD_STRAND : REVERSE_STRAND);