Kexi API Documentation (2.0 alpha)
	Overview Class Hierarchy Classes Classes (annotated) Members Source Files

KexiDB::OrderByColumn Class Reference

#include <queryschema.h>

List of all members.

---

Detailed Description

KexiDB::OrderByColumn provides information about a single query column used for sorting.

The column can be expression or table field.

Definition at line 100 of file queryschema.h.

Public Types
typedef QValueListConstIterator< OrderByColumn >	ListConstIterator
Public Member Functions
	OrderByColumn ()
	OrderByColumn (QueryColumnInfo &column, bool ascending=true, int pos=-1)
	OrderByColumn (Field &field, bool ascending=true)
	Like above but used when the field field is not present on the list of columns.
	~OrderByColumn ()
QueryColumnInfo *	column () const
	A column to sort.
int	position () const
Field *	field () const
	A field to sort, used only in case when the second constructor was used.
bool	ascending () const
bool	operator== (const OrderByColumn &col) const
QString	debugString () const
QString	toSQLString (bool includeTableName=true) const
Protected Attributes
QueryColumnInfo *	m_column
	Column to sort 0 if m_field is non-0.
int	m_pos
	A helper for m_column that allows to know that sorting column was defined by providing its position.
Field *	m_field
	Used only in case when the second contructor is used.
bool	m_ascending: 1
	true if ascending sorting should be performed (the default).

---

Member Typedef Documentation

typedef QValueListConstIterator<OrderByColumn> KexiDB::OrderByColumn::ListConstIterator

Definition at line 103 of file queryschema.h.

---

Constructor & Destructor Documentation

OrderByColumn::OrderByColumn (   )

Definition at line 331 of file queryschema.cpp.

OrderByColumn::OrderByColumn (  QueryColumnInfo &  column, bool  ascending = true, int  pos = -1 )

Definition at line 339 of file queryschema.cpp.

OrderByColumn::OrderByColumn (  Field &  field, bool  ascending = true )

Like above but used when the field field is not present on the list of columns. (e.g. SELECT a FROM t ORDER BY b; where T is a table with fields (a,b)). Definition at line 347 of file queryschema.cpp.

OrderByColumn::~OrderByColumn (   )

Definition at line 355 of file queryschema.cpp.

---

Member Function Documentation

bool KexiDB::OrderByColumn::ascending (   )  const [inline]

Returns: true if ascending sorting should be performed (the default). Definition at line 125 of file queryschema.h.

QueryColumnInfo* KexiDB::OrderByColumn::column (   )  const [inline]

A column to sort. Definition at line 114 of file queryschema.h.

QString OrderByColumn::debugString (   )  const

Returns: string for debugging purposes. Definition at line 359 of file queryschema.cpp. References KexiDB::Field::debugString(), KexiDB::QueryColumnInfo::debugString(), m_ascending, m_column, m_field, and m_pos.

Field* KexiDB::OrderByColumn::field (   )  const [inline]

A field to sort, used only in case when the second constructor was used. Definition at line 122 of file queryschema.h.

bool KexiDB::OrderByColumn::operator== (  const OrderByColumn &  col  )  const [inline]

Returns: true if this column is thesame as col Definition at line 128 of file queryschema.h. References m_ascending, m_column, and m_field.

int KexiDB::OrderByColumn::position (   )  const [inline]

A helper for column() that allows you to know that sorting column was defined by providing its position. -1 by default. Example query: SELECT a, b FROM T ORDER BY 2 Definition at line 119 of file queryschema.h.

QString OrderByColumn::toSQLString (  bool  includeTableName = true  )  const

Returns: a string like "name ASC" usable for building a SQL statement. If includeTableNames is true (the default) field is output in a form of "tablename.fieldname" (but only if fieldname is not a name of alias). Definition at line 373 of file queryschema.cpp. References KexiDB::QueryColumnInfo::alias, KexiDB::QueryColumnInfo::aliasOrName(), KexiDB::QueryColumnInfo::field, m_ascending, m_column, m_field, m_pos, KexiDB::Field::name(), and KexiDB::Field::table().

---

Member Data Documentation

bool KexiDB::OrderByColumn::m_ascending [protected]

true if ascending sorting should be performed (the default). Definition at line 149 of file queryschema.h. Referenced by debugString(), operator==(), and toSQLString().

QueryColumnInfo* KexiDB::OrderByColumn::m_column [protected]

Column to sort 0 if m_field is non-0. Definition at line 142 of file queryschema.h. Referenced by debugString(), operator==(), and toSQLString().

Field* KexiDB::OrderByColumn::m_field [protected]

Used only in case when the second contructor is used. Definition at line 146 of file queryschema.h. Referenced by debugString(), operator==(), and toSQLString().

int KexiDB::OrderByColumn::m_pos [protected]

A helper for m_column that allows to know that sorting column was defined by providing its position. -1 by default. e.g. SELECT a, b FROM T ORDER BY 2 Definition at line 143 of file queryschema.h. Referenced by debugString(), and toSQLString().

---

The documentation for this class was generated from the following files:

• queryschema.h
• queryschema.cpp

This file is part of the documentation for Kexi 2.0 alpha.

Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:50:47 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003