xyz.cofe.cxconsole.script.sql

Class SqlEngine

java.lang.Object

xyz.cofe.cxconsole.script.sql.SqlEngine

All Implemented Interfaces:

MapStore, Engine, EngineOutput, GetScriptDocument, SetScriptDocument, xyz.cofe.scn.ScnChanged<SqlEngine,Long>

public class SqlEngine
extends Object
implements Engine, MapStore, xyz.cofe.scn.ScnChanged<SqlEngine,Long>, EngineOutput, SetScriptDocument, GetScriptDocument

Движок SqlEngine

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closeResultSet
protected boolean	closeStatement
protected xyz.cofe.sql.QueryExecutor.Concurrency	concurrency
protected Connection	connection Текущее соединие с БД
protected xyz.cofe.sql.ConnectPool	connectPool
protected String	dataSourceName
protected xyz.cofe.sql.QueryExecutor.ExecMethod	execMethod
protected boolean	fetchGeneratedKeys
protected boolean	fetchGenKeysFirst
protected xyz.cofe.sql.QueryExecutor.Holdability	holdability
protected int	limitRowsFetch
protected xyz.cofe.sql.QueryExecutor.ResultSetType	resultSetType
protected long	scn
protected xyz.cofe.scn.ScnChangedSupport<SqlEngine,Long>	scnChangedSupport
protected WeakReference<TextDocument>	scriptDocument
protected Long	scriptDocumentId

Constructor Summary

Constructors

Constructor and Description
SqlEngine() Конструктор по умолчанию
SqlEngine(SqlEngine sample) Конструктор копирования
SqlEngine(SqlEngineFactory factory) Конструктор

Method Summary

Modifier and Type	Method and Description
void	addScnChangedEvent(xyz.cofe.scn.ScnChangedEvent<SqlEngine,Long> ev)
Closeable	addScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener)
Closeable	addScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener, boolean weakLink)
SqlEngine	clone()
SqlEngineFactory	compareAndSetFactory(SqlEngineFactory cmpVal, SqlEngineFactory setVal) Сраванивает и изменяет текущуюю фабрику на указанную
protected xyz.cofe.collection.Func0<xyz.cofe.collection.Pair<Object,Throwable>>	createExecutor(String query) Создает функцию выполнения SQL запроса
protected xyz.cofe.collection.Pair<Object,Throwable>	executeQuery(String query, Long scriptDocumentID, WeakReference<TextDocument> scriptDocument) Выполняет запрос к БД
void	fireScnChanged(Long old, Long cur)
void	fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent<SqlEngine,Long> event)
void	fireScnChangedEvents()
xyz.cofe.sql.QueryExecutor.Concurrency	getConcurrency() Указывает тип данных в выборке read-only / read-write
Connection	getConnection() Указывает текущее соединине с БД
Connection	getConnection(boolean autoConnect) Возвращает текущее соединение
xyz.cofe.sql.ConnectPool	getConnectPool() Указывает пул соединений
String	getDataSourceName()
Writer	getErrorWriter() Указывает Writer для лога выполения
xyz.cofe.sql.QueryExecutor.ExecMethod	getExecMethod() Указывает метод выполнения SQL запроса
SqlEngineFactory	getFactory() Возвращает фабрику SqlEngine
boolean	getFetchGeneratedKeys() Указывает выбирать Generated keys или нет
boolean	getFetchGenKeysFirst() Указывает когда выбирать Generated key
xyz.cofe.sql.QueryExecutor.Holdability	getHoldability() Указывает доступность данных в ResultSet
int	getLimitRowsFetch() Указывает ограничение кол-ва выбриаемых строк.
xyz.cofe.sql.QueryExecutor.ResultSetType	getResultSetType() Указывает направление выборки / Изменяемая или нет выборка
ConcurrentLinkedQueue<xyz.cofe.scn.ScnChangedEvent<SqlEngine,Long>>	getScnChangedEventQueue()
Set<xyz.cofe.scn.ScnChanedListener<SqlEngine,Long>>	getScnChangedListeners()
protected xyz.cofe.scn.ScnChangedSupport<SqlEngine,Long>	getScnChangedSupport()
TextDocument	getScriptDocument() Указывает документ в рамках которого выполняется SQL скрипт
long	getScriptDocumentId() Указывает документ в рамках которого выполняется SQL скрипт
SqlService	getSqlService()
Writer	getWriter() Указывает Writer для лога выполения
boolean	hasScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener)
boolean	isCloseResultSet() Закрывать ResultSet после выполнения запроса
boolean	isCloseStatement() Закрывать Statement после выполнения запроса
boolean	isPrintResultCounters() Указывает - отображать или нет счетчики производительности
boolean	isTrySharedReconnect() Указывает пробывать reconnect
protected void	nextscn()
protected void	onDataTableCreated(xyz.cofe.data.DataTable dt, WeakReference<TextDocument> scriptDocument, Long scriptDocumentId, Integer dataTableNum) Вызывается при создании/получении таблицы с данными
void	removeAllScnChangedListeners()
void	removeScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener)
void	restore(Map map) Восстанавливает настройки SqlEngine
Long	scn()
void	setCloseResultSet(boolean closeResultSet) Закрывать ResultSet после выполнения запроса
void	setCloseStatement(boolean closeStatement) Закрывать Statement после выполнения запроса
void	setConcurrency(xyz.cofe.sql.QueryExecutor.Concurrency concurrency) Указывает тип данных в выборке read-only / read-write
void	setConnection(Connection conn) Указывает текущее соединение с БД
void	setConnectPool(xyz.cofe.sql.ConnectPool cp) Указывает пул соединений
void	setDataSourceName(String dataSourceName)
void	setErrorWriter(Writer writer) Указывает Writer для лога выполения
void	setExecMethod(xyz.cofe.sql.QueryExecutor.ExecMethod execMethod) Указывает метод выполнения SQL запроса
void	setFactory(SqlEngineFactory ef) Указывает фабрику SqlEngine
void	setFetchGeneratedKeys(boolean fetchGeneratedKeys) Указывает выбирать Generated keys или нет
void	setFetchGenKeysFirst(boolean fetchGenKeysFirst) Указывает когда выбирать Generated key
void	setHoldability(xyz.cofe.sql.QueryExecutor.Holdability holdability) Указывает доступность данных в ResultSet
void	setLimitRowsFetch(int limitRowsFetch) Указывает ограничение кол-ва выбриаемых строк.
void	setPrintResultCounters(boolean printResultCounters) Указывает - отображать или нет счетчики производительности
void	setResultSetType(xyz.cofe.sql.QueryExecutor.ResultSetType resultSetType) Указывает направление выборки / Изменяемая или нет выборка
void	setScriptDocument(TextDocument textDocument) Указывает документ в рамках которого выполняется SQL скрипт
void	setScriptDocumentId(Long scriptDocumentId) Указывает документ в рамках которого выполняется SQL скрипт
void	setTrySharedReconnect(boolean trySharedReconnect) Указывает пробывать reconnect
void	setWriter(Writer writer) Указывает Writer для лога выполения
void	store(Map map) Сохраняет настройки SqlEngine
ExecuteMonitor<String>	submit(String script) Отправляет скрипт на выполнение

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

scn

protected long scn

scnChangedSupport

protected transient xyz.cofe.scn.ScnChangedSupport<SqlEngine,Long> scnChangedSupport

dataSourceName

protected volatile String dataSourceName

closeStatement

protected volatile boolean closeStatement

closeResultSet

protected volatile boolean closeResultSet

concurrency

protected volatile xyz.cofe.sql.QueryExecutor.Concurrency concurrency

holdability

protected volatile xyz.cofe.sql.QueryExecutor.Holdability holdability

fetchGenKeysFirst

protected volatile boolean fetchGenKeysFirst

resultSetType

protected volatile xyz.cofe.sql.QueryExecutor.ResultSetType resultSetType

fetchGeneratedKeys

protected volatile boolean fetchGeneratedKeys

connectPool

protected transient volatile xyz.cofe.sql.ConnectPool connectPool

connection

protected transient Connection connection

Текущее соединие с БД

execMethod

protected volatile xyz.cofe.sql.QueryExecutor.ExecMethod execMethod

limitRowsFetch

protected volatile int limitRowsFetch

scriptDocumentId

protected volatile Long scriptDocumentId

scriptDocument

protected volatile WeakReference<TextDocument> scriptDocument

Constructor Detail

SqlEngine

public SqlEngine()

Конструктор по умолчанию

SqlEngine

public SqlEngine(SqlEngineFactory factory)

Конструктор

Parameters:

factory - фабрика SqlEngine

SqlEngine

public SqlEngine(SqlEngine sample)

Конструктор копирования

Parameters:

sample - образец для копирования

Method Detail

clone

public SqlEngine clone()

Specified by:

clone in interface Engine

Overrides:

clone in class Object

getSqlService

public SqlService getSqlService()

scn

public Long scn()

Specified by:

scn in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

nextscn

protected void nextscn()

getScnChangedSupport

protected xyz.cofe.scn.ScnChangedSupport<SqlEngine,Long> getScnChangedSupport()

hasScnChangedListener

public boolean hasScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener)

Specified by:

hasScnChangedListener in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

getScnChangedListeners

public Set<xyz.cofe.scn.ScnChanedListener<SqlEngine,Long>> getScnChangedListeners()

Specified by:

getScnChangedListeners in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

addScnChangedListener

public Closeable addScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener)

Specified by:

addScnChangedListener in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

addScnChangedListener

public Closeable addScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener,
                                       boolean weakLink)

Specified by:

addScnChangedListener in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

removeScnChangedListener

public void removeScnChangedListener(xyz.cofe.scn.ScnChanedListener<SqlEngine,Long> listener)

Specified by:

removeScnChangedListener in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

removeAllScnChangedListeners

public void removeAllScnChangedListeners()

Specified by:

removeAllScnChangedListeners in interface xyz.cofe.scn.ScnChanged<SqlEngine,Long>

fireScnChangedEvent

public void fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent<SqlEngine,Long> event)

getScnChangedEventQueue

public ConcurrentLinkedQueue<xyz.cofe.scn.ScnChangedEvent<SqlEngine,Long>> getScnChangedEventQueue()

addScnChangedEvent

public void addScnChangedEvent(xyz.cofe.scn.ScnChangedEvent<SqlEngine,Long> ev)

fireScnChangedEvents

public void fireScnChangedEvents()

fireScnChanged

public void fireScnChanged(Long old,
                           Long cur)

getDataSourceName

public String getDataSourceName()

setDataSourceName

public void setDataSourceName(String dataSourceName)

isCloseStatement

public boolean isCloseStatement()

Закрывать Statement после выполнения запроса

Returns:

true - Закрывать

setCloseStatement

public void setCloseStatement(boolean closeStatement)

Закрывать Statement после выполнения запроса

Parameters:

closeStatement - true - Закрывать

isCloseResultSet

public boolean isCloseResultSet()

Закрывать ResultSet после выполнения запроса

Returns:

true - Закрывать

setCloseResultSet

public void setCloseResultSet(boolean closeResultSet)

Закрывать ResultSet после выполнения запроса

Parameters:

closeResultSet - true - Закрывать

getConcurrency

public xyz.cofe.sql.QueryExecutor.Concurrency getConcurrency()

Указывает тип данных в выборке read-only / read-write

Returns:

тип данных

setConcurrency

public void setConcurrency(xyz.cofe.sql.QueryExecutor.Concurrency concurrency)

Указывает тип данных в выборке read-only / read-write

Parameters:

concurrency - тип данных

getHoldability

public xyz.cofe.sql.QueryExecutor.Holdability getHoldability()

Указывает доступность данных в ResultSet

Returns:

доступность данных

setHoldability

public void setHoldability(xyz.cofe.sql.QueryExecutor.Holdability holdability)

Указывает доступность данных в ResultSet

Parameters:

holdability - доступность данных

getFetchGenKeysFirst

public boolean getFetchGenKeysFirst()

Указывает когда выбирать Generated key

Returns:

true - перед ResultSet / false после ResultSet

setFetchGenKeysFirst

public void setFetchGenKeysFirst(boolean fetchGenKeysFirst)

Указывает когда выбирать Generated key

Parameters:

fetchGenKeysFirst - true - перед ResultSet / false после ResultSet

getResultSetType

public xyz.cofe.sql.QueryExecutor.ResultSetType getResultSetType()

Указывает направление выборки / Изменяемая или нет выборка

Returns:

тип выборки

setResultSetType

public void setResultSetType(xyz.cofe.sql.QueryExecutor.ResultSetType resultSetType)

Указывает направление выборки / Изменяемая или нет выборка

Parameters:

resultSetType - тип выборки

getFetchGeneratedKeys

public boolean getFetchGeneratedKeys()

Указывает выбирать Generated keys или нет

Returns:

true - выбирать generated keys

setFetchGeneratedKeys

public void setFetchGeneratedKeys(boolean fetchGeneratedKeys)

Указывает выбирать Generated keys или нет

Parameters:

fetchGeneratedKeys - true - выбирать generated keys

getConnectPool

public xyz.cofe.sql.ConnectPool getConnectPool()

Указывает пул соединений

Returns:

пул соединений

setConnectPool

public void setConnectPool(xyz.cofe.sql.ConnectPool cp)

Указывает пул соединений

Parameters:

cp - пул соединений

getFactory

public SqlEngineFactory getFactory()

Возвращает фабрику SqlEngine

Specified by:

getFactory in interface Engine

Returns:

фабрика SqlEngine

setFactory

public void setFactory(SqlEngineFactory ef)

Указывает фабрику SqlEngine

Parameters:

ef - фабрика SqlEngine

compareAndSetFactory

public SqlEngineFactory compareAndSetFactory(SqlEngineFactory cmpVal,
                                             SqlEngineFactory setVal)

Сраванивает и изменяет текущуюю фабрику на указанную

Parameters:

cmpVal - сравнивоемое значение

setVal - замещаемое значение

Returns:

замещенное/текущее значение

submit

public ExecuteMonitor<String> submit(String script)

Отправляет скрипт на выполнение

Specified by:

submit in interface Engine

Parameters:

script - скрипт

Returns:

Монитор выполнения

createExecutor

protected xyz.cofe.collection.Func0<xyz.cofe.collection.Pair<Object,Throwable>> createExecutor(String query)

Создает функцию выполнения SQL запроса

Parameters:

query - SQL запрос

Returns:

функция

getConnection

public Connection getConnection()
                         throws SQLException

Указывает текущее соединине с БД

Returns:

соединеине с БД

Throws:

SQLException

getConnection

public Connection getConnection(boolean autoConnect)
                         throws SQLException

Возвращает текущее соединение

Parameters:

autoConnect - true - выполняет connect если соединение не открыто

Returns:

соединеине с БД

Throws:

SQLException - Ошибка соединения с БД

setConnection

public void setConnection(Connection conn)

Указывает текущее соединение с БД

Parameters:

conn - соединение с БД

setWriter

public void setWriter(Writer writer)

Указывает Writer для лога выполения

Specified by:

setWriter in interface EngineOutput

Parameters:

writer - writer для лога выполения

getWriter

public Writer getWriter()

Указывает Writer для лога выполения

Specified by:

getWriter in interface EngineOutput

Returns:

writer для лога выполения

setErrorWriter

public void setErrorWriter(Writer writer)

Указывает Writer для лога выполения

Specified by:

setErrorWriter in interface EngineOutput

Parameters:

writer - writer для лога выполения

getErrorWriter

public Writer getErrorWriter()

Указывает Writer для лога выполения

Specified by:

getErrorWriter in interface EngineOutput

Returns:

writer для лога выполения

isTrySharedReconnect

public boolean isTrySharedReconnect()

Указывает пробывать reconnect

Returns:

true - пробывать reconnect

setTrySharedReconnect

public void setTrySharedReconnect(boolean trySharedReconnect)

Указывает пробывать reconnect

Parameters:

trySharedReconnect - true - пробывать reconnect

getExecMethod

public xyz.cofe.sql.QueryExecutor.ExecMethod getExecMethod()

Указывает метод выполнения SQL запроса

Returns:

метод выполнения SQL запроса

setExecMethod

public void setExecMethod(xyz.cofe.sql.QueryExecutor.ExecMethod execMethod)

Указывает метод выполнения SQL запроса

Parameters:

execMethod - метод выполнения SQL запроса

getLimitRowsFetch

public int getLimitRowsFetch()

Указывает ограничение кол-ва выбриаемых строк.

Returns:

0 и меньше - без ограничения

setLimitRowsFetch

public void setLimitRowsFetch(int limitRowsFetch)

Указывает ограничение кол-ва выбриаемых строк.

Parameters:

limitRowsFetch - 0 и меньше - без ограничения

executeQuery

protected xyz.cofe.collection.Pair<Object,Throwable> executeQuery(String query,
                                                                  Long scriptDocumentID,
                                                                  WeakReference<TextDocument> scriptDocument)

Выполняет запрос к БД

Parameters:

query - запрос

scriptDocumentID - идентификатор документа содержащего запрос

scriptDocument - ссылка на документ содержащего запрос

Returns:

isPrintResultCounters

public boolean isPrintResultCounters()

Указывает - отображать или нет счетчики производительности

Returns:

true - отображает счетчики производительности

setPrintResultCounters

public void setPrintResultCounters(boolean printResultCounters)

Указывает - отображать или нет счетчики производительности

Parameters:

printResultCounters - true - отображает счетчики производительности

getScriptDocumentId

public long getScriptDocumentId()

Указывает документ в рамках которого выполняется SQL скрипт

Returns:

документ (id)

setScriptDocumentId

public void setScriptDocumentId(Long scriptDocumentId)

Указывает документ в рамках которого выполняется SQL скрипт

Parameters:

scriptDocumentId - документ (id)

setScriptDocument

public void setScriptDocument(TextDocument textDocument)

Указывает документ в рамках которого выполняется SQL скрипт

Specified by:

setScriptDocument in interface SetScriptDocument

Parameters:

textDocument - документ

getScriptDocument

public TextDocument getScriptDocument()

Указывает документ в рамках которого выполняется SQL скрипт

Specified by:

getScriptDocument in interface GetScriptDocument

Returns:

документ

onDataTableCreated

protected void onDataTableCreated(xyz.cofe.data.DataTable dt,
                                  WeakReference<TextDocument> scriptDocument,
                                  Long scriptDocumentId,
                                  Integer dataTableNum)

Вызывается при создании/получении таблицы с данными

Parameters:

dt - таблица

scriptDocument - документ в рамках которого выполняется SQL скрипт

scriptDocumentId - документ в рамках которого выполняется SQL скрипт

dataTableNum - порядковый номер (от 0) таблицы

store

public void store(Map map)

Сохраняет настройки SqlEngine

Specified by:

store in interface MapStore

Parameters:

map - карта с настройками

restore

public void restore(Map map)

Восстанавливает настройки SqlEngine

Specified by:

restore in interface MapStore

Parameters:

map - карта с настройками