com.trolltech.qt.sql
Class QSqlIndex

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.sql.QSqlRecord
                  extended by com.trolltech.qt.sql.QSqlIndex
All Implemented Interfaces:
QtJambiInterface, java.lang.Cloneable

public class QSqlIndex
extends QSqlRecord
implements java.lang.Cloneable

The QSqlIndex class provides functions to manipulate and describe database indexes. An index refers to a single table or view in a database. Information about the fields that comprise the index can be used to generate SQL statements.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QSqlIndex()
          Constructs an empty index using the cursor name cursorname and index name name.
QSqlIndex(QSqlIndex other)
          Constructs a copy of other.
QSqlIndex(java.lang.String cursorName)
          Constructs an empty index using the cursor name cursorname and index name name.
QSqlIndex(java.lang.String cursorName, java.lang.String name)
          Constructs an empty index using the cursor name cursorname and index name name.
 
Method Summary
 void append(QSqlField field, boolean desc)
          This is an overloaded member function, provided for convenience.
 QSqlIndex clone()
          This method is reimplemented for internal reasons
 java.lang.String cursorName()
          Returns the name of the cursor which the index is associated with.
 boolean isDescending(int i)
          Returns true if field i in the index is sorted in descending order; otherwise returns false.
 java.lang.String name()
          Returns the name of the index.
 void setCursorName(java.lang.String cursorName)
          Sets the name of the cursor that the index is associated with to cursorName.
 void setDescending(int i, boolean desc)
          If desc is true, field i is sorted in descending order.
 void setName(java.lang.String name)
          Sets the name of the index to name.
 
Methods inherited from class com.trolltech.qt.sql.QSqlRecord
append, clear, clearValues, contains, count, field, field, fieldName, indexOf, insert, isEmpty, isGenerated, isGenerated, isNull, isNull, remove, replace, setGenerated, setGenerated, setNull, setNull, setValue, setValue, toString, value, value
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QSqlIndex

public QSqlIndex(QSqlIndex other)
Constructs a copy of other.


QSqlIndex

public QSqlIndex(java.lang.String cursorName)
Constructs an empty index using the cursor name cursorname and index name name.


QSqlIndex

public QSqlIndex()
Constructs an empty index using the cursor name cursorname and index name name.


QSqlIndex

public QSqlIndex(java.lang.String cursorName,
                 java.lang.String name)
Constructs an empty index using the cursor name cursorname and index name name.

Method Detail

append

public final void append(QSqlField field,
                         boolean desc)
This is an overloaded member function, provided for convenience.

Appends the field field to the list of indexed fields. The field is appended with an ascending sort order, unless desc is true.


cursorName

public final java.lang.String cursorName()
Returns the name of the cursor which the index is associated with.

See also:
setCursorName().


isDescending

public final boolean isDescending(int i)
Returns true if field i in the index is sorted in descending order; otherwise returns false.


name

public final java.lang.String name()
Returns the name of the index.

See also:
setName().


setCursorName

public final void setCursorName(java.lang.String cursorName)
Sets the name of the cursor that the index is associated with to cursorName.

See also:
cursorName().


setDescending

public final void setDescending(int i,
                                boolean desc)
If desc is true, field i is sorted in descending order. Otherwise, field i is sorted in ascending order (the default). If the field does not exist, nothing happens.

See also:
isDescending().


setName

public final void setName(java.lang.String name)
Sets the name of the index to name.

See also:
name().


clone

public QSqlIndex clone()
This method is reimplemented for internal reasons

Overrides:
clone in class QSqlRecord