Package com.tangosol.util.filter

Class PresentFilter<T>

java.lang.Object

com.tangosol.util.Base

com.tangosol.util.BitHelper

com.tangosol.util.ExternalizableHelper

com.tangosol.util.filter.PresentFilter<T>

Type Parameters:

T - the type of the input argument to the filter

All Implemented Interfaces:

ExternalizableLite, PortableObject, Filter<T>, EntryFilter<Object,T>, IndexAwareFilter<Object,T>, Serializable

public class PresentFilter<T>
extends ExternalizableHelper
implements Filter<T>, EntryFilter<Object,T>, IndexAwareFilter<Object,T>, ExternalizableLite, PortableObject

Filter which returns true for InvocableMap.Entry objects that currently exist in a Map.

This Filter is intended to be used solely in combination with a ConditionalProcessor and is unnecessary for standard QueryMap operations.

Author:

jh 2005.12.16

See Also:

InvocableMap.Entry.isPresent(), 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
static PresentFilter	INSTANCE	An instance of the PresentFilter.

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

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_CONFIG, 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	Description
PresentFilter()	Construct a PresentFilter.

Method Summary

Modifier and Type	Method	Description
Filter	applyIndex(Map mapIndexes, Set setKeys)	Filter remaining keys using a Map of available indexes.
int	calculateEffectiveness(Map mapIndexes, Set setKeys)	Given a Map of available indexes, determine if this IndexAwareFilter can use any of the indexes to assist in its processing, and if so, determine how effective the use of that index would be.
boolean	equals(Object o)	Compare the PresentFilter with another object to determine equality.
boolean	evaluate(T o)	Apply the test to the input argument.
boolean	evaluateEntry(Map.Entry entry)	Apply the test to a Map Entry.
int	hashCode()	Determine a hash value for the PresentFilter object according to the general Object.hashCode() contract.
static <T> PresentFilter<T>	INSTANCE()	Return an instance of the PresentFilter.
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	toExpression()	Return a string expression for this filter.
String	toString()	Return a human-readable description for this Filter.
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.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.Filter

and, asLimitFilter, associatedWith, forKeys, forPartitions, or, xor

Field Detail

INSTANCE

public static final PresentFilter INSTANCE

An instance of the PresentFilter.

Constructor Detail

PresentFilter

public PresentFilter()

Construct a PresentFilter.

Method Detail

evaluate

public boolean evaluate(T o)

Apply the test to the input argument.

Specified by:

evaluate in interface Filter<T>

Parameters:

o - the input argument to evaluate

Returns:

true if the input argument matches the filter, otherwise false

toExpression

public String toExpression()

Description copied from interface: Filter

Return a string expression for this filter.

Specified by:

toExpression in interface Filter<T>

Returns:

a string expression for this filter

evaluateEntry

public boolean evaluateEntry(Map.Entry entry)

Apply the test to a Map Entry.

Specified by:

evaluateEntry in interface EntryFilter<Object,T>

Parameters:

entry - the Map Entry to evaluate; never null

Returns:

true if the test passes, false otherwise

calculateEffectiveness

public int calculateEffectiveness(Map mapIndexes,
                                  Set setKeys)

Given a Map of available indexes, determine if this IndexAwareFilter can use any of the indexes to assist in its processing, and if so, determine how effective the use of that index would be.

The returned value is an effectiveness estimate of how many keys will remain in the set after the index is applied. If no keys will remain in the set after the index is applied, this method should return 0. If all the keys will remain in the set, implying that no entries would be filtered out based on this filter, this method should return setKeys.size(). Otherwise, it should return the value between 0 and setKeys.size(). If there is no index in the specified index map that can be used by this filter, this method should return a negative integer.

The effectiveness returned will be used by the composite filters to reorder nested filters from most to least effective, in order to optimize query execution.

Specified by:

calculateEffectiveness in interface IndexAwareFilter<Object,T>

Parameters:

mapIndexes - the available MapIndex objects keyed by the related ValueExtractor; read-only

setKeys - the set of keys that will be filtered; read-only

Returns:

an effectiveness estimate of how well this filter can use the specified indexes to filter the specified keys

applyIndex

public Filter applyIndex(Map mapIndexes,
                         Set setKeys)

Filter remaining keys using a Map of available indexes.

The filter is responsible for removing all keys from the passed set of keys that the applicable indexes can prove should be filtered. If the filter does not fully evaluate the remaining keys using just the index information, it must return a filter (which may be an EntryFilter) that can complete the task using an iterating implementation. If, on the other hand, the filter does fully evaluate the remaining keys using just the index information, then it should return null to indicate that no further filtering is necessary.

Specified by:

applyIndex in interface IndexAwareFilter<Object,T>

Parameters:

mapIndexes - the available MapIndex objects keyed by the related ValueExtractor; read-only

setKeys - the mutable set of keys that remain to be filtered

Returns:

a Filter object (which may be an EntryFilter) that can be used to process the remaining keys, or null if no additional filter processing is necessary

equals

public boolean equals(Object o)

Compare the PresentFilter with another object to determine equality.

Overrides:

equals in class Object

Returns:

true iff this PresentFilter and the passed object are equivalent PresentFilters

hashCode

public int hashCode()

Determine a hash value for the PresentFilter object according to the general Object.hashCode() contract.

Overrides:

hashCode in class Object

Returns:

an integer hash value for this PresentFilter object

toString

public String toString()

Return a human-readable description for this Filter.

Overrides:

toString in class Object

Returns:

a String description of the Filter

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

INSTANCE

public static <T> PresentFilter<T> INSTANCE()

Return an instance of the PresentFilter.

Type Parameters:

T - the type of the input argument to the filter

Returns:

a PresentFilter instance