com.tangosol.util.extractor

Class UniversalExtractor<T,E>

java.lang.Object

com.tangosol.util.Base

com.tangosol.util.BitHelper

com.tangosol.util.ExternalizableHelper

com.tangosol.util.extractor.AbstractExtractor<T,E>

com.tangosol.util.extractor.UniversalExtractor<T,E>

Type Parameters:

T - the type of the value to extract from

E - the type of value that will be extracted

All Implemented Interfaces:

CanonicallyNamed, ExternalizableLite, PortableObject, QueryMapComparator, Remote.Function<T,E>, Remote.ToDoubleFunction<T>, Remote.ToIntFunction<T>, Remote.ToLongFunction<T>, ValueExtractor<T,E>, Serializable, Comparator, Function<T,E>, ToDoubleFunction<T>, ToIntFunction<T>, ToLongFunction<T>

public class UniversalExtractor<T,E>
extends AbstractExtractor<T,E>
implements ValueExtractor<T,E>, ExternalizableLite, PortableObject

Universal ValueExtractor implementation.

Either a property or method based extractor based on parameters passed to constructor UniversalExtractor(String, Object[], int). Generally, the name value passed to the UniversalExtractor constructor represents a property unless sName value ends in METHOD_SUFFIX, "()", then this instance is a reflection based method extractor. Special cases are described in the constructor documentation.

AbstractExtractor.equals(Object) and AbstractExtractor.hashCode() describe how this Extractor can be equivalent to other ValueExtractor implementations.

Since:

12.2.1.4

Author:

cp/gg 2002.11.01, ew 2007.02.01, jf 2017.11.20

See Also:

ChainedExtractor

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, Base.StackFrame

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	BEAN_ACCESSOR_PREFIXES JavaBean accessor prefixes.
protected Object[]	m_aoParam The parameter array.
protected String	m_sName A method or property name.
protected String	m_sNameCanon Canonical name for this extractor.
static String	METHOD_SUFFIX If m_sName ends with this suffix, it represents a method name.

Fields inherited from class com.tangosol.util.extractor.AbstractExtractor

KEY, m_nTarget, VALUE

Fields inherited from class com.tangosol.util.ExternalizableHelper

CHUNK_SIZE, CHUNK_THRESHOLD, CONVERTER_FROM_BINARY, CONVERTER_STRIP_INTDECO, CONVERTER_TO_BINARY, DECO_APP_1, DECO_APP_2, DECO_APP_3, 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_RSVD_2, DECO_STORE, DECO_TOPLINK, 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, MAX_DECO_HEADER_BYTES, PROPERTY_CONFIG, s_streamfactory, s_tloInEHDeserialize, TRINT_DOMAIN_SPAN, TRINT_MAX_VALUE, TRINT_MAX_VARIANCE, USE_POF_STREAMS, USE_XMLBEAN_CLASS_CACHE, XMLBEAN_CLASS_CACHE

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors

Constructor and Description
UniversalExtractor() Default constructor (necessary for the ExternalizableLite interface).
UniversalExtractor(String sName) Construct a UniversalExtractor based on syntax of sName.
UniversalExtractor(String sName, Object[] aoParam) Construct a UniversalExtractor based on a name and optional parameters.
UniversalExtractor(String sName, Object[] aoParam, int nTarget) Construct a UniversalExtractor based on a name, optional parameters and the entry extraction target.

Method Summary

Modifier and Type	Method and Description
static <T,E> ValueExtractor<T,E>	createExtractor(String sNames) Return a ValueExtractor representing dot separated list of property and/or method names.
boolean	equals(Object o) Compare the UniversalExtractor with another object to determine equality.
E	extract(T oTarget) Extract from target using reflection or map access.
protected E	extractComplex(T oTarget) Extract from target using reflection or map access.
String	getCanonicalName() Return the canonical name for this extractor.
String	getMethodName() Return the method name that this extractor is configured to invoke.
String	getName() Return the name passed into UniversalExtractor(String).
Object[]	getParameters() Return the array of arguments used to invoke the method.
String	getPropertyName() Return the property name of this extractor.
int	hashCode() HashCode value is hashCode of non-null canonical name; otherwise, it is the hashCode of sName passed to {#link UniversalExtractor(String)}.
protected void	init() Called in constructor and deserializers.
boolean	isMethodExtractor() Return true if this a method extractor.
boolean	isPropertyExtractor() Return true if this is a Property extractor.
void	readExternal(DataInput in) Restore the contents of this object by loading the object's state from the passed DataInput object.
void	readExternal(PofReader in) Restore the contents of a user type instance by reading its state using the specified PofReader object.
String	toString() Provide a human-readable description of this UniversalExtractor object.
void	writeExternal(DataOutput out) Save the contents of this object by storing the object's state into the passed DataOutput object.
void	writeExternal(PofWriter out) Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Methods inherited from class com.tangosol.util.extractor.AbstractExtractor

compare, compareEntries, extractFromEntry, extractOriginalFromEntry, 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, 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 com.tangosol.util.ValueExtractor

andThen, apply, applyAsDouble, applyAsInt, applyAsLong, compose, fromKey, getTarget, identity, identityCast, of

Methods inherited from interface com.tangosol.util.function.Remote.Function

andThen, compose

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

BEAN_ACCESSOR_PREFIXES

public static final String[] BEAN_ACCESSOR_PREFIXES

JavaBean accessor prefixes.

METHOD_SUFFIX

public static final String METHOD_SUFFIX

If m_sName ends with this suffix, it represents a method name.

See Also:

Constant Field Values

m_sName

protected String m_sName

A method or property name.

m_aoParam

protected Object[] m_aoParam

The parameter array. Must be null or zero length for a property based extractor.

m_sNameCanon

protected transient String m_sNameCanon

Canonical name for this extractor.

Note: subclasses are responsible for initialization and POF and/or Lite serialization of this field.

Constructor Detail

UniversalExtractor

public UniversalExtractor()

Default constructor (necessary for the ExternalizableLite interface).

UniversalExtractor

public UniversalExtractor(String sName)

Construct a UniversalExtractor based on syntax of sName.

If sName does not end in METHOD_SUFFIX, "()", this extractor is a property extractor. If sName is prefixed with one of the BEAN_ACCESSOR_PREFIXES and ends in the METHOD_SUFFIX, this extractor is a property extractor. Otherwise, if the sName just ends in {#link #METHOD_SUFFIX}, this extractor is considered a method extractor.

Parameters:

sName - a method or property name

UniversalExtractor

public UniversalExtractor(String sName,
                          Object[] aoParam)

Construct a UniversalExtractor based on a name and optional parameters.

If sName does not end in METHOD_SUFFIX, "()", and has no aoParams,this extractor is a property extractor. If sName is prefixed with one of the BEAN_ACCESSOR_PREFIXES, ends in METHOD_SUFFIX and has no aoParams,this extractor is a property extractor. Otherwise, if the sNamejust ends in {#link #METHOD_SUFFIX}, this extractor is considered a method extractor.

Parameters:

sName - a method or property name

aoParam - the array of arguments to be used in the method invocation; may be null

Throws:

IllegalArgumentException - when sName does not end in METHOD_SUFFIX and aoParam array length is one or more.

UniversalExtractor

public UniversalExtractor(String sName,
                          Object[] aoParam,
                          int nTarget)

Construct a UniversalExtractor based on a name, optional parameters and the entry extraction target.

If sName does not end in METHOD_SUFFIX, "()", this extractor is a property extractor. If sName is prefixed with one of the BEAN_ACCESSOR_PREFIXES and ends in METHOD_SUFFIX, this extractor is a property extractor. If the sName just ends in METHOD_SUFFIX, this extractor is considered a method extractor.

Parameters:

sName - a method or property name

aoParam - the array of arguments to be used in the method invocation; may be null

nTarget - one of the AbstractExtractor.VALUE or AbstractExtractor.KEY values

Throws:

IllegalArgumentException - when sName does not end in METHOD_SUFFIX and aoParam array length is one or more.

Method Detail

extract

public E extract(T oTarget)

Extract from target using reflection or map access.

If name is a property, reflection accessor method lookup on T fails and oTarget is an instance Map, use canonical name to get value from target.

Specified by:

extract in interface ValueExtractor<T,E>

Overrides:

extract in class AbstractExtractor<T,E>

Parameters:

oTarget - the target

Returns:

value extracted from target

getCanonicalName

public String getCanonicalName()

Description copied from interface: ValueExtractor

Return the canonical name for this extractor.

A canonical name uniquely identifies what is to be extracted, but not how it is to be extracted. Thus two different extractor implementations with the same non-null canonical name are considered to be equal, and should reflect this in their implementations of hashCode and equals.

Canonical names for properties are designated by their property name in camel case, for instance a Java Bean with method getFooBar would have a property named fooBar, and would have fooBar as its canonical name.

Canonical names for zero-arg method invocations are the method name followed by ().

Dots in a canonical name delimit one or more property/method accesses represented by a chaining ValueExtractor such as ChainedExtractor or PofExtractor(Class, PofNavigator, String).

There is currently no canonical name format for methods which take parameters and as such they must return a canonical name of null.

Specified by:

getCanonicalName in interface CanonicallyNamed

Specified by:

getCanonicalName in interface ValueExtractor<T,E>

Overrides:

getCanonicalName in class AbstractExtractor<T,E>

Returns:

the extractor's canonical name, or null

equals

public boolean equals(Object o)

Compare the UniversalExtractor with another object to determine equality.

AbstractExtractor.equals(Object) contract takes precedence when applicable, falling back to implementation specific equals.

Two UniversalExtractor objects, re1 and re2 are considered equal if re1.extract(o) equals re2.extract(o) for all values of o.

Specified by:

equals in interface ValueExtractor<T,E>

Specified by:

equals in interface Comparator

Overrides:

equals in class AbstractExtractor<T,E>

Parameters:

o - the reference object with which to compare

Returns:

true iff this UniversalExtractor and the passed object are equivalent

hashCode

public int hashCode()

HashCode value is hashCode of non-null canonical name; otherwise, it is the hashCode of sName passed to {#link UniversalExtractor(String)}.

Specified by:

hashCode in interface ValueExtractor<T,E>

Overrides:

hashCode in class AbstractExtractor<T,E>

Returns:

an integer hash value for this UniversalExtractor object

toString

public String toString()

Provide a human-readable description of this UniversalExtractor object.

Overrides:

toString in class Object

Returns:

a human-readable description of this UniversalExtractor object

init

protected void init()

Called in constructor and deserializers.

getMethodName

public String getMethodName()

Return the method name that this extractor is configured to invoke. If a reflection-based method extractor, isMethodExtractor(), return the method name to be invoked. If a property extractor, return the likely JavaBean accessor method name.

Returns:

method name

getName

public String getName()

Return the name passed into UniversalExtractor(String).

Returns:

the name of extraction attribute.

getPropertyName

public String getPropertyName()

Return the property name of this extractor.

Returns:

property name of this extractor; otherwise, return null.

isPropertyExtractor

public boolean isPropertyExtractor()

Return true if this is a Property extractor.

Returns:

true if this a property extractor.

isMethodExtractor

public boolean isMethodExtractor()

Return true if this a method extractor.

Returns:

true if this is a method extractor.

getParameters

public Object[] getParameters()

Return the array of arguments used to invoke the method.

Returns:

the array of arguments used to invoke the method

extractComplex

protected E extractComplex(T oTarget)
                    throws InvocationTargetException,
                           IllegalAccessException

Extract from target using reflection or map access. If name is a property, reflection accessor method lookup on T fails and T is an instance Map, use canonical name to get value from target. If successful, cache the reflection computation.

Parameters:

oTarget - the target

Returns:

value extracted from target

Throws:

InvocationTargetException - if reflection method lookup fails

IllegalAccessException - if reflection method lookup fails

createExtractor

public static <T,E> ValueExtractor<T,E> createExtractor(String sNames)

Return a ValueExtractor representing dot separated list of property and/or method names.

Type Parameters:

T - the type of the value to extract from

E - the type of value that will be extracted

Parameters:

sNames - dot-delimited property and/or methods name(s)

Returns:

UniversalExtractor if only one name in parameter; otherwise, return a ChainedExtractor with a UniversalExtractor for each name.

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 interface ExternalizableLite

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 occurs

NotActiveException - 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 interface ExternalizableLite

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 interface PortableObject

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 interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs