PdxInstance.hpp

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#ifndef GEODE_PDXINSTANCE_H_
#define GEODE_PDXINSTANCE_H_
 
#include "CacheableBuiltins.hpp"
#include "PdxFieldTypes.hpp"
#include "PdxSerializable.hpp"
 
namespace apache {
namespace geode {
namespace client {
class WritablePdxInstance;
class CacheableDate;
class CacheableObjectArray;
class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
 public:
  ~PdxInstance() override = default;
 
  virtual std::shared_ptr<PdxSerializable> getObject() = 0;
 
  virtual bool hasField(const std::string& fieldname) = 0;
 
  virtual std::shared_ptr<Cacheable> getCacheableField(
      const std::string& fieldname) const = 0;
 
  virtual bool getBooleanField(const std::string& fieldname) const = 0;
 
  virtual int8_t getByteField(const std::string& fieldname) const = 0;
 
  virtual int16_t getShortField(const std::string& fieldname) const = 0;
 
  virtual int32_t getIntField(const std::string& fieldname) const = 0;
 
  virtual int64_t getLongField(const std::string& fieldname) const = 0;
 
  virtual float getFloatField(const std::string& fieldname) const = 0;
 
  virtual double getDoubleField(const std::string& fieldname) const = 0;
 
  virtual char16_t getCharField(const std::string& fieldName) const = 0;
 
  virtual std::string getStringField(const std::string& fieldname) const = 0;
 
  virtual std::vector<bool> getBooleanArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::vector<int8_t> getByteArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::vector<int16_t> getShortArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::vector<int32_t> getIntArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::vector<int64_t> getLongArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::vector<float> getFloatArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::vector<double> getDoubleArrayField(
      const std::string& fieldname) const = 0;
 
  // charArray
  virtual std::vector<char16_t> getCharArrayField(
      const std::string& fieldName) const = 0;
 
  virtual std::vector<std::string> getStringArrayField(
      const std::string& fieldname) const = 0;
 
  virtual std::shared_ptr<CacheableDate> getCacheableDateField(
      const std::string& fieldname) const = 0;
 
  virtual void getField(const std::string& fieldName, int8_t*** value,
                        int32_t& arrayLength,
                        int32_t*& elementLength) const = 0;
 
  virtual std::shared_ptr<CacheableObjectArray> getCacheableObjectArrayField(
      const std::string& fieldname) const = 0;
 
  virtual bool isIdentityField(const std::string& fieldname) = 0;
 
  virtual std::shared_ptr<WritablePdxInstance> createWriter() = 0;
 
  virtual int32_t hashcode() const override = 0;
 
  virtual std::string toString() const override = 0;
 
  virtual bool operator==(const CacheableKey& other) const override = 0;
 
  virtual size_t objectSize() const override = 0;
 
  virtual std::shared_ptr<CacheableStringArray> getFieldNames() = 0;
 
  // From PdxSerializable
  virtual void toData(PdxWriter& output) const override = 0;
 
  virtual void fromData(PdxReader& input) override = 0;
 
  virtual const std::string& getClassName() const override = 0;
 
  virtual PdxFieldTypes getFieldType(const std::string& fieldname) const = 0;
 
  PdxInstance(const PdxInstance& other) = delete;
  void operator=(const PdxInstance& other) = delete;
 
 protected:
  PdxInstance() {}
};
 
}  // namespace client
}  // namespace geode
}  // namespace apache
 
#endif  // GEODE_PDXINSTANCE_H_