1 /*******************************************************************************
2 * Copyright (c) 2016 Ericsson
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
8 *******************************************************************************/
10 package org
.eclipse
.tracecompass
.internal
.segmentstore
.core
.arraylist
;
12 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
14 import java
.util
.ArrayList
;
15 import java
.util
.Collection
;
16 import java
.util
.Collections
;
17 import java
.util
.Comparator
;
18 import java
.util
.Iterator
;
19 import java
.util
.List
;
20 import java
.util
.concurrent
.locks
.ReentrantLock
;
21 import java
.util
.stream
.Collectors
;
23 import org
.eclipse
.jdt
.annotation
.NonNull
;
24 import org
.eclipse
.jdt
.annotation
.Nullable
;
25 import org
.eclipse
.tracecompass
.segmentstore
.core
.BasicSegment
;
26 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegment
;
27 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegmentStore
;
28 import org
.eclipse
.tracecompass
.segmentstore
.core
.SegmentComparators
;
30 import com
.google
.common
.collect
.ImmutableList
;
31 import com
.google
.common
.collect
.Ordering
;
34 * Implementation of an {@link ISegmentStore} using one in-memory
35 * {@link ArrayList}. This relatively simple implementation holds everything in
36 * memory, and as such cannot contain too much data.
38 * The LazyArrayListStore itself is {@link Iterable}, and its iteration order
39 * will be by ascending order of start times. For segments with identical start
40 * times, the secondary comparator will be the end time. If even those are
41 * equal, it will defer to the segments' natural ordering (
42 * {@link ISegment#compareTo}).
44 * This structure sorts in a lazy way to allow faster insertions. However, if
45 * the structure is out of order, the next read (getting intersecting elements,
46 * iterating...) will perform a sort. It may have inconsistent performance, but
47 * should be faster at building when receiving shuffled datasets than the
48 * {@link ArrayListStore}.
50 * Removal operations are not supported.
53 * The type of segment held in this store
55 * @author Matthew Khouzam
57 public class LazyArrayListStore
<@NonNull E
extends ISegment
> implements ISegmentStore
<E
> {
59 private static final String ERROR_MESSAGE
= "Cannot remove from a segment store"; //$NON-NLS-1$
61 private final Comparator
<E
> COMPARATOR
= Ordering
.from(SegmentComparators
.INTERVAL_START_COMPARATOR
)
62 .compound(SegmentComparators
.INTERVAL_END_COMPARATOR
);
64 private final ReentrantLock fLock
= new ReentrantLock(false);
66 private final List
<E
> fStore
= new ArrayList
<>();
68 private @Nullable transient Iterable
<E
> fLastSnapshot
= null;
70 private volatile boolean fDirty
= false;
75 public LazyArrayListStore() {
83 * an array of elements to wrap in the segment store
86 public LazyArrayListStore(Object
[] array
) {
87 for (int i
= 0; i
< array
.length
; i
++) {
88 if (array
[i
] instanceof ISegment
) {
89 E element
= (E
) array
[i
];
90 setDirtyIfNeeded(element
);
99 private void setDirtyIfNeeded(@NonNull E value
) {
100 if (!fStore
.isEmpty() && COMPARATOR
.compare(fStore
.get(size() - 1), value
) > 0) {
104 // ------------------------------------------------------------------------
105 // Methods from Collection
106 // ------------------------------------------------------------------------
109 public Iterator
<E
> iterator() {
115 Iterable
<E
> lastSnapshot
= fLastSnapshot
;
116 if (lastSnapshot
== null) {
117 lastSnapshot
= ImmutableList
.copyOf(fStore
);
118 fLastSnapshot
= lastSnapshot
;
120 return checkNotNull(lastSnapshot
.iterator());
127 * DO NOT CALL FROM OUTSIDE OF A LOCK!
129 private void sortStore() {
130 fStore
.sort(COMPARATOR
);
135 public boolean add(@Nullable E val
) {
137 throw new IllegalArgumentException("Cannot add null value"); //$NON-NLS-1$
142 setDirtyIfNeeded(val
);
144 fLastSnapshot
= null;
155 return fStore
.size();
162 public boolean isEmpty() {
165 return fStore
.isEmpty();
172 public boolean contains(@Nullable Object o
) {
175 return fStore
.contains(o
);
182 public boolean containsAll(@Nullable Collection
<?
> c
) {
185 return fStore
.containsAll(c
);
192 public Object
[] toArray() {
198 return fStore
.toArray();
205 public <T
> T
[] toArray(T
[] a
) {
211 return fStore
.toArray(a
);
218 public boolean addAll(@Nullable Collection
<?
extends E
> c
) {
220 throw new IllegalArgumentException();
225 boolean changed
= false;
238 public boolean removeAll(@Nullable Collection
<?
> c
) {
239 throw new UnsupportedOperationException(ERROR_MESSAGE
);
243 public boolean retainAll(@Nullable Collection
<?
> c
) {
244 throw new UnsupportedOperationException(ERROR_MESSAGE
);
248 public boolean remove(@Nullable Object o
) {
249 throw new UnsupportedOperationException(ERROR_MESSAGE
);
253 public void clear() {
257 fLastSnapshot
= null;
264 // ------------------------------------------------------------------------
265 // Methods added by ISegmentStore
266 // ------------------------------------------------------------------------
269 public Iterable
<E
> getIntersectingElements(long position
) {
275 * The intervals intersecting 't' are those whose 1) start time is
276 * *lower* than 't' AND 2) end time is *higher* than 't'.
280 * as fStore is sorted by start then end times, restrict sub array
281 * to elements whose start times <= t as stream.filter won't do it.
283 int index
= Collections
.binarySearch(fStore
, new BasicSegment(position
, Long
.MAX_VALUE
));
284 index
= (index
>= 0) ? index
: -index
- 1;
285 return fStore
.subList(0, index
).stream().filter(element
-> position
>= element
.getStart() && position
<= element
.getEnd()).collect(Collectors
.toList());
292 public Iterable
<E
> getIntersectingElements(long start
, long end
) {
298 int index
= Collections
.binarySearch(fStore
, new BasicSegment(end
, Long
.MAX_VALUE
));
299 index
= (index
>= 0) ? index
: -index
- 1;
300 return fStore
.subList(0, index
).stream().filter(element
-> !(start
> element
.getEnd() || end
< element
.getStart())).collect(Collectors
.toList());
307 public void dispose() {