Package com.tangosol.net.cache

Class BackingMapBinaryEntry

  • All Implemented Interfaces:
    BinaryEntry, InvocableMap.Entry, MapTrigger.Entry, QueryMap.Entry, Map.Entry
    Direct Known Subclasses:
    ReadWriteBackingMap.Entry
    public class BackingMapBinaryEntry
extends Base
implements BinaryEntry, MapTrigger.Entry
    An implementation of the BinaryEntry interface that is based on specified binary key, binary value and BackingMapManagerContext. Analogous to the MapTrigger.Entry, it represents a pending change to an Entry that is about to committed to the underlying Map. For example, the original binary value of null indicates pending insert (a non-existing entry), while the binary value of null represents a pending remove operation.

    It is currently only used by the ReadWriteBackingMap to communicate with the BinaryEntryStore.

    This implementation is not thread safe.

    Author:
    gg 2009.11.22

    • Field Detail

      • m_binKey

        protected Binary m_binKey
        The Binary key. This object reference will not change for the life of the Entry.

      • m_binValue

        protected Binary m_binValue
        The Binary value.

      • m_binValueOrig

        protected Binary m_binValueOrig
        The original Binary value.

      • m_oKey

        protected Object m_oKey
        Lazily converted key in Object format.

      • m_oValue

        protected Object m_oValue
        Lazily converted value in Object format.

      • m_oValueOrig

        protected Object m_oValueOrig
        Lazily converted original value in Object format.

      • m_fSynthetic

        protected boolean m_fSynthetic
        Whether this update is synthetic.
        Since:
        12.2.1.4

    • Constructor Detail

      • BackingMapBinaryEntry

        public BackingMapBinaryEntry​(Binary binKey,
                             Binary binValue,
                             Binary binValueOrig,
                             BackingMapManagerContext ctx)
        Construct a BackingMapBinaryEntry with the specified binary key, values and BackingMapManagerContext.
        Parameters:
        binKey - the Binary key
        binValue - the Binary value; could be null representing a non-existing entry
        binValueOrig - an original Binary value; could be null representing an insert operation
        ctx - a BackingMapManagerContext

      • BackingMapBinaryEntry

        public BackingMapBinaryEntry​(Binary binKey,
                             Binary binValue,
                             Binary binValueOrig,
                             long cDelay,
                             BackingMapManagerContext ctx)
        Construct a BackingMapBinaryEntry with the specified binary key, values and BackingMapManagerContext.
        Parameters:
        binKey - the Binary key
        binValue - the Binary value; could be null representing a non-existing entry
        binValueOrig - an original Binary value; could be null representing an insert operation
        cDelay - the expiry delay
        ctx - a BackingMapManagerContext

    • Method Detail

      • getBinaryKey

        public Binary getBinaryKey()
        Return a raw binary key for this entry.
        Specified by:
        getBinaryKey in interface BinaryEntry
        Returns:
        a raw binary key for this entry

      • getBinaryValue

        public Binary getBinaryValue()
        Return a raw binary value for this entry.
        Specified by:
        getBinaryValue in interface BinaryEntry
        Returns:
        a raw binary value for this entry; null if the value does not exist

      • getOriginalBinaryValue

        public Binary getOriginalBinaryValue()
        Return a raw original binary value for this entry.
        Specified by:
        getOriginalBinaryValue in interface BinaryEntry
        Returns:
        a raw original binary value for this entry; null if the original value did not exist

      • getKey

        public Object getKey()
        Return the key corresponding to this entry. The resultant key does not necessarily exist within the containing Map, which is to say that InvocableMap.this.containsKey(getKey()) could return false. To test for the presence of this key within the Map, use InvocableMap.Entry.isPresent(), and to create the entry for the key, use InvocableMap.Entry.setValue(V).
        Specified by:
        getKey in interface InvocableMap.Entry
        Specified by:
        getKey in interface Map.Entry
        Returns:
        the key corresponding to this entry; may be null if the underlying Map supports null keys

      • isOriginalPresent

        public boolean isOriginalPresent()
        Determine whether or not the Entry existed before the start of the mutating operation that is being evaluated by the trigger.
        Specified by:
        isOriginalPresent in interface MapTrigger.Entry
        Returns:
        true iff this Entry was existent in the containing Map

      • setValue

        public Object setValue​(Object oValue)
        Store the value corresponding to this entry. If the entry does not exist, then the entry will be created by invoking this method, even with a null value (assuming the Map supports null values).
        Specified by:
        setValue in interface InvocableMap.Entry
        Specified by:
        setValue in interface Map.Entry
        Parameters:
        oValue - the new value for this Entry
        Returns:
        the previous value of this Entry, or null if the Entry did not exist

      • setValue

        public void setValue​(Object oValue,
                     boolean fSynthetic)
        Store the value corresponding to this entry. If the entry does not exist, then the entry will be created by invoking this method, even with a null value (assuming the Map supports null values).

        Unlike the other form of setValue, this form does not return the previous value, and as a result may be significantly less expensive (in terms of cost of execution) for certain Map implementations.

        As of Coherence 12.1.2, if fSynthetic is true and the BackingMap associated with this entry is a ReadWriteBackingMap, this method will bypass the CacheStore or BinaryEntryStore.

        Specified by:
        setValue in interface BinaryEntry
        Specified by:
        setValue in interface InvocableMap.Entry
        Parameters:
        oValue - the new value for this Entry
        fSynthetic - pass true only if the insertion into or modification of the Map should be treated as a synthetic event

      • updateBinaryValue

        public void updateBinaryValue​(Binary binValue)
        Update the binary value for this entry.

        Passing a non-null binary is functionally equivalent to: 

           setValue(getContext().getValueFromInternalConverter().convert(binValue));
        Passing null value is functionally equivalent to removing the entry. 
           remove(false);

        Specified by:
        updateBinaryValue in interface BinaryEntry
        Parameters:
        binValue - new binary value to be stored in this entry or null

      • updateBinaryValue

        public void updateBinaryValue​(Binary binValue,
                              boolean fSynthetic)
        Update the binary value for this entry.

        Passing a non-null binary is functionally equivalent to: 

           setValue(getContext().getValueFromInternalConverter().convert(binValue));
        Passing null value is functionally equivalent to removing the entry. 
           remove(false);
        This method will bypass any CacheStore or BinaryEntryStore implementations, iff fSynthetic is true and the backing map associated with this entry is a ReadWriteBackingMap.

        Specified by:
        updateBinaryValue in interface BinaryEntry
        Parameters:
        binValue - new binary value to be stored in this entry or null
        fSynthetic - pass true only if the insertion into or modification of the Map should be treated as a synthetic event

      • getBackingMap

        public ObservableMap getBackingMap()
        Obtain a reference to the backing map that this Entry corresponds to. The returned Map should be used in a read-only manner.

        Note: This method is a shortcut for the getBackingMapContext().getBackingMap() call. As of Coherence 3.7, the returned type has been narrowed to ObservableMap.

        Specified by:
        getBackingMap in interface BinaryEntry
        Returns:
        the backing map reference; null if the entry does not have any backing map association

      • expire

        public void expire​(long cMillis)
        Update the entry with the specified expiry delay.

        Note: this method only has an effect only if the associated backing map implements the CacheMap interface

        Specified by:
        expire in interface BinaryEntry
        Parameters:
        cMillis - the number of milliseconds until the entry will expire; pass CacheMap.EXPIRY_DEFAULT to use the default expiry setting; pass CacheMap.EXPIRY_NEVER to indicate that the entry should never expire

      • getExpiry

        public long getExpiry()
        Return the number of milliseconds remaining before the specified entry is scheduled to expire. If the BinaryEntry.expire(long) method has been called, the returned value will reflect the requested expiry delay. Otherwise if the entry exists, the returned value will represent the time remaining until the entry expires (or CacheMap.EXPIRY_NEVER if the entry will never expire). If the entry does not exist, CacheMap.EXPIRY_DEFAULT will be returned.

        This method will make a "best effort" attempt to determine the expiry time remaining. In some cases, it may not be possible to determine the expiry (e.g. the backing-map does not implement the CacheMap interface), in which case CacheMap.EXPIRY_DEFAULT will be returned.

        Specified by:
        getExpiry in interface BinaryEntry
        Returns:
        the number of milliseconds remaining before the specified entry expires

      • isReadOnly

        public boolean isReadOnly()
        Check whether this BinaryEntry allows data modification operations.
        Specified by:
        isReadOnly in interface BinaryEntry
        Returns:
        true iff the entry is "read-only"

      • update

        public void update​(ValueUpdater updater,
                   Object oValue)
        Update the Entry's value. Calling this method is semantically equivalent to: 
           V target = entry.getValue();
   updater.update(target, value);
   entry.setValue(target, false);
        The benefit of using this method is that it may allow the Entry implementation to significantly optimize the operation, such as for purposes of delta updates and backup maintenance.
        Specified by:
        update in interface InvocableMap.Entry
        Parameters:
        updater - a ValueUpdater used to modify the Entry's value
        oValue - the new value for this Entry

      • isSynthetic

        public boolean isSynthetic()
        Determine if this Entry has been synthetically mutated. This method returns false if either a non-synthetic update was made or the entry has not been modified.
        Specified by:
        isSynthetic in interface InvocableMap.Entry
        Returns:
        true if the Entry has been synthetically mutated

      • remove

        public void remove​(boolean fSynthetic)
        Remove this Entry from the Map if it is present in the Map.

        This method supports both the operation corresponding to Map.remove(java.lang.Object) as well as synthetic operations such as eviction. If the containing Map does not differentiate between the two, then this method will always be identical to InvocableMap.this.remove(getKey()).

        As of Coherence 12.1.2, if fSynthetic is true and the BackingMap associated with this entry is a ReadWriteBackingMap, this method will bypass the CacheStore or BinaryEntryStore.

        Specified by:
        remove in interface BinaryEntry
        Specified by:
        remove in interface InvocableMap.Entry
        Parameters:
        fSynthetic - pass true only if the removal from the Map should be treated as a synthetic event

      • extract

        public Object extract​(ValueExtractor extractor)
        Extract a value out of the Entry's key or value. Calling this method is semantically equivalent to extractor.extract(entry.getValue()), but this method may be significantly less expensive. For example, the resultant value may be obtained from a forward index, avoiding a potential object de-serialization.
        Specified by:
        extract in interface QueryMap.Entry
        Parameters:
        extractor - a ValueExtractor to apply to the Entry's key or value
        Returns:
        the extracted value

      • equals

        public boolean equals​(Object o)
        Compares the specified object with this entry for equality.
        Specified by:
        equals in interface Map.Entry
        Overrides:
        equals in class Object
        Parameters:
        o - object to be compared for equality with this entry
        Returns:
        true if the specified object is equal to this entry

      • hashCode

        public int hashCode()
        Returns the hash code value for this entry.
        Specified by:
        hashCode in interface Map.Entry
        Overrides:
        hashCode in class Object
        Returns:
        the hash code value for this entry.

      • toString

        public String toString()
        Render the entry as a String.
        Overrides:
        toString in class Object
        Returns:
        the readable description for this entry

      • calculateExpiry

        protected static long calculateExpiry​(long cDelay)
        Calculate the expiry timestamp based on the expiry delay value.
        Parameters:
        cDelay - the expiry delay
        Returns:
        the expiry timestamp