Class LikeFilter<T,E>
- Type Parameters:
T
- the type of the input argument to the filterE
- the type of the extracted attribute to use for comparison
- All Implemented Interfaces:
ExternalizableLite
,PortableObject
,Filter<T>
,EntryFilter<Object,
,T> IndexAwareFilter<Object,
,T> QueryRecorderFilter<T>
,Serializable
During pattern matching, regular characters must exactly match the characters in an evaluated string. Wildcard character '_' (underscore) can be matched with any single character, and wildcard character '%' can be matched with any string fragment of zero or more characters.
- Author:
- cp/gg 2002.10.27
- See Also:
-
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 inherited from class com.tangosol.util.filter.ComparisonFilter
m_value
Fields inherited from class com.tangosol.util.filter.ExtractorFilter
EVAL_COST, m_extractor
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
ConstructorDescriptionDefault constructor (necessary for the ExternalizableLite interface).LikeFilter
(ValueExtractor<? super T, ? extends E> extractor, String sPattern) Construct a LikeFilter for pattern match.LikeFilter
(ValueExtractor<? super T, ? extends E> extractor, String sPattern, char chEscape, boolean fIgnoreCase) Construct a LikeFilter for pattern match.LikeFilter
(String sMethod, String sPattern) Construct a LikeFilter for pattern match.LikeFilter
(String sMethod, String sPattern, boolean fIgnoreCase) Construct a LikeFilter for pattern match.LikeFilter
(String sMethod, String sPattern, char chEscape, boolean fIgnoreCase) Construct a LikeFilter for pattern match. -
Method Summary
Modifier and TypeMethodDescriptionapplyIndex
(Map mapIndexes, Set setKeys) Filter remaining keys using a Map of available indexes.protected void
Build a plan for processing the LIKE functionality.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.protected boolean
evaluateExtracted
(E extracted) Evaluate the specified extracted value.char
Obtain the escape character that is used for escaping '%' and '_' in the pattern or zero if there is no escape.Obtain the filter's pattern string.boolean
Check whether or not the filter is case incensitive.protected boolean
Check the passed String value to see if it matches the pattern that this filter was constructed with.void
Restore the contents of a user type instance by reading its state using the specified PofReader object.void
Restore the contents of this object by loading the object's state from the passed DataInput object.void
showPlan()
Display the execution plan that the LikeFilter has selected.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.filter.ComparisonFilter
calculateMatchEffectiveness, calculateRangeEffectiveness, equals, getValue, hashCode, toString, toStringValue
Methods inherited from class com.tangosol.util.filter.ExtractorFilter
calculateIteratorEffectiveness, ensureSafeSet, evaluate, evaluateEntry, extract, getValueExtractor
Methods inherited from class com.tangosol.util.filter.AbstractQueryRecorderFilter
explain, explain, explain, trace, trace, trace, trace, trace
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, isResolving, isSerializable, isSerializerCompatible, 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.EntryFilter
evaluateEntry
Methods inherited from interface com.tangosol.util.Filter
and, asLimitFilter, associatedWith, evaluate, forKeys, forPartitions, or, xor
-
Constructor Details
-
LikeFilter
public LikeFilter()Default constructor (necessary for the ExternalizableLite interface). -
LikeFilter
Construct a LikeFilter for pattern match.- Parameters:
sMethod
- the name of the method to invoke via reflectionsPattern
- the string pattern to compare the result with
-
LikeFilter
Construct a LikeFilter for pattern match.- Parameters:
sMethod
- the name of the method to invoke via reflectionsPattern
- the string pattern to compare the result withfIgnoreCase
- true to be case-insensitive
-
LikeFilter
Construct a LikeFilter for pattern match.- Parameters:
sMethod
- the name of the method to invoke via reflectionsPattern
- the string pattern to compare the result withchEscape
- the escape character for escaping '%' and '_'fIgnoreCase
- true to be case-insensitive
-
LikeFilter
Construct a LikeFilter for pattern match.- Parameters:
extractor
- theValueExtractor
used by this filtersPattern
- the string pattern to compare the result with
-
LikeFilter
public LikeFilter(ValueExtractor<? super T, ? extends E> extractor, String sPattern, char chEscape, boolean fIgnoreCase) Construct a LikeFilter for pattern match.- Parameters:
extractor
- theValueExtractor
used by this filtersPattern
- the string pattern to compare the result withchEscape
- the escape character for escaping '%' and '_'fIgnoreCase
- true to be case-insensitive
-
-
Method Details
-
evaluateExtracted
Evaluate the specified extracted value.- Specified by:
evaluateExtracted
in classExtractorFilter<T,
E> - Parameters:
extracted
- an extracted value to evaluate- Returns:
- true iff the test passes
-
calculateEffectiveness
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 well this filter can use the specified indexes to filter the specified keys. An operation that requires no more than a single access to the index content (i.e. Equals, NotEquals) has an effectiveness of one. Evaluation of a single entry is assumed to have an effectiveness that depends on the index implementation and is usually measured as a constant number of the single operations. This number is referred to as evaluation cost.
If the effectiveness of a filter evaluates to a number larger than the keySet.size() * <evaluation cost> then a user could avoid using the index and iterate through the keySet calling evaluate rather then applyIndex.
- Specified by:
calculateEffectiveness
in interfaceIndexAwareFilter<T,
E> - Overrides:
calculateEffectiveness
in classExtractorFilter<T,
E> - Parameters:
mapIndexes
- the availableMapIndex
objects keyed by the related ValueExtractor; read-onlysetKeys
- 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
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 interfaceIndexAwareFilter<T,
E> - Overrides:
applyIndex
in classExtractorFilter<T,
E> - Parameters:
mapIndexes
- the availableMapIndex
objects keyed by the related ValueExtractor; read-onlysetKeys
- the mutable set of keys that remain to be filtered- Returns:
- a
Filter
object (which may be anEntryFilter
) that can be used to process the remaining keys, or null if no additional filter processing is necessary
-
getPattern
Obtain the filter's pattern string.- Returns:
- the pattern string
-
isIgnoreCase
public boolean isIgnoreCase()Check whether or not the filter is case incensitive.- Returns:
- true iff case insensitivity is specifically enabled
-
getEscapeChar
public char getEscapeChar()Obtain the escape character that is used for escaping '%' and '_' in the pattern or zero if there is no escape.- Returns:
- the escape character
-
showPlan
public void showPlan()Display the execution plan that the LikeFilter has selected. -
readExternal
Restore the contents of this object by loading the object's state from the passed DataInput object.- Specified by:
readExternal
in interfaceExternalizableLite
- Overrides:
readExternal
in classComparisonFilter<T,
E, String> - 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
-
writeExternal
Save the contents of this object by storing the object's state into the passed DataOutput object.- Specified by:
writeExternal
in interfaceExternalizableLite
- Overrides:
writeExternal
in classComparisonFilter<T,
E, String> - Parameters:
out
- the DataOutput stream to write the state of this object to- Throws:
IOException
- if an I/O exception occurs
-
readExternal
Restore the contents of a user type instance by reading its state using the specified PofReader object.- Specified by:
readExternal
in interfacePortableObject
- Overrides:
readExternal
in classComparisonFilter<T,
E, String> - Parameters:
in
- the PofReader from which to read the object's state- Throws:
IOException
- if an I/O error occurs
-
writeExternal
Save the contents of a POF user type instance by writing its state using the specified PofWriter object.- Specified by:
writeExternal
in interfacePortableObject
- Overrides:
writeExternal
in classComparisonFilter<T,
E, String> - Parameters:
out
- the PofWriter to which to write the object's state- Throws:
IOException
- if an I/O error occurs
-
buildPlan
protected void buildPlan()Build a plan for processing the LIKE functionality. -
isMatch
Check the passed String value to see if it matches the pattern that this filter was constructed with.- Parameters:
sValue
- the String value to match against this filter's pattern- Returns:
- true iff the passed String value is LIKE this filter's pattern
-