xyz.cofe.sql.stream

Interface QueryStream

All Known Implementing Classes:

QueryStreamDummy, QueryStreamWrapper, XmlStreamWriter

public interface QueryStream

Пишет результат запроса SQL.

В обычном случае должна быть примерно такая последоавтельность вызовов:

1. queryStreamBegin()
   1. tableBegin() Запись табличных данных - возможно вызов несколько раз
      1. Запись мета данных
         1. metaBegin() - Запись мета данных
         2. columnBegin() - Запись данных о колонке - возможно (скорей всего) вызов несколько раз
         3. columnProperty()
         4. columnEnd()
         5. metaEnd()
      2. Запись данных
         1. dataBegin()
         2. rowBegin()
         3. cell()
         4. rowEnd()
         5. dataEnd()
   2. tableEnd()
   3. generatedKeysBegin() - Запись данных о автоматически сгенерированых первичных ключах
      1. последовательность вызовов аналогична внутриннястям tableBegin() .. tableEnd()
   4. generatedKeysEnd() - конец записи о сгенерированных первичных ключах
   5. updateCount() - кол-во измененных строк
   6. error() - сообщение о ошибке *
   7. message() - сообщение генерируемое базой при выборке данных (PRINT/DBMS_OUTPUT) *
2. queryStreamEnd() - конец табличных данных

* - вызов error() и message() - может происходить из другого потока для синхронизации событий используются метки ScnMark

Author:

nt.gocha@gmail.com

See Also:

ScnMark

Method Summary

Modifier and Type	Method and Description
void	cell(int columnIndex, Object value, ScnMark scm) Данные ячейки строки из выборки
void	columnBegin(int columnIndex, ScnMark scm) Начало колонки (мета данные)
void	columnEnd() Конец описания колонки (мета данные)
void	columnProperty(String key, Object value, ScnMark scm) Описание колонки (мета данные)
void	dataBegin(ScnMark scm) Начало данных выборки
void	dataEnd() Конец данных выборки
void	error(Err err, ScnMark scm) Событие ошибки при чтении данных/получении выборки
void	generatedKeysBegin(ScnMark scm) Отмечает начало табличных данных сгенерируемых первичных ключей
void	generatedKeysEnd() Отмечает конец дпнных о первичных ключах
void	message(Message message) Сообщения генерируемое базой при выборке данных (PRINT/DBMS_OUTPUT)
void	metaBegin(ScnMark scm) Начало описания табличных данных (мета данные)
void	metaEnd() Конец описания мета данных выборки
void	queryStreamBegin() Отмечает начало записи SQL выборки.
void	queryStreamEnd() Отмечает конец записи SQL выборки
void	rowBegin(int rowIndex, ScnMark scm) Начало данных строки из выборки
void	rowEnd() Конец данных строки из выборки
void	tableBegin(int tableIndex, ScnMark scm) Начало табличных данных
void	tableEnd() Конец табличных данных
void	updateCount(int count, ScnMark scm) Отмечает кол-во созданых/измененных строк

Method Detail

queryStreamBegin

void queryStreamBegin()

Отмечает начало записи SQL выборки.

В процессе работы вызываются все остальные методы, послединй меотд обычно должен быть queryStreamEnd.
Возможна ситуация, что в процессе выборки события message и error будут происходить из другого трэда ОС.

See Also:

queryStreamEnd()

tableBegin

void tableBegin(int tableIndex,
                ScnMark scm)

Начало табличных данных

Parameters:

tableIndex - индекс табличных данных, 0 - первая выборка, возможно более одной выборки табличных данных в результате запроса

scm - отмета SCN

metaBegin

void metaBegin(ScnMark scm)

Начало описания табличных данных (мета данные)

Parameters:

scm - отметка SCN

columnBegin

void columnBegin(int columnIndex,
                 ScnMark scm)

Начало колонки (мета данные)

Parameters:

columnIndex - индекс колонки

scm - отметка SCN

columnProperty

void columnProperty(String key,
                    Object value,
                    ScnMark scm)

Описание колонки (мета данные)

Parameters:

key - имя свойства

value - значение свойства

scm - отметка SCN

columnEnd

void columnEnd()

Конец описания колонки (мета данные)

metaEnd

void metaEnd()

Конец описания мета данных выборки

dataBegin

void dataBegin(ScnMark scm)

Начало данных выборки

Parameters:

scm - отметка SCN

rowBegin

void rowBegin(int rowIndex,
              ScnMark scm)

Начало данных строки из выборки

Parameters:

rowIndex - иднекс строки

scm - отметка SCN

cell

void cell(int columnIndex,
          Object value,
          ScnMark scm)

Данные ячейки строки из выборки

Parameters:

columnIndex - индекс колонки

value - значение

scm - отметка SCN

rowEnd

void rowEnd()

Конец данных строки из выборки

dataEnd

void dataEnd()

Конец данных выборки

tableEnd

void tableEnd()

Конец табличных данных

updateCount

void updateCount(int count,
                 ScnMark scm)

Отмечает кол-во созданых/измененных строк

Parameters:

count - кол-во строк

scm - отметка SCN

message

void message(Message message)

Сообщения генерируемое базой при выборке данных (PRINT/DBMS_OUTPUT)

Parameters:

message - сообщение

error

void error(Err err,
           ScnMark scm)

Событие ошибки при чтении данных/получении выборки

Parameters:

err - описание ошибки

scm - отметка SCN

generatedKeysBegin

void generatedKeysBegin(ScnMark scm)

Отмечает начало табличных данных сгенерируемых первичных ключей

Parameters:

scm - отметка SCN

generatedKeysEnd

void generatedKeysEnd()

Отмечает конец дпнных о первичных ключах

queryStreamEnd

void queryStreamEnd()

Отмечает конец записи SQL выборки