2 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
19 * @brief This is the header file for the %DataSet class.
21 * This header file contains the declarations of the %DataSet class.
24 #ifndef _FIO_DATA_SET_H_
25 #define _FIO_DATA_SET_H_
27 #include <FBaseObject.h>
28 #include <FBaseColIList.h>
29 #include <FIoDataRow.h>
30 #include <FIoDataSetEnumerator.h>
32 namespace Tizen { namespace Io
37 * @brief This class provides methods to manipulate in-memory table.
41 * @final This class is not intended for extension.
43 * The %DataSet class provides methods to manipulate in-memory table.
45 class _OSP_EXPORT_ DataSet
46 : public Tizen::Base::Object
51 * The object is not fully constructed after this constructor is called. For full construction,
52 * the Construct() method must be called right after calling this constructor.
59 * This destructor overrides Tizen::Base::Object::~Object().
63 virtual ~DataSet(void);
66 * Creates an in-memory table.
70 * @return An error code
71 * @param[in] columnNames The list of column names to create @n
72 * The object type in the specified list should be String.
73 * @exception E_SUCCESS The method is successful.
74 * @exception E_INVALID_ARG The specified @c columnNames has no element.
76 result Construct(const Tizen::Base::Collection::IList& columnNames);
79 * Creates a row in the table.
83 * @return A pointer to the DataRow instance, @n
84 * else @c null if the memory is insufficient
85 * @remarks The column type is decided by the type of each element inserted in first row. @n
86 * If a specific column element on the first row is not inserted, then the column's type is ::DB_COLUMNTYPE_NULL. @n
87 * In that case, when a new column element is added later, then the column's type will be changed according to the new element.
89 DataRow* CreateDataRowN(void);
92 * Gets the table enumerator.
96 * @return A pointer to the DataSetEnumerator instance, @n
97 * else @c null if the memory is insufficient
99 DataSetEnumerator* GetDataSetEnumeratorN(void);
103 * Gets a copy of this instance.
107 * @return A pointer to the copy of the %DataSet instance, @n
108 * else @c null if the memory is insufficient
110 DataSet* CloneN(void) const;
113 * Checks whether the value of a specified instance of Tizen::Base::Object is equal to the value of a current instance of
118 * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current
119 * instance of %DataSet, @n
121 * @param[in] obj An instance of Tizen::Base::Object to compare
122 * @remarks This method returns @c false if the specified @c obj is not a %DataSet instance.
124 virtual bool Equals(const Tizen::Base::Object& obj) const;
127 * Gets the hash value of the current instance.
131 * @return The hash value of the current instance
133 virtual int GetHashCode(void) const;
137 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
142 DataSet(const DataSet& value);
145 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
149 DataSet& operator =(const DataSet& rhs);
151 class _DataSetImpl* __pDataSetImpl;
152 friend class _DataSetImpl;
158 #endif // _FIO_DATA_SET_H_