/* Copyright 2015 Realm Inc - All Rights Reserved * Proprietary and Confidential */ #ifndef REALM_OBJECT_ACCESSOR_HPP #define REALM_OBJECT_ACCESSOR_HPP #include #include "shared_realm.hpp" #include "schema.hpp" #include "list.hpp" namespace realm { class Object { public: Object(SharedRealm r, const ObjectSchema &s, Row o) : m_realm(r), object_schema(s), m_row(o) {} // property getter/setter template inline void set_property_value(ContextType ctx, std::string prop_name, ValueType value, bool try_update); template inline ValueType get_property_value(ContextType ctx, std::string prop_name); // create an Object from a native representation template static inline Object create(ContextType ctx, SharedRealm realm, const ObjectSchema &object_schema, ValueType value, bool try_update); const ObjectSchema &object_schema; SharedRealm realm() { return m_realm; } Row row() { return m_row; } private: SharedRealm m_realm; Row m_row; template inline void set_property_value_impl(ContextType ctx, const Property &property, ValueType value, bool try_update); template inline ValueType get_property_value_impl(ContextType ctx, const Property &property); }; // // Value converters - template specializations must be implemented for each platform in order to call templated methods on Object // template class NativeAccessor { public: static bool dict_has_value_for_key(ContextType ctx, ValueType dict, const std::string &prop_name); static ValueType dict_value_for_key(ContextType ctx, ValueType dict, const std::string &prop_name); static bool has_default_value_for_property(ContextType ctx, Realm *realm, const ObjectSchema &object_schema, const std::string &prop_name); static ValueType default_value_for_property(ContextType ctx, Realm *realm, const ObjectSchema &object_schema, const std::string &prop_name); static bool to_bool(ContextType, ValueType &); static ValueType from_bool(ContextType, bool); static long long to_long(ContextType, ValueType &); static ValueType from_long(ContextType, long long); static float to_float(ContextType, ValueType &); static ValueType from_float(ContextType, float); static double to_double(ContextType, ValueType &); static ValueType from_double(ContextType, double); static std::string to_string(ContextType, ValueType &); static ValueType from_string(ContextType, StringData); static std::string to_binary(ContextType, ValueType &); static ValueType from_binary(ContextType, BinaryData); static DateTime to_datetime(ContextType, ValueType &); static ValueType from_datetime(ContextType, DateTime); static bool is_null(ContextType, ValueType &); static ValueType null_value(ContextType); // convert value to persisted object // for existing objects return the existing row index // for new/updated objects return the row index static size_t to_object_index(ContextType ctx, SharedRealm realm, ValueType &val, const std::string &type, bool try_update); static ValueType from_object(ContextType ctx, Object); // object index for an existing object static size_t to_existing_object_index(ContextType ctx, ValueType &val); // list value acessors static size_t list_size(ContextType ctx, ValueType &val); static ValueType list_value_at_index(ContextType ctx, ValueType &val, size_t index); static ValueType from_list(ContextType ctx, List); // // Deprecated // static Mixed to_mixed(ContextType ctx, ValueType &val) { throw std::runtime_error("'Any' type is unsupported"); } }; class InvalidPropertyException : public std::runtime_error { public: InvalidPropertyException(const std::string object_type, const std::string property_name, const std::string message) : std::runtime_error(message), object_type(object_type), property_name(property_name) {} const std::string object_type; const std::string property_name; }; class MissingPropertyValueException : public std::runtime_error { public: MissingPropertyValueException(const std::string object_type, const std::string property_name, const std::string message) : std::runtime_error(message), object_type(object_type), property_name(property_name) {} const std::string object_type; const std::string property_name; }; class MutationOutsideTransactionException : public std::runtime_error { public: MutationOutsideTransactionException(std::string message) : std::runtime_error(message) {} }; // // template method implementations // template inline void Object::set_property_value(ContextType ctx, std::string prop_name, ValueType value, bool try_update) { const Property *prop = object_schema.property_for_name(prop_name); if (!prop) { throw InvalidPropertyException(object_schema.name, prop_name, "Setting invalid property '" + prop_name + "' on object '" + object_schema.name + "'."); } set_property_value_impl(ctx, *prop, value, try_update); }; template inline ValueType Object::get_property_value(ContextType ctx, std::string prop_name) { const Property *prop = object_schema.property_for_name(prop_name); if (!prop) { throw InvalidPropertyException(object_schema.name, prop_name, "Getting invalid property '" + prop_name + "' on object '" + object_schema.name + "'."); } return get_property_value_impl(ctx, *prop); }; template inline void Object::set_property_value_impl(ContextType ctx, const Property &property, ValueType value, bool try_update) { using Accessor = NativeAccessor; if (!m_realm->is_in_transaction()) { throw MutationOutsideTransactionException("Can only set property values within a transaction."); } size_t column = property.table_column; if (property.is_nullable && Accessor::is_null(ctx, value)) { m_row.set_null(column); return; } switch (property.type) { case PropertyTypeBool: m_row.set_bool(column, Accessor::to_bool(ctx, value)); break; case PropertyTypeInt: m_row.set_int(column, Accessor::to_long(ctx, value)); break; case PropertyTypeFloat: m_row.set_float(column, Accessor::to_float(ctx, value)); break; case PropertyTypeDouble: m_row.set_double(column, Accessor::to_double(ctx, value)); break; case PropertyTypeString: m_row.set_string(column, Accessor::to_string(ctx, value)); break; case PropertyTypeData: m_row.set_binary(column, BinaryData(Accessor::to_binary(ctx, value))); break; case PropertyTypeAny: m_row.set_mixed(column, Accessor::to_mixed(ctx, value)); break; case PropertyTypeDate: m_row.set_datetime(column, Accessor::to_datetime(ctx, value)); break; case PropertyTypeObject: { if (Accessor::is_null(ctx, value)) { m_row.nullify_link(column); } else { m_row.set_link(column, Accessor::to_object_index(ctx, m_realm, value, property.object_type, try_update)); } break; } case PropertyTypeArray: { realm::LinkViewRef link_view = m_row.get_linklist(column); link_view->clear(); size_t count = Accessor::list_size(ctx, value); for (size_t i = 0; i < count; i++) { ValueType element = Accessor::list_value_at_index(ctx, value, i); link_view->add(Accessor::to_object_index(ctx, m_realm, element, property.object_type, try_update)); } break; } } } template inline ValueType Object::get_property_value_impl(ContextType ctx, const Property &property) { using Accessor = NativeAccessor; size_t column = property.table_column; if (property.is_nullable && m_row.is_null(column)) { return Accessor::null_value(ctx); } switch (property.type) { case PropertyTypeBool: return Accessor::from_bool(ctx, m_row.get_bool(column)); case PropertyTypeInt: return Accessor::from_long(ctx, m_row.get_int(column)); case PropertyTypeFloat: return Accessor::from_float(ctx, m_row.get_float(column)); case PropertyTypeDouble: return Accessor::from_double(ctx, m_row.get_double(column)); case PropertyTypeString: return Accessor::from_string(ctx, m_row.get_string(column)); case PropertyTypeData: return Accessor::from_binary(ctx, m_row.get_binary(column)); case PropertyTypeAny: throw "Any not supported"; case PropertyTypeDate: return Accessor::from_datetime(ctx, m_row.get_datetime(column)); case PropertyTypeObject: { auto linkObjectSchema = m_realm->config().schema->find(property.object_type); TableRef table = ObjectStore::table_for_object_type(m_realm->read_group(), linkObjectSchema->name); if (m_row.is_null_link(property.table_column)) { return Accessor::null_value(ctx); } return Accessor::from_object(ctx, std::move(Object(m_realm, *linkObjectSchema, table->get(m_row.get_link(column))))); } case PropertyTypeArray: { auto arrayObjectSchema = m_realm->config().schema->find(property.object_type); return Accessor::from_list(ctx, std::move(List(m_realm, *arrayObjectSchema, static_cast(m_row.get_linklist(column))))); } } } template inline Object Object::create(ContextType ctx, SharedRealm realm, const ObjectSchema &object_schema, ValueType value, bool try_update) { using Accessor = NativeAccessor; if (!realm->is_in_transaction()) { throw MutationOutsideTransactionException("Can only create objects within a transaction."); } // get or create our accessor bool created; // try to get existing row if updating size_t row_index = realm::not_found; realm::TableRef table = ObjectStore::table_for_object_type(realm->read_group(), object_schema.name); const Property *primary_prop = object_schema.primary_key_property(); if (primary_prop) { // search for existing object based on primary key type ValueType primary_value = Accessor::dict_value_for_key(ctx, value, object_schema.primary_key); if (primary_prop->type == PropertyTypeString) { row_index = table->find_first_string(primary_prop->table_column, Accessor::to_string(ctx, primary_value)); } else { row_index = table->find_first_int(primary_prop->table_column, Accessor::to_long(ctx, primary_value)); } if (!try_update && row_index != realm::not_found) { throw DuplicatePrimaryKeyValueException(object_schema.name, *primary_prop, "Attempting to create an object of type '" + object_schema.name + "' with an exising primary key value."); } } // if no existing, create row created = false; if (row_index == realm::not_found) { row_index = table->add_empty_row(); created = true; } // populate Object object(realm, object_schema, table->get(row_index)); for (const Property &prop : object_schema.properties) { if (created || !prop.is_primary) { if (Accessor::dict_has_value_for_key(ctx, value, prop.name)) { object.set_property_value_impl(ctx, prop, Accessor::dict_value_for_key(ctx, value, prop.name), try_update); } else if (created) { if (Accessor::has_default_value_for_property(ctx, realm.get(), object_schema, prop.name)) { object.set_property_value_impl(ctx, prop, Accessor::default_value_for_property(ctx, realm.get(), object_schema, prop.name), try_update); } else { throw MissingPropertyValueException(object_schema.name, prop.name, "Missing property value for property " + prop.name); } } } } return object; } // // List implementation // template void List::add(ContextType ctx, ValueType value) { add(NativeAccessor::to_object_index(ctx, m_realm, value, object_schema().name, false)); } template void List::insert(ContextType ctx, ValueType value, size_t list_ndx) { insert(list_ndx, NativeAccessor::to_object_index(ctx, m_realm, value, object_schema().name, false)); } template void List::set(ContextType ctx, ValueType value, size_t list_ndx) { set(list_ndx, NativeAccessor::to_object_index(ctx, m_realm, value, object_schema().name, false)); } } #endif /* defined(REALM_OBJECT_ACCESSOR_HPP) */