#include <coherence/util/CompositeKey.hpp>
Inherits Object, KeyAssociation, and PortableObject.
Two instances of CompositeKey are considered to be equal iff both the primary and secondary components of the two instances are considered equal. Additionally, the hash code of a CompositeKey takes into the consideration the hash codes of its two components. Finally, the CompositeKey class implements KeyAssociation by returning the primary component.
Public Types | ||||
typedef spec::Handle | Handle | |||
CompositeKey Handle definition. | ||||
typedef spec::View | View | |||
CompositeKey View definition. | ||||
typedef spec::Holder | Holder | |||
CompositeKey Holder definition. | ||||
Public Member Functions | ||||
virtual Object::View | getAssociatedKey () const | |||
Determine the key object to which this key object is associated. The key object returned by this method is often referred to as a host key.
| ||||
virtual void | readExternal (PofReader::Handle hIn) | |||
virtual void | writeExternal (PofWriter::Handle hOut) 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
The default implementation is identity based.
| ||||
virtual bool | equals (Object::View v) const | |||
virtual void | toStream (std::ostream &out) const | |||
Output a human-readable description of this Object to the given stream. coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.
Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);
| ||||
virtual Object::View | getPrimaryKey () const | |||
Return the primary key component. | ||||
virtual Object::View | getSecondaryKey () const | |||
Return the secondary key component. | ||||
Protected Member Functions | ||||
CompositeKey () | ||||
Default constructor. | ||||
CompositeKey (Object::View voPrimary, Object::View voSecondary) | ||||
Create a new CompositeKey that consists of the given primary and secondary components. |
CompositeKey | ( | Object::View | voPrimary, | |
Object::View | voSecondary | |||
) | [protected] |
Create a new CompositeKey that consists of the given primary and secondary components.
voPrimary | the primary key component; must not be null. This is also the host key returned by the KeyAssociation implementation | |
voSecondary | the secondary key component; must not be null |
virtual Object::View getPrimaryKey | ( | ) | const [virtual] |
Return the primary key component.
virtual Object::View getSecondaryKey | ( | ) | const [virtual] |
Return the secondary key component.