Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.4.0)

E90870-01

SimpleQueryRecord::PartialResult::IndexLookupRecord Class Reference

#include <coherence/util/SimpleQueryRecord.hpp>

Inherits Object, and PortableObject.

List of all members.


Detailed Description

Simple QueryRecord::PartialResult::IndexLookupRecord implementation.

Public Types

typedef spec::Handle Handle
 IndexLookupRecord Handle definition.
typedef spec::View View
 IndexLookupRecord View definition.
typedef spec::Holder Holder
 IndexLookupRecord Holder definition.
typedef this_spec::Handle Handle
 PortableObject Handle definition.
typedef this_spec::View View
 PortableObject View definition.
typedef this_spec::Holder Holder
 PortableObject Holder definition.

Public Member Functions

virtual String::View getExtractorDescription () const
 
virtual String::View getIndexDescription () const
 
virtual bool isOrdered () const
 
int64_t getMemoryUsage () const
 Returns index memory usage in bytes.
int32_t getSize () const
 Return index content map size.
virtual String::View getIndexDef () const
 Returns the index definition.
virtual void readExternal (PofReader::Handle hIn)
 
virtual void writeExternal (PofWriter::Handle hOut) const
 
virtual bool equals (Object::View v) const
 
virtual size32_t hashCode () const
 Return a hash code value for the Object.

This method is supported for the benefit of hash-based containers.

The general contract of hashCode is:

  • Whenever it is invoked on the same Object more than once during an execution of an application, the hashCode method must consistently return the same value, provided no information used in equals comparisons on the object is modified. This value need not remain consistent from one execution of an application to another execution of the same application.
  • If two Objects are equal according to the equals method, then calling the hashCode method on each of the two Objects must produce the same value.
  • It is not required that if two Objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct results. However, the programmer should be aware that producing distinct results for unequal objects may improve the performance of hash-based containers.

The default implementation is identity based.

Returns:
a hash code value for this Object


Protected Member Functions

 IndexLookupRecord ()
 Construct an IndexLookupRecord.
 IndexLookupRecord (QueryRecord::PartialResult::IndexLookupRecord::View vThat)
 Copy constructor for an IndexLookupRecord.
 IndexLookupRecord (String::View vsExtractor, String::View vsIndex, bool fOrdered, int64_t cBytes, int32_t cDistinctValues, String::View vsIndexDef)
 Construct an IndexLookupRecord.
virtual String::View buildIndexDescription ()
 Build an index description for this index.
virtual void parseIndexDescription (String::View vsIndex)
 Parses an index description into it's definition, footprint, and map size.

Protected Attributes

FinalView< Stringf_vsExtractor
 The extractor description.
MemberView< Stringm_vsIndex
 The index description.
bool m_fOrdered
 Indicates whether or not the associated index is ordered.
int64_t m_cBytes
 The index footprint in bytes.
int32_t m_cDistinctValues
 The index content map size.
MemberView< Stringm_vsIndexDef
 The index type description.

Constructor & Destructor Documentation

IndexLookupRecord ( QueryRecord::PartialResult::IndexLookupRecord::View  vThat  )  [protected]

Copy constructor for an IndexLookupRecord.

Parameters:
vThat the IndexLookupRecord to copy

IndexLookupRecord ( String::View  vsExtractor,
String::View  vsIndex,
bool  fOrdered,
int64_t  cBytes,
int32_t  cDistinctValues,
String::View  vsIndexDef 
) [protected]

Construct an IndexLookupRecord.

Parameters:
vsExtractor the extractor description
vsIndex the index description
fOrdered indicates whether or not the associated index is ordered


Member Function Documentation

int64_t getMemoryUsage (  )  const

Returns index memory usage in bytes.

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

int32_t getSize (  )  const

Return index content map size.

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

virtual String::View getIndexDef (  )  const [virtual]

Returns the index definition.

Returns:
the index definition; null if there is no index

virtual String::View buildIndexDescription (  )  [protected, virtual]

Build an index description for this index.

Returns:
an index description for this index if there is an index definition; null otherwise

virtual void parseIndexDescription ( String::View  vsIndex  )  [protected, virtual]

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

Parameters:
vsIndex the index description


The documentation for this class was generated from the following file:
Copyright © 2000, 2019, Oracle and/or its affiliates. All rights reserved.