|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
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.ArrayFilter
public abstract class ArrayFilter
Filter which is a logical operator of a filter array.
Nested Class Summary | |
---|---|
protected static class |
ArrayFilter.WeightedFilter A thin wrapper around a Filter allowing for sorting the filters according to their effectiveness. |
Field Summary | |
---|---|
protected Filter[] |
m_aFilter The Filter array. |
Constructor Summary | |
---|---|
ArrayFilter() Default constructor (necessary for the ExternalizableLite interface). |
|
ArrayFilter(Filter[] aFilter) Construct a logical filter that applies a binary operator to a filter array. |
Method Summary | |
---|---|
protected Filter |
applyFilter(Filter filter, int iFilter, java.util.Map mapIndexes, java.util.Set setKeys, QueryContext ctx, QueryRecord.PartialResult.TraceStep step) Apply the specified IndexAwareFilter to the specified keySet. |
Filter |
applyIndex(java.util.Map mapIndexes, java.util.Set setKeys) Filter remaining keys using a Map of available indexes. |
protected abstract Filter |
applyIndex(java.util.Map mapIndexes, java.util.Set setKeys, QueryContext ctx, QueryRecord.PartialResult.TraceStep step) Apply the specified IndexAwareFilter to the specified keySet. |
protected ArrayFilter.WeightedFilter[] |
calculateFilters(java.util.Map mapIndexes, java.util.Set setKeys) Calculate the effectiveness and sort all the participating filters according to their effectiveness. |
boolean |
equals(java.lang.Object o) Compare the ArrayFilter with another object to determine equality. |
boolean |
evaluateEntry(java.util.Map.Entry entry) Apply the test to a Map Entry. |
protected abstract boolean |
evaluateEntry(java.util.Map.Entry entry, QueryContext ctx, QueryRecord.PartialResult.TraceStep step) Check if the given entry passes the filter's evaluation. |
protected boolean |
evaluateFilter(Filter filter, java.util.Map.Entry entry, QueryContext ctx, QueryRecord.PartialResult.TraceStep step) Check if the given entry passes the given filter's evaluation. |
void |
explain(QueryContext ctx, QueryRecord.PartialResult.ExplainStep step, java.util.Set setKeys) Record the projected query execution cost by this filter. |
Filter[] |
getFilters() Obtain the Filter array. |
int |
hashCode() Determine a hash value for the ArrayFilter object according to the general Object.hashCode() contract. |
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. |
java.lang.String |
toString() Return a human-readable description for this Filter. |
boolean |
trace(QueryContext ctx, QueryRecord.PartialResult.TraceStep step, java.util.Map.Entry entry) Evaluate the specified entry against this filter and record the evaluation cost on the given step of the QueryRecord . |
Filter |
trace(QueryContext ctx, QueryRecord.PartialResult.TraceStep step, java.util.Set setKeys) Filter the given keys using available indexes and record the cost of execution on the given step of the QueryRecord . |
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.BitHelper |
---|
countBits, countBits, countBits, indexOfLSB, indexOfLSB, indexOfLSB, indexOfMSB, indexOfMSB, indexOfMSB, rotateLeft, rotateLeft, rotateLeft, rotateRight, rotateRight, rotateRight, toBitString, toBitString, toBitString |
Methods inherited from interface com.tangosol.util.filter.IndexAwareFilter |
---|
calculateEffectiveness |
Methods inherited from interface com.tangosol.util.Filter |
---|
evaluate |
Field Detail |
---|
protected Filter[] m_aFilter
Constructor Detail |
---|
public ArrayFilter()
public ArrayFilter(Filter[] aFilter)
aFilter[0] <op> aFilter[1] ... <op> aFilter[n]
aFilter
- the filter arrayMethod Detail |
---|
public boolean evaluateEntry(java.util.Map.Entry entry)
evaluateEntry
in interface EntryFilter
entry
- the Map Entry to evaluate; never nullpublic 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
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 void explain(QueryContext ctx, QueryRecord.PartialResult.ExplainStep step, java.util.Set setKeys)
This method is expected to record the order of execution and estimated cost of applying corresponding indexes in the given step
without actually applying any indexes or evaluating entries.
explain
in interface QueryRecorderFilter
ctx
- the query contextstep
- the step used to record the estimated execution costsetKeys
- the set of keys that would be filteredpublic Filter trace(QueryContext ctx, QueryRecord.PartialResult.TraceStep step, java.util.Set setKeys)
QueryRecord
.
This method should record the size of the given key set before and after applying corresponding indexes using QueryRecord.PartialResult.RecordableStep.recordPreFilterKeys(int)
and QueryRecord.PartialResult.TraceStep.recordPostFilterKeys(int)
as well as the corresponding execution time using the QueryRecord.PartialResult.TraceStep.recordDuration(long)
method.
This method is only called if the filter is an IndexAwareFilter
and its implementations should explicitly call applyIndex()
to actually perform the query. Additionally, this method should return the filter object (if any) returned by the applyIndex() call.
trace
in interface QueryRecorderFilter
ctx
- the query contextstep
- the step used to record the execution costsetKeys
- the mutable set of keys that remain to be filteredIndexAwareFilter.applyIndex(Map, Set)
public boolean trace(QueryContext ctx, QueryRecord.PartialResult.TraceStep step, java.util.Map.Entry entry)
QueryRecord
.
This method should record the corresponding latencies using QueryRecord.PartialResult.TraceStep.recordDuration(long)
.
Implementations are responsible for explicitly calling evaluateEntry()
method to perform the actual entry evaluation. Additionally, this method should return the result of the evaluateEntry call.
trace
in interface QueryRecorderFilter
ctx
- the contextstep
- the step used to record the evaluation costentry
- the entry to evaluateEntryFilter.evaluateEntry(Map.Entry)
protected abstract Filter applyIndex(java.util.Map mapIndexes, java.util.Set setKeys, QueryContext ctx, QueryRecord.PartialResult.TraceStep step)
mapIndexes
- the available MapIndex objects keyed by the related ValueExtractor; read-onlysetKeys
- the set of keys that would be filteredctx
- the query ctx; may be nullstep
- the step used to record the execution costprotected abstract boolean evaluateEntry(java.util.Map.Entry entry, QueryContext ctx, QueryRecord.PartialResult.TraceStep step)
entry
- a key value pair to filterctx
- the query ctx; may be nullstep
- the step used to record the execution costpublic Filter[] getFilters()
protected ArrayFilter.WeightedFilter[] calculateFilters(java.util.Map mapIndexes, java.util.Set setKeys)
mapIndexes
- the available MapIndex objects keyed by the related ValueExtractor; read-onlysetKeys
- the set of keys that will be filtered; read-onlyprotected Filter applyFilter(Filter filter, int iFilter, java.util.Map mapIndexes, java.util.Set setKeys, QueryContext ctx, QueryRecord.PartialResult.TraceStep step)
filter
- the IndexAwareFilter to apply an index toiFilter
- the index of the given filter in this filter's array of indexesmapIndexes
- the available MapIndex objects keyed by the related ValueExtractor; read-onlysetKeys
- the mutable set of keys that remain to be filteredctx
- the query ctx; may be nullstep
- the step used to record the execution costprotected boolean evaluateFilter(Filter filter, java.util.Map.Entry entry, QueryContext ctx, QueryRecord.PartialResult.TraceStep step)
filter
- the Filter to use to evaluate the entryentry
- a key value pair to filterctx
- the query ctx; may be nullstep
- the step used to record the execution costpublic boolean equals(java.lang.Object o)
public int hashCode()
Object.hashCode()
contract.public java.lang.String toString()
public void readExternal(java.io.DataInput in) throws java.io.IOException
readExternal
in interface ExternalizableLite
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
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
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
out
- the PofWriter to which to write the object's statejava.io.IOException
- if an I/O error occurs
|
Oracle® Coherence Java API Reference Release 12.1.2.0.3 E26043-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |