com.tangosol.util.filter
Class ExtractorFilter

java.lang.Object
  com.tangosol.util.Base
      com.tangosol.util.BitHelper
          com.tangosol.util.ExternalizableHelper
              com.tangosol.util.filter.ExtractorFilter

All Implemented Interfaces:

ExternalizableLite, PortableObject, Filter, EntryFilter, Serializable

Direct Known Subclasses:

ComparisonFilter, ValueChangeEventFilter

public abstract class ExtractorFilter
extends ExternalizableHelper
implements EntryFilter, ExternalizableLite, PortableObject

Base Filter implementation for doing extractor-based processing.

Author:

cp/gg 2002.11.01

Field Summary

static int	EVAL_COST The evaluation cost as a factor to the single index access operation.
protected ValueExtractor	m_extractor The ValueExtractor used by this filter.

Constructor Summary

ExtractorFilter()
Default constructor (necessary for the ExternalizableLite interface).

ExtractorFilter(String sMethod)
Construct an ExtractorFilter for a given method name.

ExtractorFilter(ValueExtractor extractor)
Construct a ExtractorFilter for a given ValueExtractor.

Method Summary

boolean	evaluate(Object oTarget) Apply the test to the object.
boolean	evaluateEntry(Map.Entry entry) Apply the test to a Map Entry.
protected abstract boolean	evaluateExtracted(Object oExtracted) Evaluate the specified extracted value.
protected Object	extract(Object o) Get the result of ValueExtractor invocation.
ValueExtractor	getValueExtractor() Obtain the ValueExtractor used by this filter.
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.
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

EVAL_COST

public static int EVAL_COST

The evaluation cost as a factor to the single index access operation.

See Also:

IndexAwareFilter.calculateEffectiveness(Map, Set)

m_extractor

protected ValueExtractor m_extractor

The ValueExtractor used by this filter.

Constructor Detail

ExtractorFilter

public ExtractorFilter()

Default constructor (necessary for the ExternalizableLite interface).

ExtractorFilter

public ExtractorFilter(ValueExtractor extractor)

Construct a ExtractorFilter for a given ValueExtractor.

Parameters:

extractor - the ValueExtractor to use by this filter

ExtractorFilter

public ExtractorFilter(String sMethod)

Construct an ExtractorFilter for a given method name.

Parameters:

sMethod - a method name to make a ReflectionExtractor for; this parameter can also be a dot-delimited sequence of method names which would result in an ExtractorFilter based on the ChainedExtractor that is based on an array of corresponding ReflectionExtractor objects

Method Detail

evaluate

public boolean evaluate(Object oTarget)

Apply the test to the object.

Specified by:

evaluate in interface Filter

Returns:

true if the test passes, false otherwise

evaluateEntry

public boolean evaluateEntry(Map.Entry entry)

Apply the test to a Map Entry.

Specified by:

evaluateEntry in interface EntryFilter

Parameters:

entry - the Map Entry to evaluate; never null

Returns:

true if the test passes, false otherwise

evaluateExtracted

protected abstract boolean evaluateExtracted(Object oExtracted)

Evaluate the specified extracted value.

Parameters:

oExtracted - an extracted value to evaluate

extract

protected Object extract(Object o)

Get the result of ValueExtractor invocation.

Parameters:

o - the object on which to invoke the ValueExtractor; must not be null

Returns:

the result of the method invocation

Throws:

WrapperException - if this ValueExtractor encounters an exception in the course of extracting the value

getValueExtractor

public ValueExtractor getValueExtractor()

Obtain the ValueExtractor used by this filter.

Returns:

the ValueExtractor used by this 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