|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-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.extractor.AbstractExtractor
com.tangosol.util.extractor.ConditionalExtractor
public class ConditionalExtractor
An IndexAwareExtractor implementation that is only used to create a ConditionalIndex
. <p/> Note: the underlying ValueExtractor is used for value extraction during index creation and is the extractor that is associated with the created ConditionalIndex
in the given index map. Using the ConditionalExtractor to extract values in not supported.
Field Summary | |
---|---|
protected ValueExtractor |
m_extractor The underlying extractor. |
protected boolean |
m_fForwardIndex Specifies whether or not this extractor will create a ConditionalIndex that supports a forward index. |
protected Filter |
m_filter The filter used by this extractor. |
Fields inherited from class com.tangosol.util.extractor.AbstractExtractor |
---|
KEY, m_nTarget, VALUE |
Constructor Summary | |
---|---|
ConditionalExtractor() Construct the ConditionalExtractor. |
|
ConditionalExtractor(Filter filter, ValueExtractor extractor, boolean fForwardIndex) Construct the ConditionalExtractor. |
Method Summary | |
---|---|
MapIndex |
createIndex(boolean fOrdered, Comparator comparator, Map mapIndex) Create an index and associate it with the corresponding extractor. |
MapIndex |
destroyIndex(Map mapIndex) Destroy an existing index and remove it from the given map of indexes. |
Object |
extract(Object oTarget) Using a ConditionalExtractor to extract values in not supported. |
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 ConditionalExtractor. |
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.extractor.AbstractExtractor |
---|
compare, compareEntries, extractFromEntry, extractOriginalFromEntry |
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.ValueExtractor |
---|
equals, hashCode |
Methods inherited from interface java.util.Comparator |
---|
equals |
Field Detail |
---|
protected Filter m_filter
protected ValueExtractor m_extractor
protected boolean m_fForwardIndex
ConditionalIndex
that supports a forward index.Constructor Detail |
---|
public ConditionalExtractor()
public ConditionalExtractor(Filter filter, ValueExtractor extractor, boolean fForwardIndex)
filter
- the filter used by this extractor to create a ConditionalIndex
extractor
- the extractor used by this extractor to create a ConditionalIndex
; Note that the created index will be associated with this extractor in the given index mapfForwardIndex
- specifies whether or not this extractor will create a ConditionalIndex
that supports a forward mapMethod Detail |
---|
public MapIndex createIndex(boolean fOrdered, Comparator comparator, Map mapIndex)
createIndex
in interface IndexAwareExtractor
fOrdered
- true iff the contents of the indexed information should be ordered; false otherwisecomparator
- the Comparator object which imposes an ordering of entries in the index contents; or null if the entries' values natural ordering should be usedmapIndex
- Map<ValueExtractor, MapIndex> to be updated with the created indexpublic MapIndex destroyIndex(Map mapIndex)
destroyIndex
in interface IndexAwareExtractor
mapIndex
- map<ValueExtractor, MapIndex> to be updated by removing the index being destroyedpublic Object extract(Object oTarget)
extract
in interface ValueExtractor
extract
in class AbstractExtractor
oTarget
- an Object to retrieve the value fromUnsupportedOperationException
- alwayspublic 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 objectIOException
- if an I/O exception occursNotActiveException
- 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 toIOException
- 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 stateIOException
- 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 stateIOException
- if an I/O error occurspublic String toString()
toString
in interface ValueExtractor
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |