Package com.tangosol.util.extractor
Class DeserializationAccelerator
- java.lang.Object
-
- com.tangosol.util.Base
-
- com.tangosol.util.BitHelper
-
- com.tangosol.util.ExternalizableHelper
-
- com.tangosol.util.extractor.AbstractExtractor
-
- com.tangosol.util.extractor.DeserializationAccelerator
-
- All Implemented Interfaces:
CanonicallyNamed,ExternalizableLite,PortableObject,QueryMapComparator,IndexAwareExtractor,Remote.Function,Remote.ToDoubleFunction,Remote.ToIntFunction,Remote.ToLongFunction,ValueExtractor,Serializable,Comparator,Function,ToDoubleFunction,ToIntFunction,ToLongFunction
public class DeserializationAccelerator extends AbstractExtractor implements IndexAwareExtractor, ExternalizableLite, PortableObject
DeserializationAccelerator is anIndexAwareExtractorimplementation that is used to create aForwardOnlyMapIndex, which in turn is used for deserialization optimization.Below is an example how to use this feature to optimize deserialization for
BinaryEntry.getValue()calls:NamedCache cache = ...; cache.addIndex(new DeserializationAccelerator( IdentityExtractor.INSTANCE), false, null);There are two ways the DeserializationAccelerator could be used: pro-active (default) and on-demand. In the pro-active mode, the underlyingForwardOnlyMapIndexis populated every time the index is rebuilt or updated. In the on-demand mode, theForwardOnlyMapIndexstores the values only when they arerequested.- Since:
- Coherence 12.1.3
- Author:
- gg/hr/jh 2014.03.07
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.tangosol.util.ExternalizableHelper
ExternalizableHelper.DecoratedMultiBufferReadBuffer, ExternalizableHelper.DefaultObjectStreamFactory, ExternalizableHelper.FormatAwareCompressor, ExternalizableHelper.IntDecoratedObject, ExternalizableHelper.Shielded, ExternalizableHelper.ShieldedDataOutputStream, ExternalizableHelper.ShieldedInputStream, ExternalizableHelper.ShieldedObjectOutputStream, ExternalizableHelper.ShieldedOutputStream, ExternalizableHelper.SimpleXmlBeanClassCache, ExternalizableHelper.Stats, ExternalizableHelper.XmlBeanClassCache
-
Nested classes/interfaces inherited from class com.tangosol.util.Base
Base.LoggingWriter
-
-
Field Summary
Fields Modifier and Type Field Description protected ValueExtractorm_extractorThe underlying extractor.protected booleanm_fLazyThe "lazy" flag.-
Fields inherited from class com.tangosol.util.extractor.AbstractExtractor
KEY, m_nTarget, m_sNameCanon, VALUE
-
Fields inherited from class com.tangosol.util.ExternalizableHelper
BINARY_SIZE, CHUNK_SIZE, CHUNK_THRESHOLD, CONVERTER_FROM_BINARY, CONVERTER_STRIP_INTDECO, CONVERTER_TO_BINARY, DECO_APP_1, DECO_APP_2, DECO_APP_3, DECO_BACKUP, DECO_CUSTOM, DECO_EXPIRY, DECO_ID_MAX, DECO_ID_MIN, DECO_JCACHE, DECO_JCACHE_SYNTHETIC, DECO_MEMCACHED, DECO_PUSHREP, DECO_QUEUE_METADATA, DECO_RSVD_1, DECO_STORE, DECO_TX, DECO_VALUE, DECO_WLS, EMPTY_BINARY_ARRAY, FMT_B_ARRAY, FMT_BIN_DECO, FMT_BIN_EXT_DECO, FMT_BINARY, FMT_BOOLEAN, FMT_BYTE, FMT_DECIMAL, FMT_DOUBLE, FMT_EXT, FMT_FLOAT, FMT_IDO, FMT_INT, FMT_INTEGER, FMT_LONG, FMT_NONE, FMT_NULL, FMT_OBJ_EXT, FMT_OBJ_SER, FMT_OPT, FMT_OPT_DOUBLE, FMT_OPT_INT, FMT_OPT_LONG, FMT_SHORT, FMT_STRING, FMT_UNKNOWN, FMT_XML_BEAN, FMT_XML_SER, FORCE_RESOLVING_STREAMS, LAMBDA_SERIALIZATION, MAX_DECO_HEADER_BYTES, PACKED_INT_SIZE, PACKED_LONG_SIZE, PROPERTY_CONFIG, s_streamfactory, TRINT_DOMAIN_SPAN, TRINT_MAX_VALUE, TRINT_MAX_VARIANCE, USE_POF_STREAMS, USE_XMLBEAN_CLASS_CACHE, XMLBEAN_CLASS_CACHE
-
-
Constructor Summary
Constructors Constructor Description DeserializationAccelerator()Construct the DeserializationAccelerator.DeserializationAccelerator(ValueExtractor extractor)Construct the DeserializationAccelerator.DeserializationAccelerator(ValueExtractor extractor, boolean fOnDemand)Construct the DeserializationAccelerator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MapIndexcreateIndex(boolean fOrdered, Comparator comparator, Map mapIndex, BackingMapContext ctx)Create an index and associate it with the corresponding extractor.MapIndexdestroyIndex(Map mapIndex)Destroy an existing index and remove it from the given map of indexes.booleanequals(Object o)Equivalence by canonical name and target.Objectextract(Object oTarget)Using a DeserializationAccelerator to extract values in not supported.inthashCode()HashCode value is hashCode of non-nullcanonical name; otherwise, it is the identity hashCode value.voidreadExternal(PofReader in)Restore the contents of a user type instance by reading its state using the specified PofReader object.voidreadExternal(DataInput in)Restore the contents of this object by loading the object's state from the passed DataInput object.StringtoString()Return a human-readable description for this DeserializationAccelerator.voidwriteExternal(PofWriter out)Save the contents of a POF user type instance by writing its state using the specified PofWriter object.voidwriteExternal(DataOutput out)Save the contents of this object by storing the object's state into the passed DataOutput object.-
Methods inherited from class com.tangosol.util.extractor.AbstractExtractor
compare, compareEntries, extractFromEntry, extractOriginalFromEntry, getCanonicalName, getTarget, isCanonicallyEquatable
-
Methods inherited from class com.tangosol.util.ExternalizableHelper
asBinary, calculatePackedLength, calculatePackedLength, checkObjectInputFilter, checkObjectInputFilter, checkObjectInputFilter, convertUTF, decodeExpiry, decorate, decorate, decorate, decorate, decorate, decorateBinary, encodeExpiry, ensureSerializer, extractIntDecoration, fromBinary, fromBinary, fromBinary, fromBinary, fromBinary, fromBinary, fromByteArray, fromByteArray, getClass, getConfigSerialFilter, getConfigSerialFilterFactory, getDecoration, getDecoration, getDecorations, getDeltaCompressor, getInputStream, getNewObjectInput, getObjectInput, getObjectInputFilter, getObjectOutput, getObjectStreamFactory, getOutputStream, getShieldedOutputStream, getStreamFormat, getUndecorated, getUndecorated, isDecorated, isDecorated, isIntDecorated, isIntDecorated, isPatchCompatible, isPatchCompatible, isResolving, isSerializable, isSerializerCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, loadClass, loadResource, main, makeTrint, readBigDecimal, readBigInteger, readBooleanArray, readBooleanArray, readByteArray, readCharArray, readCharArray, readCollection, readDate, readDoubleArray, readDoubleArray, readExternalizableLite, readExternalizableLite, readFloatArray, readFloatArray, readInt, readInt, readIntArray, readIntArray, readIntArray2d, readLargeBooleanArray, readLargeByteArray, readLargeCharArray, readLargeDoubleArray, readLargeFloatArray, readLargeIntArray, readLargeLongArray, readLargeObjectArray, readLargeStringArray, readLong, readLong, readLongArray, readLongArray, readMap, readMap, readObject, readObject, readObjectArray, readObjectArray, readSafeUTF, readSafeUTF, readSerializable, readSerializable, readStringArray, readStringArray, readTime, readTimestamp, readTrint, readUnsignedTrint, readUTF, readXmlBean, readXmlSerializable, readXmlSerializable, realize, removeIntDecoration, removeIntDecoration, replace, reportIncompatibleSerializers, setObjectStreamFactory, toBinary, toBinary, toBinary, toByteArray, toByteArray, toByteArray, toLiteBinary, toLong, undecorate, undecorate, validateBufferSize, validateLoadArray, validateLoadClass, writeBigDecimal, writeBigInteger, writeBooleanArray, writeByteArray, writeCollection, writeDate, writeDoubleArray, writeExternalizableLite, writeFloatArray, writeInt, writeInt, writeIntArray2d, writeLong, writeLong, writeMap, writeObject, writeSafeUTF, writeSafeUTF, writeSerializable, writeStringArray, writeTime, writeTimestamp, writeTrint, writeTrint, writeUTF, writeXmlBean, writeXmlSerializable
-
Methods inherited from class com.tangosol.util.BitHelper
countBits, countBits, countBits, indexOfLSB, indexOfLSB, indexOfLSB, indexOfMSB, indexOfMSB, indexOfMSB, rotateLeft, rotateLeft, rotateLeft, rotateRight, rotateRight, rotateRight, toBitString, toBitString, toBitString, toBytes, toBytes, toBytes, toBytes, toInt, toInt, toLong
-
Methods inherited from class com.tangosol.util.Base
azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, newHashMap, newHashMap, newHashSet, newHashSet, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Methods inherited from interface com.tangosol.util.extractor.IndexAwareExtractor
getExtractor
-
Methods inherited from interface com.tangosol.util.function.Remote.Function
andThen, compose
-
Methods inherited from interface com.tangosol.util.ValueExtractor
andThen, apply, applyAsDouble, applyAsInt, applyAsLong, compose, fromKey, getCanonicalName, getTarget
-
-
-
-
Field Detail
-
m_extractor
protected ValueExtractor m_extractor
The underlying extractor.
-
m_fLazy
protected boolean m_fLazy
The "lazy" flag.
-
-
Constructor Detail
-
DeserializationAccelerator
public DeserializationAccelerator()
Construct the DeserializationAccelerator.
-
DeserializationAccelerator
public DeserializationAccelerator(ValueExtractor extractor)
Construct the DeserializationAccelerator.- Parameters:
extractor- the extractor used by this extractor to create aForwardOnlyMapIndex; note that the created index will be associated with this extractor in the given index map; passing null is equivalent to using theIdentityExtractor
-
DeserializationAccelerator
public DeserializationAccelerator(ValueExtractor extractor, boolean fOnDemand)
Construct the DeserializationAccelerator.- Parameters:
extractor- the extractor used by this extractor to create aForwardOnlyMapIndex; note that the created index will be associated with this extractor in the given index map; passing null is equivalent to using theIdentityExtractorfOnDemand- if true, the forward index will be created "on-demand" as the values are attempted to be accessed; otherwise the forward index is populated proactively (default)
-
-
Method Detail
-
createIndex
public MapIndex createIndex(boolean fOrdered, Comparator comparator, Map mapIndex, BackingMapContext ctx)
Create an index and associate it with the corresponding extractor. Important note: it is a responsibility of this method's implementations to place the necessary <ValueExtractor, MapIndex> entry into the given map of indexes.- Specified by:
createIndexin interfaceIndexAwareExtractor- Parameters:
fOrdered- true iff the contents of the indexed information should be ordered; false otherwisecomparator- the Comparator object which imposes an ordering of entries in the index contents; or null if the entries' values natural ordering should be usedmapIndex- Map<ValueExtractor, MapIndex> to be updated with the created indexctx- Thecontextthe index is associate with.- Returns:
- the created index; null if the index has not been created
-
destroyIndex
public MapIndex destroyIndex(Map mapIndex)
Destroy an existing index and remove it from the given map of indexes.- Specified by:
destroyIndexin interfaceIndexAwareExtractor- Parameters:
mapIndex- map<ValueExtractor, MapIndex> to be updated by removing the index being destroyed- Returns:
- the destroyed index; null if the index does not exist
-
extract
public Object extract(Object oTarget)
Using a DeserializationAccelerator to extract values in not supported.- Specified by:
extractin interfaceValueExtractor- Overrides:
extractin classAbstractExtractor- Parameters:
oTarget- the object to extract the value from- Returns:
- the extracted value; null is an acceptable value
- Throws:
UnsupportedOperationException- always
-
readExternal
public void readExternal(DataInput in) throws IOException
Restore the contents of this object by loading the object's state from the passed DataInput object.- Specified by:
readExternalin interfaceExternalizableLite- Parameters:
in- the DataInput stream to read data from in order to restore the state of this object- Throws:
IOException- if an I/O exception occursNotActiveException- if the object is not in its initial state, and therefore cannot be deserialized into
-
writeExternal
public void writeExternal(DataOutput out) throws IOException
Save the contents of this object by storing the object's state into the passed DataOutput object.- Specified by:
writeExternalin interfaceExternalizableLite- Parameters:
out- the DataOutput stream to write the state of this object to- Throws:
IOException- if an I/O exception occurs
-
readExternal
public void readExternal(PofReader in) throws IOException
Restore the contents of a user type instance by reading its state using the specified PofReader object.- Specified by:
readExternalin interfacePortableObject- Parameters:
in- the PofReader from which to read the object's state- Throws:
IOException- if an I/O error occurs
-
writeExternal
public void writeExternal(PofWriter out) throws IOException
Save the contents of a POF user type instance by writing its state using the specified PofWriter object.- Specified by:
writeExternalin interfacePortableObject- Parameters:
out- the PofWriter to which to write the object's state- Throws:
IOException- if an I/O error occurs
-
equals
public boolean equals(Object o)
Equivalence by canonical name and target.When precondition
AbstractExtractor.isCanonicallyEquatable(Object)is false, fall back to implementation specific equals implementation.- Specified by:
equalsin interfaceComparator- Specified by:
equalsin interfaceValueExtractor- Overrides:
equalsin classAbstractExtractor- Parameters:
o- the reference object with which to compare- Returns:
trueif canonical name match and no target mismatch
-
hashCode
public int hashCode()
HashCode value is hashCode of non-nullcanonical name; otherwise, it is the identity hashCode value.Subclass computes hashCode when canonical name is
null.- Specified by:
hashCodein interfaceValueExtractor- Overrides:
hashCodein classAbstractExtractor- Returns:
- hashCode when canonical name set.
-
-