|
Oracle® Fusion Middleware Java API Reference for Oracle Coherence 12c (12.1.3.0.0) E47890-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.util.Base
com.tangosol.util.BitHelper
com.tangosol.util.ExternalizableHelper
com.tangosol.util.filter.AbstractQueryRecorderFilter
com.tangosol.util.filter.ExtractorFilter
com.tangosol.util.filter.ComparisonFilter
com.tangosol.util.filter.LikeFilter
public class LikeFilter
Filter which compares the result of a method invocation with a value for pattern match. A pattern can include regular characters and wildcard characters '_' and '%'.
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.
Field Summary |
---|
Fields inherited from class com.tangosol.util.filter.ComparisonFilter |
---|
m_oValue |
Fields inherited from class com.tangosol.util.filter.ExtractorFilter |
---|
EVAL_COST, m_extractor |
Constructor Summary | |
---|---|
LikeFilter() Default constructor (necessary for the ExternalizableLite interface). |
|
LikeFilter(java.lang.String sMethod, java.lang.String sPattern) Construct a LikeFilter for pattern match. |
|
LikeFilter(java.lang.String sMethod, java.lang.String sPattern, boolean fIgnoreCase) Construct a LikeFilter for pattern match. |
|
LikeFilter(java.lang.String sMethod, java.lang.String sPattern, char chEscape, boolean fIgnoreCase) Construct a LikeFilter for pattern match. |
|
LikeFilter(ValueExtractor extractor, java.lang.String sPattern, char chEscape, boolean fIgnoreCase) Construct a LikeFilter for pattern match. |
Method Summary | |
---|---|
Filter |
applyIndex(java.util.Map mapIndexes, java.util.Set setKeys) Filter remaining keys using a Map of available indexes. |
protected void |
buildPlan() Build a plan for processing the LIKE functionality. |
int |
calculateEffectiveness(java.util.Map mapIndexes, java.util.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(java.lang.Object oExtracted) Evaluate the specified extracted value. |
char |
getEscapeChar() Obtain the escape character that is used for escaping '%' and '_' in the pattern or zero if there is no escape. |
java.lang.String |
getPattern() Obtain the filter's pattern string. |
boolean |
isIgnoreCase() Check whether or not the filter is case incensitive. |
protected boolean |
isMatch(java.lang.String sValue) Check the passed String value to see if it matches the pattern that this filter was constructed with. |
void |
readExternal(java.io.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. |
void |
showPlan() Display the execution plan that the LikeFilter has selected. |
void |
writeExternal(java.io.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.filter.ComparisonFilter |
---|
calculateMatchEffectiveness, calculateRangeEffectiveness, equals, getValue, hashCode, toString, toStringValue |
Methods inherited from class com.tangosol.util.filter.ExtractorFilter |
---|
calculateIteratorEffectiveness, evaluate, evaluateEntry, extract, getValueExtractor |
Methods inherited from class com.tangosol.util.filter.AbstractQueryRecorderFilter |
---|
explain, explain, trace, trace, trace, trace |
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, toLong |
Methods inherited from interface com.tangosol.util.filter.EntryFilter |
---|
evaluateEntry |
Methods inherited from interface com.tangosol.util.Filter |
---|
evaluate |
Constructor Detail |
---|
public LikeFilter()
public LikeFilter(java.lang.String sMethod, java.lang.String sPattern)
sMethod
- the name of the method to invoke via reflectionsPattern
- the string pattern to compare the result withpublic LikeFilter(java.lang.String sMethod, java.lang.String sPattern, boolean fIgnoreCase)
sMethod
- the name of the method to invoke via reflectionsPattern
- the string pattern to compare the result withfIgnoreCase
- true to be case-insensitivepublic LikeFilter(java.lang.String sMethod, java.lang.String sPattern, char chEscape, boolean fIgnoreCase)
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-insensitivepublic LikeFilter(ValueExtractor extractor, java.lang.String sPattern, char chEscape, boolean fIgnoreCase)
extractor
- the ValueExtractor to use by this filtersPattern
- the string pattern to compare the result withchEscape
- the escape character for escaping '%' and '_'fIgnoreCase
- true to be case-insensitiveMethod Detail |
---|
protected boolean evaluateExtracted(java.lang.Object oExtracted)
evaluateExtracted
in class ExtractorFilter
oExtracted
- an extracted value to evaluatepublic int calculateEffectiveness(java.util.Map mapIndexes, java.util.Set setKeys)
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.
calculateEffectiveness
in interface IndexAwareFilter
calculateEffectiveness
in class ExtractorFilter
mapIndexes
- the available MapIndex
objects keyed by the related ValueExtractor; read-onlysetKeys
- the set of keys that will be filtered; read-onlypublic Filter applyIndex(java.util.Map mapIndexes, java.util.Set setKeys)
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.
applyIndex
in interface IndexAwareFilter
applyIndex
in class ExtractorFilter
mapIndexes
- the available MapIndex
objects keyed by the related ValueExtractor; read-onlysetKeys
- the mutable set of keys that remain to be filteredFilter
object (which may be an EntryFilter
) that can be used to process the remaining keys, or null if no additional filter processing is necessarypublic java.lang.String getPattern()
public boolean isIgnoreCase()
public char getEscapeChar()
public void showPlan()
public void readExternal(java.io.DataInput in) throws java.io.IOException
readExternal
in interface ExternalizableLite
readExternal
in class ComparisonFilter
in
- the DataInput stream to read data from in order to restore the state of this objectjava.io.IOException
- if an I/O exception occursjava.io.NotActiveException
- if the object is not in its initial state, and therefore cannot be deserialized intopublic void writeExternal(java.io.DataOutput out) throws java.io.IOException
writeExternal
in interface ExternalizableLite
writeExternal
in class ComparisonFilter
out
- the DataOutput stream to write the state of this object tojava.io.IOException
- if an I/O exception occurspublic void readExternal(PofReader in) throws java.io.IOException
readExternal
in interface PortableObject
readExternal
in class ComparisonFilter
in
- the PofReader from which to read the object's statejava.io.IOException
- if an I/O error occurspublic void writeExternal(PofWriter out) throws java.io.IOException
writeExternal
in interface PortableObject
writeExternal
in class ComparisonFilter
out
- the PofWriter to which to write the object's statejava.io.IOException
- if an I/O error occursprotected void buildPlan()
protected boolean isMatch(java.lang.String sValue)
sValue
- the String value to match against this filter's pattern
|
Oracle® Fusion Middleware Java API Reference for Oracle Coherence 12c (12.1.3.0.0) E47890-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |