MySQL NDB Cluster API Developer Guide
This section provides information about the
HashMap
class, which models a hash map in an NDB
Cluster.
None.
The following table lists the public methods of the
HashMap
class and the purpose or use of
each method:
Table 2.21 HashMap class methods and descriptions
Name | Description |
---|---|
HashMap() |
Class constructor |
~HashMap() |
Class destructor |
setName() |
Set a name for the hashmap |
getName() |
Gets a hashmap's name |
setMap() |
Sets a hashmap's length and values |
getMapLen() |
Gets a hashmap's length |
getMapValues() |
Gets the values contained in the hashmap |
equal() |
Compares this hashmap's values with those of another hashmap |
getObjectStatus() |
Gets the hashmap's object status |
getObjectVersion() |
Gets the hashmap's schema object version |
getObjectId() |
Gets the hashmap's ID |
The HashMap
class defines no public
types.
The HashMap
class
constructor normally requires no arguments. A copy
constructor is also available.
See also Dictionary::createHashMap(), for more information.
Base constructor:
HashMap HashMap ( void )
Copy constructor:
HashMap HashMap
(
const HashMap& hashmap
)
Destructor:
virtual ~HashMap ( void )
None, or the address of an existing
HashMap
object to be copied.
A new instance of HashMap
, possibly a
copy of an existing one.
Sets the name of the hash map.
void setName
(
const char* name
)
The name to be assigned to the hashmap.
None.
Gets the name of the hash map.
const char* getName ( void ) const
None.
The name of the hash map.
Assigns a set of values to a has map.
void setMap ( const Uint32*values
, Uint32len
)
A pointer to a set of values
of
length len
.
None.
Gets the hash map's length; that is, the number of
values which it contains. You can obtain the values using
getMapValues()
.
Uint32 getMapLen ( void ) const
None.
The length of the hash map.
Gets the values listed in the hash map.
int getMapValues ( Uint32*dst
, Uint32len
) const
A pointer to a set of values
(dst
) and the number of values
(len
).
Returns 0 on success; on failure, returns -1 and sets error.
Compares (only) the values of this
HashMap
with those of
another one.
bool equal
(
const HashMap& hashmap
) const
A reference to the hash map to be compared with this one.
None.
This method retrieves the status of the
HashMap
for which it is
invoked. The return value is of type
Object::Status
.
virtual Status getObjectStatus ( void ) const
None.