|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tangosol.util.Base
com.tangosol.util.BitHelper
com.tangosol.util.ExternalizableHelper
com.tangosol.util.filter.NeverFilter
public class NeverFilter
Filter which always evaluates to false.
Field Summary | |
---|---|
static NeverFilter |
INSTANCE
An instance of the NeverFilter. |
Constructor Summary | |
---|---|
NeverFilter()
Construct a NeverFilter. |
Method Summary | |
---|---|
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 NeverFilter with another object to determine equality. |
boolean |
evaluate(Object o)
Apply the test to the object. |
boolean |
evaluateEntry(Map.Entry entry)
Apply the test to a Map Entry. |
int |
hashCode()
Determine a hash value for the NeverFilter object according to the general Object.hashCode() contract. |
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()
Return a human-readable description for this Filter. |
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.BitHelper |
---|
countBits, countBits, countBits, indexOfLSB, indexOfLSB, indexOfLSB, indexOfMSB, indexOfMSB, indexOfMSB, toBitString, toBitString, toBitString |
Field Detail |
---|
public static final NeverFilter INSTANCE
Constructor Detail |
---|
public NeverFilter()
Method Detail |
---|
public boolean evaluate(Object o)
evaluate
in interface Filter
public boolean evaluateEntry(Map.Entry entry)
evaluateEntry
in interface EntryFilter
entry
- the Map Entry to evaluate; never null
public int calculateEffectiveness(Map mapIndexes, 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
mapIndexes
- the available MapIndex objects keyed by the related
ValueExtractor; read-onlysetKeys
- the set of keys that will be filtered; read-only
public Filter applyIndex(Map mapIndexes, 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 filtered
Filter
object (which may be an EntryFilter
)
that can be used to process the remaining keys, or null if no
additional filter processing is necessarypublic boolean equals(Object o)
public int hashCode()
Object.hashCode()
contract.
public String toString()
public void readExternal(DataInput in) throws IOException
readExternal
in interface ExternalizableLite
in
- the DataInput stream to read data from in order to restore
the state of this object
IOException
- if an I/O exception occurs
NotActiveException
- if the object is not in its initial
state, and therefore cannot be deserialized intopublic void writeExternal(DataOutput out) throws IOException
writeExternal
in interface ExternalizableLite
out
- the DataOutput stream to write the state of this object to
IOException
- if an I/O exception occurspublic void readExternal(PofReader in) throws IOException
readExternal
in interface PortableObject
in
- the PofReader from which to read the object's state
IOException
- if an I/O error occurspublic void writeExternal(PofWriter out) throws IOException
writeExternal
in interface PortableObject
out
- the PofWriter to which to write the object's state
IOException
- if an I/O error occurs
|
CoherenceTM v3.3 Copyright© 2000-2007 by Oracle Corporation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |