Class ORSet<A>

  • All Implemented Interfaces:
    OpCrdt<ORSet.DeltaOp>

    public final class ORSet<A>
    extends java.lang.Object
    implements OpCrdt<ORSet.DeltaOp>
    Implements a 'Observed Remove Set' operation based CRDT, also called a 'OR-Set'. Elements can be added and removed any number of times. Concurrent add wins over remove.

    It is not implemented as in the paper A comprehensive study of Convergent and Commutative Replicated Data Types. This is more space efficient and doesn't accumulate garbage for removed elements. It is described in the paper An optimized conflict-free replicated set The implementation is inspired by the Riak DT riak_dt_orswot.

    The ORSet has a version vector that is incremented when an element is added to the set. The DC -&gt; count pair for that increment is stored against the element as its "birth dot". Every time the element is re-added to the set, its "birth dot" is updated to that of the DC -&gt; count version vector entry resulting from the add. When an element is removed, we simply drop it, no tombstones.

    When an element exists in replica A and not replica B, is it because A added it and B has not yet seen that, or that B removed it and A has not yet seen that? In this implementation we compare the dot of the present element to the version vector in the Set it is absent from. If the element dot is not "seen" by the Set version vector, that means the other set has yet to see this add, and the item is in the merged Set. If the Set version vector dominates the dot, that means the other Set has removed this element already, and the item is not in the merged Set.

    This class is immutable, i.e. "modifying" methods return a new instance.

    • Constructor Detail

      • ORSet

        public ORSet​(java.lang.String originReplica,
                     scala.collection.immutable.Map<A,​VersionVector> elementsMap,
                     VersionVector vvector)
    • Method Detail

      • empty

        public static <A> ORSet<A> empty​(ReplicaId originReplica)
      • apply

        public static <A> ORSet<A> apply​(ReplicaId originReplica)
      • create

        public static <A> ORSet<A> create​(ReplicaId originReplica)
        Java API
      • unapply

        public static <A> scala.Option<scala.collection.immutable.Set<A>> unapply​(ORSet<A> s)
        Extract the elements().
      • subtractDots

        public static VersionVector subtractDots​(VersionVector dot,
                                                 VersionVector vvector)
        INTERNAL API Subtract the vvector from the dot. What this means is that any (dc, version) pair in dot that is &lt;= an entry in vvector is removed from dot. Example [{a, 3}, {b, 2}, {d, 14}, {g, 22}] - [{a, 4}, {b, 1}, {c, 1}, {d, 14}, {e, 5}, {f, 2}] = [{b, 2}, {g, 22}]
      • mergeCommonKeys

        public static <A> scala.collection.immutable.Map<A,​VersionVector> mergeCommonKeys​(scala.collection.immutable.Set<A> commonKeys,
                                                                                                ORSet<A> lhs,
                                                                                                ORSet<A> rhs)
        INTERNAL API
        See Also:
        ORSet#merge
      • mergeDisjointKeys

        public static <A> scala.collection.immutable.Map<A,​VersionVector> mergeDisjointKeys​(scala.collection.immutable.Set<A> keys,
                                                                                                  scala.collection.immutable.Map<A,​VersionVector> elementsMap,
                                                                                                  VersionVector vvector,
                                                                                                  scala.collection.immutable.Map<A,​VersionVector> accumulator)
        INTERNAL API
        See Also:
        ORSet#merge
      • originReplica

        public java.lang.String originReplica()
      • elementsMap

        public scala.collection.immutable.Map<A,​VersionVector> elementsMap()
      • elements

        public scala.collection.immutable.Set<A> elements()
        Scala API
      • getElements

        public java.util.Set<A> getElements()
        Java API
      • contains

        public boolean contains​(A a)
      • isEmpty

        public boolean isEmpty()
      • size

        public int size()
      • $plus

        public ORSet.DeltaOp $plus​(A element)
        Adds an element to the set
      • add

        public ORSet.DeltaOp add​(A element)
        Adds an element to the set
      • addAll

        public ORSet.DeltaOp addAll​(java.util.Set<A> elems)
        Java API: Add several elements to the set. elems must not be empty.
      • addAll

        public ORSet.DeltaOp addAll​(scala.collection.immutable.Set<A> elems)
        Scala API: Add several elements to the set. elems must not be empty.
      • $minus

        public ORSet.DeltaOp $minus​(A element)
        Removes an element from the set.
      • remove

        public ORSet.DeltaOp remove​(A element)
        Removes an element from the set.
      • removeAll

        public ORSet.DeltaOp removeAll​(java.util.Set<A> elems)
        Java API: Remove several elements from the set. elems must not be empty.
      • removeAll

        public ORSet.DeltaOp removeAll​(scala.collection.immutable.Set<A> elems)
        Scala API: Remove several elements from the set. elems must not be empty.
      • clear

        public ORSet.DeltaOp clear()
        Removes all elements from the set, but keeps the history. This has the same result as using remove(A) for each element, but it is more efficient.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object