Package com.tangosol.util.processor
Class ExtractorProcessor<K,V,T,E>
- java.lang.Object
-
- com.tangosol.util.Base
-
- com.tangosol.util.processor.AbstractProcessor<K,V,E>
-
- com.tangosol.util.processor.ExtractorProcessor<K,V,T,E>
-
- All Implemented Interfaces:
ExternalizableLite
,PortableObject
,InvocableMap.EntryProcessor<K,V,E>
,Serializable
public class ExtractorProcessor<K,V,T,E> extends AbstractProcessor<K,V,E> implements ExternalizableLite, PortableObject
ExtractorProcessor is an EntryProcessor implementations that extracts a value from an object cached in an InvocableMap. A common usage pattern is:cache.invoke(oKey, new ExtractorProcessor(extractor));
which is functionally equivalent to the following operation:extractor.extract(cache.get(oKey));
The major difference is that for clustered caches using the ExtractorProcessor could significantly reduce the amount of network traffic.An alternative (and superior) approach would be to use the
ReducerAggregator
- Author:
- gg 2005.11.30
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.tangosol.util.Base
Base.LoggingWriter
-
-
Field Summary
Fields Modifier and Type Field Description protected ValueExtractor<? super T,? extends E>
m_extractor
The underlying value extractor.
-
Constructor Summary
Constructors Constructor Description ExtractorProcessor()
Default constructor (necessary for the ExternalizableLite interface).ExtractorProcessor(ValueExtractor<? super T,? extends E> extractor)
Construct an ExtractorProcessor based on the specified ValueExtractor.ExtractorProcessor(String sMethod)
Construct an ExtractorProcessor for a given method name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
Compare the ExtractorProcessor with another object to determine equality.int
hashCode()
Determine a hash value for the ExtractorProcessor object according to the generalObject.hashCode()
contract.E
process(InvocableMap.Entry<K,V> entry)
Process a Map.Entry object.void
readExternal(PofReader in)
Restore the contents of a user type instance by reading its state using the specified PofReader object.void
readExternal(DataInput in)
Restore the contents of this object by loading the object's state from the passed DataInput object.String
toString()
Return a human-readable description for this ExtractorProcessor.void
writeExternal(PofWriter out)
Save the contents of a POF user type instance by writing its state using the specified PofWriter object.void
writeExternal(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.processor.AbstractProcessor
processAll
-
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, 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
-
-
-
-
Field Detail
-
m_extractor
protected ValueExtractor<? super T,? extends E> m_extractor
The underlying value extractor.
-
-
Constructor Detail
-
ExtractorProcessor
public ExtractorProcessor()
Default constructor (necessary for the ExternalizableLite interface).
-
ExtractorProcessor
public ExtractorProcessor(ValueExtractor<? super T,? extends E> extractor)
Construct an ExtractorProcessor based on the specified ValueExtractor.- Parameters:
extractor
- a ValueExtractor object; passing null is equivalent to using theIdentityExtractor
-
ExtractorProcessor
public ExtractorProcessor(String sMethod)
Construct an ExtractorProcessor for a given method name.- Parameters:
sMethod
- a method name to make aReflectionExtractor
for; this parameter can also be a dot-delimited sequence of method names which would result in an ExtractorProcessor based on theChainedExtractor
that is based on an array of corresponding ReflectionExtractor objects
-
-
Method Detail
-
process
public E process(InvocableMap.Entry<K,V> entry)
Process a Map.Entry object.Note: if this method throws an exception, all modifications to the supplied entry or any other entries retrieved via the
BackingMapContext.getBackingMapEntry(java.lang.Object)
API will be rolled back leaving all underlying values unchanged.- Specified by:
process
in interfaceInvocableMap.EntryProcessor<K,V,T>
- Parameters:
entry
- the Entry to process- Returns:
- the result of the processing, if any
-
equals
public boolean equals(Object o)
Compare the ExtractorProcessor with another object to determine equality.
-
hashCode
public int hashCode()
Determine a hash value for the ExtractorProcessor object according to the generalObject.hashCode()
contract.
-
toString
public String toString()
Return a human-readable description for this ExtractorProcessor.
-
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:
readExternal
in 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:
writeExternal
in 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:
readExternal
in 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:
writeExternal
in interfacePortableObject
- Parameters:
out
- the PofWriter to which to write the object's state- Throws:
IOException
- if an I/O error occurs
-
-