15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#ifndef COMPONENTS_WEBDATA_COMMON_WEB_DATABASE_TABLE_H_ 6c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#define COMPONENTS_WEBDATA_COMMON_WEB_DATABASE_TABLE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 9c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "components/webdata/common/webdata_export.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace sql { 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Connection; 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MetaTable; 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// An abstract base class representing a table within a WebDatabase. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Each table should subclass this, adding type-specific methods as needed. 18c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class WEBDATA_EXPORT WebDatabaseTable { 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // To look up a WebDatabaseTable of a certain type from WebDatabase, 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // we use a void* key, so that we can simply use the address of one 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // of the type's statics. 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) typedef void* TypeKey; 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The object is not ready for use until Init() has been called. 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) WebDatabaseTable(); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~WebDatabaseTable(); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Retrieves the TypeKey for the concrete subtype. 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual TypeKey GetTypeKey() const = 0; 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 32effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Stores the passed members as instance variables. 33effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch void Init(sql::Connection* db, sql::MetaTable* meta_table); 34effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 35effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Create all of the expected SQL tables if they do not already exist. 36effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch // Returns true on success, false on failure. 37effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch virtual bool CreateTablesIfNecessary() = 0; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // In order to encourage developers to think about sync when adding or 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // or altering new tables, this method must be implemented. Please get in 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // contact with the sync team if you believe you're making a change that they 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // should be aware of (or if you could break something). 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(andybons): Implement something more robust. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsSyncable() = 0; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Migrates this table to |version|. Returns false if there was 472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // migration work to do and it failed, true otherwise. 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Implementations may set |*update_compatible_version| to true if 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the compatible version should be changed to |version|. 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Implementations should otherwise not modify this parameter. 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool MigrateToVersion(int version, 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool* update_compatible_version) = 0; 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) protected: 562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Non-owning. These are owned by WebDatabase, valid as long as that 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // class exists. Since lifetime of WebDatabaseTable objects slightly 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // exceeds that of WebDatabase, they should not be used in 592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // ~WebDatabaseTable. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sql::Connection* db_; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sql::MetaTable* meta_table_; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(WebDatabaseTable); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 67c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#endif // COMPONENTS_WEBDATA_COMMON_WEB_DATABASE_TABLE_H_ 68