2 // Open Service Platform
\r
3 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
\r
5 // Licensed under the Apache License, Version 2.0 (the License);
\r
6 // you may not use this file except in compliance with the License.
\r
7 // You may obtain a copy of the License at
\r
9 // http://www.apache.org/licenses/LICENSE-2.0
\r
11 // Unless required by applicable law or agreed to in writing, software
\r
12 // distributed under the License is distributed on an "AS IS" BASIS,
\r
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
14 // See the License for the specific language governing permissions and
\r
15 // limitations under the License.
\r
19 * @file FIoDataSet.h
\r
20 * @brief This is the header file for the %DataSet class.
\r
22 * This header file contains the declarations of the %DataSet class.
\r
25 #ifndef _FIO_DATA_SET_H_
\r
26 #define _FIO_DATA_SET_H_
\r
28 #include <FBaseObject.h>
\r
29 #include <FBaseColIList.h>
\r
30 #include <FIoDataRow.h>
\r
31 #include <FIoDataSetEnumerator.h>
\r
33 namespace Tizen { namespace Io
\r
38 * @brief This class provides methods to manipulate in-memory table.
\r
42 * @final This class is not intended for extension.
\r
44 * The %DataSet class provides methods to manipulate in-memory table.
\r
46 class _OSP_EXPORT_ DataSet
\r
47 : public Tizen::Base::Object
\r
52 * The object is not fully constructed after this constructor is called. For full construction,
\r
53 * the Construct() method must be called right after calling this constructor.
\r
60 * This destructor overrides Tizen::Base::Object::~Object().
\r
64 virtual ~DataSet(void);
\r
67 * Creates in-memory table.
\r
71 * @return An error code
\r
72 * @param[in] columnNames The list of column names to create @n
\r
73 * The object type in the specified list should be String.
\r
74 * @exception E_SUCCESS The method is successful.
\r
75 * @exception E_INVALID_ARG The specified @c columnNames has no element.
\r
77 result Construct(const Tizen::Base::Collection::IList& columnNames);
\r
80 * Creates a row in the table.
\r
84 * @return A pointer to the DataRow instance, @n
\r
85 * else @c null if the memory is insufficient
\r
86 * @remarks The column type is decided by the type of each element inserted in first row.
\r
87 * If a specific column element on the first row is not inserted, then the column's type is @c DB_COLUMNTYPE_NULL
\r
88 * In that case, when a new column element is added later,
\r
89 * then the column's type will be changed according to the new element.
\r
91 DataRow* CreateDataRowN(void);
\r
94 * Gets a table enumerator.
\r
98 * @return A pointer to the DataSetEnumerator instance, @n
\r
99 * else @c null if the memory is insufficient
\r
101 DataSetEnumerator* GetDataSetEnumeratorN(void);
\r
105 * Gets a copy of this instance.
\r
109 * @return A pointer to the copy of the %DataSet instance, @n
\r
110 * else @c null if the memory is insufficient
\r
112 DataSet* CloneN(void) const;
\r
115 * Checks whether the value of a specified instance of Tizen::Base::Object is equal to the value of a current instance of
\r
120 * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current
\r
121 * instance of %DataSet, @n
\r
123 * @param[in] obj An instance of Tizen::Base::Object to compare
\r
124 * @remarks This method returns @c false if the specified @c obj is not a %DataSet instance.
\r
126 virtual bool Equals(const Tizen::Base::Object& obj) const;
\r
129 * Gets the hash value of a current instance.
\r
133 * @return The hash value of the current instance
\r
135 virtual int GetHashCode(void) const;
\r
139 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
\r
144 DataSet(const DataSet& value);
\r
147 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
\r
151 DataSet& operator =(const DataSet& rhs);
\r
153 class _DataSetImpl* __pDataSetImpl;
\r
154 friend class _DataSetImpl;
\r
160 #endif // _FIO_DATA_SET_H_
\r