IDBKey.h revision cad810f21b803229eb11403f9209855525a25d57 
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 IDBKey_h
27#define IDBKey_h
28
29#if ENABLE(INDEXED_DATABASE)
30
31#include "PlatformString.h"
32#include <wtf/Forward.h>
33#include <wtf/Threading.h>
34
35namespace WebCore {
36
37class SQLiteStatement;
38
39class IDBKey : public ThreadSafeShared<IDBKey> {
40public:
41    static PassRefPtr<IDBKey> createNull()
42    {
43        RefPtr<IDBKey> idbKey(new IDBKey());
44        idbKey->m_type = NullType;
45        return idbKey.release();
46    }
47
48    static PassRefPtr<IDBKey> createNumber(double number)
49    {
50        RefPtr<IDBKey> idbKey(new IDBKey());
51        idbKey->m_type = NumberType;
52        idbKey->m_number = number;
53        return idbKey.release();
54    }
55
56    static PassRefPtr<IDBKey> createString(const String& string)
57    {
58        RefPtr<IDBKey> idbKey(new IDBKey());
59        idbKey->m_type = StringType;
60        idbKey->m_string = string;
61        return idbKey.release();
62    }
63
64    static PassRefPtr<IDBKey> createDate(double date)
65    {
66        RefPtr<IDBKey> idbKey(new IDBKey());
67        idbKey->m_type = DateType;
68        idbKey->m_date = date;
69        return idbKey.release();
70    }
71
72    ~IDBKey();
73
74    // In order of the least to the highest precedent in terms of sort order.
75    enum Type {
76        NullType = 0, // FIXME: Phase out support for null keys.
77        StringType,
78        DateType,
79        NumberType
80    };
81
82    Type type() const { return m_type; }
83
84    const String& string() const
85    {
86        ASSERT(m_type == StringType);
87        return m_string;
88    }
89
90    double date() const
91    {
92        ASSERT(m_type == DateType);
93        return m_date;
94    }
95
96    double number() const
97    {
98        ASSERT(m_type == NumberType);
99        return m_number;
100    }
101
102    static PassRefPtr<IDBKey> fromQuery(SQLiteStatement& query, int baseColumn);
103
104    bool isEqual(IDBKey* other);
105    String whereSyntax(String qualifiedTableName = "") const;
106    String lowerCursorWhereFragment(String comparisonOperator, String qualifiedTableName = "");
107    String upperCursorWhereFragment(String comparisonOperator, String qualifiedTableName = "");
108    int bind(SQLiteStatement& query, int column) const;
109    void bindWithNulls(SQLiteStatement& query, int baseColumn) const;
110
111    using ThreadSafeShared<IDBKey>::ref;
112    using ThreadSafeShared<IDBKey>::deref;
113
114private:
115    IDBKey();
116
117    Type m_type;
118    String m_string;
119    double m_date;
120    double m_number;
121};
122
123}
124
125#endif // ENABLE(INDEXED_DATABASE)
126
127#endif // IDBKey_h
128