VMware GemFire Native Client C++ API Reference

VMware VMware GemFire Native C++ Reference: PdxInstance.hpp Source File
VMware VMware GemFire Native C++ Reference 10.4.3
Loading...
Searching...
No Matches
PdxInstance.hpp
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
20#ifndef GEODE_PDXINSTANCE_H_
21#define GEODE_PDXINSTANCE_H_
22
23#include "CacheableBuiltins.hpp"
24#include "PdxFieldTypes.hpp"
25#include "PdxSerializable.hpp"
26
27namespace apache {
28namespace geode {
29namespace client {
30class WritablePdxInstance;
31class CacheableDate;
32class CacheableObjectArray;
51class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
52 public:
56 ~PdxInstance() noexcept override = default;
57
66 virtual std::shared_ptr<PdxSerializable> getObject() = 0;
67
76 virtual bool hasField(const std::string& fieldname) = 0;
77
90 virtual std::shared_ptr<Cacheable> getCacheableField(
91 const std::string& fieldname) const = 0;
92
101 virtual bool getBooleanField(const std::string& fieldname) const = 0;
102
111 virtual int8_t getByteField(const std::string& fieldname) const = 0;
112
121 virtual int16_t getShortField(const std::string& fieldname) const = 0;
122
129 virtual int32_t getIntField(const std::string& fieldname) const = 0;
130
139 virtual int64_t getLongField(const std::string& fieldname) const = 0;
140
149 virtual float getFloatField(const std::string& fieldname) const = 0;
150
159 virtual double getDoubleField(const std::string& fieldname) const = 0;
160
168 virtual char16_t getCharField(const std::string& fieldName) const = 0;
169
179 virtual std::string getStringField(const std::string& fieldname) const = 0;
180
189 virtual std::vector<bool> getBooleanArrayField(
190 const std::string& fieldname) const = 0;
191
200 virtual std::vector<int8_t> getByteArrayField(
201 const std::string& fieldname) const = 0;
202
211 virtual std::vector<int16_t> getShortArrayField(
212 const std::string& fieldname) const = 0;
213
222 virtual std::vector<int32_t> getIntArrayField(
223 const std::string& fieldname) const = 0;
224
233 virtual std::vector<int64_t> getLongArrayField(
234 const std::string& fieldname) const = 0;
235
244 virtual std::vector<float> getFloatArrayField(
245 const std::string& fieldname) const = 0;
246
255 virtual std::vector<double> getDoubleArrayField(
256 const std::string& fieldname) const = 0;
257
258 // charArray
267 virtual std::vector<char16_t> getCharArrayField(
268 const std::string& fieldName) const = 0;
269
278 virtual std::vector<std::string> getStringArrayField(
279 const std::string& fieldname) const = 0;
280
291 virtual std::shared_ptr<CacheableDate> getCacheableDateField(
292 const std::string& fieldname) const = 0;
293
306 virtual void getField(const std::string& fieldName, int8_t*** value,
307 int32_t& arrayLength,
308 int32_t*& elementLength) const = 0;
309
323 virtual std::shared_ptr<CacheableObjectArray> getCacheableObjectArrayField(
324 const std::string& fieldname) const = 0;
325
337 virtual bool isIdentityField(const std::string& fieldname) = 0;
338
346 virtual std::shared_ptr<WritablePdxInstance> createWriter() = 0;
347
366 virtual int32_t hashcode() const override = 0;
367
379 virtual std::string toString() const override = 0;
380
423 virtual bool operator==(const CacheableKey& other) const override = 0;
424
429 virtual size_t objectSize() const override = 0;
430
435 virtual std::shared_ptr<CacheableStringArray> getFieldNames() = 0;
436
437 // From PdxSerializable
443 virtual void toData(PdxWriter& output) const override = 0;
444
449 virtual void fromData(PdxReader& input) override = 0;
450
458 virtual const std::string& getClassName() const override = 0;
459
468 virtual PdxFieldTypes getFieldType(const std::string& fieldname) const = 0;
469
470 PdxInstance(const PdxInstance& other) = delete;
471 void operator=(const PdxInstance& other) = delete;
472
473 protected:
477 PdxInstance() {}
478};
479
480} // namespace client
481} // namespace geode
482} // namespace apache
483
484#endif // GEODE_PDXINSTANCE_H_
CacheableBuiltins.hpp
Contains generic template definitions for Cacheable types and instantiations for built-in types.
apache::geode::client::CacheableStringArray
internal::CacheableArrayPrimitive< std::shared_ptr< CacheableString >, internal::DSCode::CacheableStringArray > CacheableStringArray
An immutable wrapper for array of strings that can serve as a distributable object for caching.
apache::geode::client::CacheableDate
Implement a date object based on epoch of January 1, 1970 00:00:00 GMT that can serve as a distributa...
Definition CacheableDate.hpp:45
apache::geode::client::CacheableKey
Represents a cacheable key.
Definition CacheableKey.hpp:40
apache::geode::client::CacheableObjectArray
Implements an immutable Vector of Cacheable objects that can serve as a distributable object for cach...
Definition CacheableObjectArray.hpp:49
apache::geode::client::PdxInstance
PdxInstance provides run time access to the fields of a PDX without deserializing the PDX.
Definition PdxInstance.hpp:51
apache::geode::client::PdxInstance::~PdxInstance
~PdxInstance() noexcept override=default
destructor
apache::geode::client::PdxReader
A PdxReader will be passed to PdxSerializable.fromData or during deserialization of a PDX.
Definition PdxReader.hpp:58
apache::geode::client::PdxSerializable
An interface for objects whose contents can be serialized as PDX types.
Definition PdxSerializable.hpp:41
apache::geode::client::PdxWriter
A PdxWriter will be passed to PdxSerializable.toData when it is serializing the domain class.
Definition PdxWriter.hpp:41
apache::geode::client::Serializable
This base class is the superclass of all user objects in the cache that can be serialized.
Definition Serializable.hpp:53
apache::geode::client::WritablePdxInstance
WritablePdxInstance is a PdxInstance that also supports field modification using the setField method.
Definition WritablePdxInstance.hpp:40
Apache Geode C++ Cache API Documentation