Package com.tangosol.util

Class SimpleQueryRecord.PartialResult.IndexLookupRecord

java.lang.Object

com.tangosol.util.SimpleQueryRecord.PartialResult.IndexLookupRecord

All Implemented Interfaces:

ExternalizableLite, PortableObject, QueryRecord.PartialResult.IndexLookupRecord, Serializable

Enclosing class:

SimpleQueryRecord.PartialResult

public static class SimpleQueryRecord.PartialResult.IndexLookupRecord
extends Object
implements QueryRecord.PartialResult.IndexLookupRecord, ExternalizableLite, PortableObject

Simple QueryRecord.PartialResult.IndexLookupRecord implementation.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	IndexLookupRecord()	Default constructor (necessary for the ExternalizableLite interface).
	IndexLookupRecord(QueryRecord.PartialResult.IndexLookupRecord record)	Copy constructor for an IndexLookupRecord.
	IndexLookupRecord(ValueExtractor extractor, MapIndex index)	Construct an IndexLookupRecord.
protected	IndexLookupRecord(String sExtractor, String sIndex, boolean fOrdered, long cBytes, int cDistinctValues, String sIndexDef)	Construct an IndexLookupRecord.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getExtractorDescription()	Get a description of the extractor that was used for the index lookup.
String	getIndexDef()	Returns the index definition.
String	getIndexDescription()	Get a description of the associated index.
long	getMemoryUsage()	Returns index memory usage in bytes.
int	getSize()	Return index content map size.
int	hashCode()
boolean	isOrdered()	Indicates whether or not the associated index is ordered.
protected void	parseIndexDescription(String sIndex)	Parses an index description into it's definition, footprint, and map size.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexLookupRecord

public IndexLookupRecord()

Default constructor (necessary for the ExternalizableLite interface).

IndexLookupRecord

public IndexLookupRecord(ValueExtractor extractor,
                         MapIndex index)

Construct an IndexLookupRecord.

Parameters:

extractor - the extractor

index - the index

IndexLookupRecord

public IndexLookupRecord(QueryRecord.PartialResult.IndexLookupRecord record)

Copy constructor for an IndexLookupRecord.

Parameters:

record - the record to copy

IndexLookupRecord

protected IndexLookupRecord(String sExtractor,
                            String sIndex,
                            boolean fOrdered,
                            long cBytes,
                            int cDistinctValues,
                            String sIndexDef)

Construct an IndexLookupRecord.

Parameters:

sExtractor - the extractor description

sIndex - the index description

fOrdered - indicates whether or not the associated index is ordered

cBytes - the index footprint

cDistinctValues - the index size

sIndexDef - the index definition

Method Detail

getExtractorDescription

public String getExtractorDescription()

Get a description of the extractor that was used for the index lookup.

Specified by:

getExtractorDescription in interface QueryRecord.PartialResult.IndexLookupRecord

Returns:

the extractor description

getIndexDescription

public String getIndexDescription()

Get a description of the associated index.

Specified by:

getIndexDescription in interface QueryRecord.PartialResult.IndexLookupRecord

Returns:

the index description; null if no index was found for the associated extractor

getMemoryUsage

public long getMemoryUsage()

Returns index memory usage in bytes.

Returns:

index memory usage in bytes; -1 if there is no index

getSize

public int getSize()

Return index content map size.

Returns:

index content map size; -1 if there is no index

getIndexDef

public String getIndexDef()

Returns the index definition.

Returns:

the index definition; null if there is no index

isOrdered

public boolean isOrdered()

Indicates whether or not the associated index is ordered.

Specified by:

isOrdered in interface QueryRecord.PartialResult.IndexLookupRecord

Returns:

true if the associated index is ordered; false if the index is not ordered or if no index was found for the associated extractor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

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

parseIndexDescription

protected void parseIndexDescription(String sIndex)

Parses an index description into it's definition, footprint, and map size.

Parameters:

sIndex - the index description