PdxInstance.hpp

#ifndef __GEMFIRE_PDXINSTANCE_HPP_
#define __GEMFIRE_PDXINSTANCE_HPP_

/*=========================================================================
* Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
*========================================================================
*/

#include "PdxSerializable.hpp"
#include "CacheableBuiltins.hpp"
#include "PdxFieldTypes.hpp"

namespace gemfire {

  class CPPCACHE_EXPORT PdxInstance : public PdxSerializable
  {

  public:    
    virtual ~PdxInstance(){      
    }

    virtual PdxSerializablePtr getObject() = 0;

    virtual bool hasField(const char *fieldname) = 0;

    virtual void getField(const char *fieldname, CacheablePtr& value) const = 0;

    virtual void getField(const char *fieldname, bool& value)const = 0;

    virtual void getField(const char *fieldname, signed char& value)const = 0;

    virtual void getField(const char *fieldname, unsigned char& value)const = 0;

    virtual void getField (const char *fieldname, int16_t& value)const = 0;

    virtual void getField (const char *fieldname, int32_t& value)const = 0;

    virtual void getField (const char *fieldname, int64_t& value)const = 0;

    virtual void getField (const char *fieldname, float& value)const = 0;

    virtual void getField (const char *fieldname, double& value)const = 0;

    virtual void getField (const char* fieldName, wchar_t& value)const = 0; 

    virtual void getField (const char* fieldName, char& value)const = 0; 

    virtual void getField (const char *fieldname, bool** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, signed char** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, unsigned char** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, int16_t** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, int32_t** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, int64_t** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, float** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, double** value, int32_t& length)const = 0;

    //charArray
    virtual void getField(const char* fieldName, wchar_t** value, int32_t& length)const = 0;

    virtual void getField(const char* fieldName, char** value, int32_t& length)const = 0;

    //String
    virtual void getField (const char *fieldname, wchar_t** value)const = 0;

    virtual void getField (const char *fieldname, char** value)const = 0;

    //StringArray
    virtual void getField (const char *fieldname, wchar_t*** value, int32_t& length)const = 0;

    virtual void getField (const char *fieldname, char*** value, int32_t& length)const = 0;

    virtual void getField(const char *fieldname, CacheableDatePtr& value)const = 0;

    virtual void getField(const char* fieldName, int8_t*** value, int32_t& arrayLength, int32_t*& elementLength)const = 0;

    virtual void getField(const char *fieldname, CacheableObjectArrayPtr& value)const = 0;

    virtual bool isIdentityField(const char * fieldname) = 0;

    virtual WritablePdxInstancePtr createWriter() = 0;

    virtual uint32_t hashcode( ) const = 0;


    virtual CacheableStringPtr toString() const = 0;

    virtual void toData( DataOutput& output ) const {
      PdxSerializable::toData(output);
    }

    virtual Serializable* fromData( DataInput& input ) {
      return PdxSerializable::fromData(input);
    }

    virtual bool operator==(const CacheableKey& other) const = 0;

    virtual uint32_t objectSize() const = 0;

    virtual CacheableStringArrayPtr getFieldNames() = 0; 

    //From PdxSerializable
    virtual void toData( PdxWriterPtr output ) = 0;

    virtual void fromData( PdxReaderPtr input ) = 0;

    virtual const char* getClassName()const = 0;    

    virtual PdxFieldTypes::PdxFieldType getFieldType(const char *fieldname) const = 0;

  protected:
    PdxInstance(){
    }

  private:
    // never implemented.
    PdxInstance(const PdxInstance& other);
    void operator =(const PdxInstance& other);
  };

}
#endif /* __GEMFIRE_PDXINSTANCE_HPP_ */