Home | History | Annotate | Download | only in public 
      1 /*
      2  * Copyright (C) 2010 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  * 1.  Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  * 2.  Redistributions in binary form must reproduce the above copyright
     11  *     notice, this list of conditions and the following disclaimer in the
     12  *     documentation and/or other materials provided with the distribution.
     13  *
     14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
     15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef WebIDBIndex_h
     27 #define WebIDBIndex_h
     28 
     29 #include "WebExceptionCode.h"
     30 #include "WebIDBTransaction.h"
     31 #include "WebString.h"
     32 
     33 namespace WebKit {
     34 
     35 class WebIDBCallbacks;
     36 class WebIDBKey;
     37 class WebIDBKeyRange;
     38 
     39 // See comment in WebIDBFactory for a high level overview of these classes.
     40 class WebIDBIndex {
     41 public:
     42     virtual ~WebIDBIndex() { }
     43 
     44     virtual WebString name() const
     45     {
     46         WEBKIT_ASSERT_NOT_REACHED();
     47         return WebString();
     48     }
     49     virtual WebString storeName() const
     50     {
     51         WEBKIT_ASSERT_NOT_REACHED();
     52         return WebString();
     53     }
     54     virtual WebString keyPath() const
     55     {
     56         WEBKIT_ASSERT_NOT_REACHED();
     57         return WebString();
     58     }
     59     virtual bool unique() const
     60     {
     61         WEBKIT_ASSERT_NOT_REACHED();
     62         return false;
     63     }
     64 
     65     virtual void openObjectCursor(const WebIDBKeyRange&, unsigned short direction, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     66     virtual void openKeyCursor(const WebIDBKeyRange&, unsigned short direction, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     67     virtual void getObject(const WebIDBKey&, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     68     virtual void getKey(const WebIDBKey&, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
     69 
     70 protected:
     71     WebIDBIndex() {}
     72 };
     73 
     74 } // namespace WebKit
     75 
     76 #endif // WebIDBIndex_h
     77