Pivotal GemFire Native C++ Reference  10.1.3
apache::geode::client::PdxInstance Class Referenceabstract

PdxInstance provides run time access to the fields of a PDX without deserializing the PDX. More...

Inherits apache::geode::client::PdxSerializable.

Inherited by apache::geode::client::WritablePdxInstance.

Public Member Functions

virtual std::shared_ptr< WritablePdxInstancecreateWriter ()=0
 Creates and returns a WritablePdxInstance whose initial values are those of this PdxInstance. More...
 
virtual void fromData (PdxReader &input) override=0
 Deserialize this object. More...
 
virtual std::vector< bool > getBooleanArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in bool array type out param. More...
 
virtual bool getBooleanField (const std::string &fieldname) const =0
 Reads the named field and sets its value in bool type out param. More...
 
virtual std::vector< int8_t > getByteArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in signed char array type out param. More...
 
virtual int8_t getByteField (const std::string &fieldname) const =0
 Reads the named field and sets its value in signed char type out param. More...
 
virtual std::shared_ptr< CacheableDategetCacheableDateField (const std::string &fieldname) const =0
 Reads the named field and sets its value in std::shared_ptr<CacheableDate> type out param. More...
 
virtual std::shared_ptr< CacheablegetCacheableField (const std::string &fieldname) const =0
 Reads the named field and sets its value in std::shared_ptr<Cacheable> type out param. More...
 
virtual std::shared_ptr< CacheableObjectArraygetCacheableObjectArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in std::shared_ptr<CacheableObjectArray> type out param. More...
 
virtual std::vector< char16_t > getCharArrayField (const std::string &fieldName) const =0
 Reads the named field and sets its value in char array type out param. More...
 
virtual char16_t getCharField (const std::string &fieldName) const =0
 Reads the named field and sets its value in char type out param. More...
 
virtual const std::string & getClassName () const override=0
 Return the full name of the class that this pdx instance represents. More...
 
virtual std::vector< double > getDoubleArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in double array type out param. More...
 
virtual double getDoubleField (const std::string &fieldname) const =0
 Reads the named field and sets its value in double type out param. More...
 
virtual void getField (const std::string &fieldName, int8_t ***value, int32_t &arrayLength, int32_t *&elementLength) const =0
 Reads the named field and sets its value in array of byte arrays type out param. More...
 
virtual std::shared_ptr< CacheableStringArraygetFieldNames ()=0
 Return an unmodifiable list of the field names on this PdxInstance. More...
 
virtual PdxFieldTypes getFieldType (const std::string &fieldname) const =0
 Return the type. More...
 
virtual std::vector< float > getFloatArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in float array type out param. More...
 
virtual float getFloatField (const std::string &fieldname) const =0
 Reads the named field and sets its value in float type out param. More...
 
virtual std::vector< int32_t > getIntArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in int32_t array type out param. More...
 
virtual int32_t getIntField (const std::string &fieldname) const =0
 Reads the named field and sets its value in int32_t type out param. More...
 
virtual std::vector< int64_t > getLongArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in int64_t array type out param. More...
 
virtual int64_t getLongField (const std::string &fieldname) const =0
 Reads the named field and sets its value in int64_t type out param. More...
 
virtual std::shared_ptr< PdxSerializablegetObject ()=0
 Deserializes and returns the domain object that this instance represents. More...
 
virtual std::vector< int16_t > getShortArrayField (const std::string &fieldname) const =0
 Reads the named field and sets its value in int16_t array type out param. More...
 
virtual int16_t getShortField (const std::string &fieldname) const =0
 Reads the named field and sets its value in int16_t type out param. More...
 
virtual std::vector< std::string > getStringArrayField (const std::string &fieldname) const =0
 Reads the named field as a string array. More...
 
virtual std::string getStringField (const std::string &fieldname) const =0
 Reads the named field and sets its value in std::string type out param. More...
 
virtual bool hasField (const std::string &fieldname)=0
 Checks if the named field exists and returns the result. More...
 
virtual int32_t hashcode () const override=0
 Generates a hashcode based on the identity fields of this PdxInstance. More...
 
virtual bool isIdentityField (const std::string &fieldname)=0
 Checks if the named field was PdxWriter#markIdentityFieldmarked as an identity field. More...
 
virtual size_t objectSize () const override=0
 
virtual bool operator== (const CacheableKey &other) const override=0
 Returns true if the given CacheableKey derived object is equals to this instance. More...
 
virtual void toData (PdxWriter &output) const override=0
 serialize this object in geode PDX format. More...
 
virtual std::string toString () const override=0
 Prints out all of the identity fields of this PdxInstance. More...
 
 ~PdxInstance () override=default
 destructor More...
 

Static Public Member Functions

template<class _T >
static std::shared_ptr< CacheableKeycreate (_T value)
 Factory method that creates the key type that matches the type of value. More...
 
template<class _T >
static std::shared_ptr< Serializablecreate (_T value)
 Factory method that creates the Serializable object that matches the type of value. More...
 

Protected Member Functions

 PdxInstance ()
 constructors More...
 

Detailed Description

PdxInstance provides run time access to the fields of a PDX without deserializing the PDX.

Preventing deserialization saves time and memory. The PdxInstance implementation is a lightweight wrapper that simply refers to the raw bytes of the PDX that are kept in the cache. Applications can choose to access PdxInstances instead of C++ objects by configuring the Cache to prefer PDX instances during deserialization. This can be done in cache.xml by setting the attribute read-serialized to true on the pdx element, or it can be done programmatically using the setPdxReadSerialized method. Once this preference is configured, then any time deserialization of a PDX is done it will deserialize into a PdxInstance. PdxInstances are immutable. If you want to change one call createWriter.

Constructor & Destructor Documentation

◆ ~PdxInstance()

apache::geode::client::PdxInstance::~PdxInstance ( )
overridedefault

destructor

◆ PdxInstance()

apache::geode::client::PdxInstance::PdxInstance ( )
inlineprotected

constructors

Member Function Documentation

◆ create() [1/2]

template<class _T >
static std::shared_ptr<CacheableKey> apache::geode::client::CacheableKey::create ( _T  value)
staticinherited

Factory method that creates the key type that matches the type of value.

For user defined derivations of CacheableKey, the method apache::geode::client::CacheableKey::create may be overloaded.

◆ create() [2/2]

template<class _T >
static std::shared_ptr<Serializable> apache::geode::client::Serializable::create ( _T  value)
staticinherited

Factory method that creates the Serializable object that matches the type of value.

For user defined derivations of Serializable, the method apache::geode::client::Serializable::create may be overloaded.

◆ createWriter()

virtual std::shared_ptr<WritablePdxInstance> apache::geode::client::PdxInstance::createWriter ( )
pure virtual

Creates and returns a WritablePdxInstance whose initial values are those of this PdxInstance.

This call returns a copy of the current field values so modifications made to the returned value will not modify this PdxInstance.

Returns
a WritablePdxInstance

◆ fromData()

virtual void apache::geode::client::PdxInstance::fromData ( PdxReader input)
overridepure virtual

Deserialize this object.

This is an internal method.

Parameters
PdxReaderto deserialize the PDX object

Implements apache::geode::client::PdxSerializable.

◆ getBooleanArrayField()

virtual std::vector<bool> apache::geode::client::PdxInstance::getBooleanArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in bool array type out param.

bool* type corresponds to the Java boolean[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with bool array type.
lengthlength is set with number of bool elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getBooleanField()

virtual bool apache::geode::client::PdxInstance::getBooleanField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in bool type out param.

bool type corresponds to the Java boolean type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with bool type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getByteArrayField()

virtual std::vector<int8_t> apache::geode::client::PdxInstance::getByteArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in signed char array type out param.

int8_t* type corresponds to the Java byte[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int8_t array type.
lengthlength is set with number of int8_t elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getByteField()

virtual int8_t apache::geode::client::PdxInstance::getByteField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in signed char type out param.

signed char type corresponds to the Java byte type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with signed char type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getCacheableDateField()

virtual std::shared_ptr<CacheableDate> apache::geode::client::PdxInstance::getCacheableDateField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in std::shared_ptr<CacheableDate> type out param.

std::shared_ptr<CacheableDate> type is corresponding to java Java.util.date type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with std::shared_ptr<CacheableDate> type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getCacheableField()

virtual std::shared_ptr<Cacheable> apache::geode::client::PdxInstance::getCacheableField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in std::shared_ptr<Cacheable> type out param.

std::shared_ptr<Cacheable> type corresponds to the Java object type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with std::shared_ptr<Cacheable> type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field. For deserialization C++ Native Client requires the domain class to be registered.
See also
serializationRegistry->addPdxType
PdxInstance::hasField

◆ getCacheableObjectArrayField()

virtual std::shared_ptr<CacheableObjectArray> apache::geode::client::PdxInstance::getCacheableObjectArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in std::shared_ptr<CacheableObjectArray> type out param.

For deserialization C++ Native Client requires the domain class to be registered. std::shared_ptr<CacheableObjectArray> type corresponds to the Java Object[] type.

Parameters
fieldnamename of the field to read.
valuevalue of the field to be set with std::shared_ptr<CacheableObjectArray> type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
serializationRegistry->addPdxType
PdxInstance::hasField

◆ getCharArrayField()

virtual std::vector<char16_t> apache::geode::client::PdxInstance::getCharArrayField ( const std::string &  fieldName) const
pure virtual

Reads the named field and sets its value in char array type out param.

char16_t* type corresponds to the Java char[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with char array type.
lengthlength is set with number of char16_t* elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getCharField()

virtual char16_t apache::geode::client::PdxInstance::getCharField ( const std::string &  fieldName) const
pure virtual

Reads the named field and sets its value in char type out param.

char type corresponds to the Java char type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with char type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getClassName()

virtual const std::string& apache::geode::client::PdxInstance::getClassName ( ) const
overridepure virtual

Return the full name of the class that this pdx instance represents.

Returns
the name of the class that this pdx instance represents.
Exceptions
IllegalStateExceptionif the PdxInstance typeid is not defined yet, to get classname or if PdxType is not defined for PdxInstance.

Implements apache::geode::client::PdxSerializable.

◆ getDoubleArrayField()

virtual std::vector<double> apache::geode::client::PdxInstance::getDoubleArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in double array type out param.

double* type corresponds to the Java double[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with double array type.
lengthlength is set with number of double elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getDoubleField()

virtual double apache::geode::client::PdxInstance::getDoubleField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in double type out param.

double type corresponds to the Java double type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with double type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getField()

virtual void apache::geode::client::PdxInstance::getField ( const std::string &  fieldName,
int8_t ***  value,
int32_t &  arrayLength,
int32_t *&  elementLength 
) const
pure virtual

Reads the named field and sets its value in array of byte arrays type out param.

int8_t** type corresponds to the Java byte[][] type.

Parameters
fieldnamename of the field to read.
valuevalue of the field to be set with array of byte arrays type.
arrayLengtharrayLength is set to the number of byte arrays.
elementLengthelementLength is set to individual byte array lengths.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getFieldNames()

virtual std::shared_ptr<CacheableStringArray> apache::geode::client::PdxInstance::getFieldNames ( )
pure virtual

Return an unmodifiable list of the field names on this PdxInstance.

Returns
an unmodifiable list of the field names on this PdxInstance

◆ getFieldType()

virtual PdxFieldTypes apache::geode::client::PdxInstance::getFieldType ( const std::string &  fieldname) const
pure virtual

Return the type.

See also
PdxInstance::PdxFieldTypes of the field in the pdx instance.
Returns
the type
See also
PdxInstance::PdxFieldTypes of the field in the pdx instance.
Exceptions
IllegalStateExceptionif the PdxInstance typeid is not defined yet, to get classname or if PdxType is not defined for PdxInstance.

◆ getFloatArrayField()

virtual std::vector<float> apache::geode::client::PdxInstance::getFloatArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in float array type out param.

float* type corresponds to the Java float[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with float array type.
lengthlength is set with number of float elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getFloatField()

virtual float apache::geode::client::PdxInstance::getFloatField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in float type out param.

float type corresponds to the Java float type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with float type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getIntArrayField()

virtual std::vector<int32_t> apache::geode::client::PdxInstance::getIntArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in int32_t array type out param.

int32_t* type corresponds to the Java int[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int32_t array type.
lengthlength is set with number of int32_t elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getIntField()

virtual int32_t apache::geode::client::PdxInstance::getIntField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in int32_t type out param.

int32_t type corresponds to the Java int type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int32_t type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.

◆ getLongArrayField()

virtual std::vector<int64_t> apache::geode::client::PdxInstance::getLongArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in int64_t array type out param.

int64_t* type corresponds to the Java long[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int64_t array type.
lengthlength is set with number of int64_t elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getLongField()

virtual int64_t apache::geode::client::PdxInstance::getLongField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in int64_t type out param.

int64_t type corresponds to the Java long type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int64_t type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getObject()

virtual std::shared_ptr<PdxSerializable> apache::geode::client::PdxInstance::getObject ( )
pure virtual

Deserializes and returns the domain object that this instance represents.

For deserialization C++ Native Client requires the domain class to be registered.

Returns
the deserialized domain object.
See also
serializationRegistry->addPdxType

◆ getShortArrayField()

virtual std::vector<int16_t> apache::geode::client::PdxInstance::getShortArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in int16_t array type out param.

int16_t* type corresponds to the Java short[] type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int16_t array type.
lengthlength is set with number of int16_t elements.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getShortField()

virtual int16_t apache::geode::client::PdxInstance::getShortField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in int16_t type out param.

int16_t type corresponds to the Java short type.

Parameters
fieldnamename of the field to read
valuevalue of the field to be set with int16_t type.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getStringArrayField()

virtual std::vector<std::string> apache::geode::client::PdxInstance::getStringArrayField ( const std::string &  fieldname) const
pure virtual

Reads the named field as a string array.

std::vector<std::string> type corresponds to the Java String[] type.

Parameters
fieldnamename of the field to read
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ getStringField()

virtual std::string apache::geode::client::PdxInstance::getStringField ( const std::string &  fieldname) const
pure virtual

Reads the named field and sets its value in std::string type out param.

std::string type corresponds to the Java String type.

Parameters
fieldnamename of the field to read
Returns
string value for field.
Exceptions
IllegalStateExceptionif PdxInstance doesn't have the named field.
See also
PdxInstance::hasField

◆ hasField()

virtual bool apache::geode::client::PdxInstance::hasField ( const std::string &  fieldname)
pure virtual

Checks if the named field exists and returns the result.

This can be useful when writing code that handles more than one version of a PDX class.

Parameters
fieldnamethe name of the field to check
Returns
true if the named field exists; otherwise false

◆ hashcode()

virtual int32_t apache::geode::client::PdxInstance::hashcode ( ) const
overridepure virtual

Generates a hashcode based on the identity fields of this PdxInstance.

If a PdxInstance has marked identity fields using {} then only the marked identity fields are its identity fields. Otherwise all its fields are identity fields. For deserialization C++ Native Client requires the domain class to be registered. If the field is an array then all array elements are used for hashcode computation. Otherwise the raw bytes of its value are used to compute the hash code.

Exceptions
IllegalStateExceptionif the field contains an element that is not of CacheableKey derived type.
See also
serializationRegistry->addPdxType

Implements apache::geode::client::CacheableKey.

◆ isIdentityField()

virtual bool apache::geode::client::PdxInstance::isIdentityField ( const std::string &  fieldname)
pure virtual

Checks if the named field was PdxWriter#markIdentityFieldmarked as an identity field.

Note that if no fields have been marked then all the fields are used as identity fields even though this method will return false since none of them have been marked.

Parameters
fieldnamethe name of the field to check
Returns
true if the named field exists and was marked as an identify field; otherwise false

◆ objectSize()

virtual size_t apache::geode::client::PdxInstance::objectSize ( ) const
overridepure virtual
Returns
the size of the object in bytes This is an internal method. It is used in case of heap LRU property is set.

Reimplemented from apache::geode::client::Serializable.

◆ operator==()

virtual bool apache::geode::client::PdxInstance::operator== ( const CacheableKey other) const
overridepure virtual

Returns true if the given CacheableKey derived object is equals to this instance.

If other is not a PdxInstance then it is not equal to this instance. NOTE: Even if other is the result of calling {} it will not be equal to this instance.

Otherwise equality of two PdxInstances is determined as follows:

  1. The domain class name must be equal for both PdxInstances
  2. Each identity field must be equal.

If one of the instances does not have a field that the other one does then equals will assume it has the field with a default value. If a PdxInstance has marked identity fields using {markIdentityField} then only the marked identity fields are its identity fields. Otherwise all its fields are identity fields. An identity field is equal if all the following are true:

  1. The field name is equal.
  2. The field type is equal.
  3. The field value is equal.

If an identity field is of type derived from Cacheable then it is deserialized. For deserialization C++ Native Client requires the domain class to be registered. If the deserialized object is an array then all array elements are used to determine equality. If an identity field is of type CacheableObjectArray then it is deserialized and all array elements are used to determine equality. For all other field types the value does not need to be deserialized. Instead the serialized raw bytes are compared and used to determine equality.

Parameters
otherthe other instance to compare to this.
Returns
true if this instance is equal to other.
Exceptions
IllegalStateExceptionif the field contains an element that is not of CacheableKey derived type.
See also
serializationRegistry->addPdxType

Implements apache::geode::client::CacheableKey.

◆ toData()

virtual void apache::geode::client::PdxInstance::toData ( PdxWriter output) const
overridepure virtual

serialize this object in geode PDX format.

This is an internal method.

Parameters
PdxWriterto serialize the PDX object

Implements apache::geode::client::PdxSerializable.

◆ toString()

virtual std::string apache::geode::client::PdxInstance::toString ( ) const
overridepure virtual

Prints out all of the identity fields of this PdxInstance.

If a PdxInstance has marked identity fields using {} then only the marked identity fields are its identity fields. Otherwise all its fields are identity fields. For deserialization C++ Native Client requires the domain class to be registered.

See also
serializationRegistry->addPdxType

Reimplemented from apache::geode::client::Serializable.


Apache Geode C++ Cache API Documentation