Package com.stimulsoft.report.dictionary.dataSources

Class StiSqlSource

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.dictionary.dataSources.StiDataSource

com.stimulsoft.report.dictionary.dataSources.StiDataStoreSource

com.stimulsoft.report.dictionary.dataSources.StiDataTableSource

com.stimulsoft.report.dictionary.dataSources.StiSqlSource

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiEnumerator, ICloneable, IStiAlias, IStiInherited, IStiStateSaveRestore, Cloneable

Direct Known Subclasses:

StiCassandraSource, StiDuckDbSource, StiJDBCSource, StiMsSqlSource, StiMySqlSource, StiOdbcSource, StiOleDbSource, StiOracleSource, StiPostgreSQLSource

public class StiSqlSource
extends StiDataTableSource

Describes the Data Source realizing access to Sql.

Field Summary

Fields inherited from class com.stimulsoft.report.dictionary.dataSources.StiDataSource

columns, columnsIndexs, connectionOrder, connectOnStart, detailRows, initForSubreport, RowToLevel

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiSqlSource()	Creates a new object of the type StiSqlSource.
StiSqlSource(String nameInSource, String name)	Creates a new object of the type StiSqlSource.
StiSqlSource(String nameInSource, String name, String alias)	Creates a new object of the type StiSqlSource.
StiSqlSource(String nameInSource, String name, String alias, String sqlCommand)	Creates a new object of the type StiSqlSource.
StiSqlSource(String nameInSource, String name, String alias, String sqlCommand, boolean connectOnStart)
StiSqlSource(String nameInSource, String name, String alias, String sqlCommand, boolean connectOnStart, boolean reconnectOnEachRow)
StiSqlSource(String nameInSource, String name, String alias, String sqlCommand, boolean connectOnStart, boolean reconnectOnEachRow, int commandTimeout)

Method Summary

Modifier and Type	Method	Description
final boolean	getAllowExpressions()	Gets or sets value which indicates that datasource can contain script expressions or no.
final int	getCommandTimeout()
boolean	getConnectOnStart()	Gets or sets value which indicates that datasource not connect to the data automatically.
String	getFinalSqlCommand()
StiSystemType	getNetType(int dbType)
StiDataParametersCollection	getParameters()	Gets or sets the parameter collection.
String	getQuery()
final boolean	getReconnectOnEachRow()	Gets or sets value which indicates that datasource reconnect on each master row in master-detail reports.
final String	getSqlCommand()	Gets or sets Transact-SQL statement to execute at the Data Source.
final StiSqlSourceType	getType()	Gets or sets value which indicates type of sql datasource.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setAllowExpressions(boolean value)
final void	setCommandTimeout(int value)
void	setConnectOnStart(boolean value)
void	setParameters(StiDataParametersCollection value)
final void	setReconnectOnEachRow(boolean value)
final void	setSqlCommand(String value)
final void	setType(StiSqlSourceType value)
void	UpdateParameters()

Methods inherited from class com.stimulsoft.report.dictionary.dataSources.StiDataTableSource

GetCategoryName, getDatabaseClass

Methods inherited from class com.stimulsoft.report.dictionary.dataSources.StiDataStoreSource

connect, connect, createNewTable, disconnect, getDataName, getNameInSource, getNameTableInSource, setDataName, setNameInSource

Methods inherited from class com.stimulsoft.report.dictionary.dataSources.StiDataSource

CheckColumnsIndexs, clearAllStates, ClearAllStates, clone, fetchParentRelations, First, get, get, getAlias, GetChildDataSource, GetChildRelations, GetColumnIndex, getColumns, GetConditions, getCount, getData, GetData, GetData, getDatabase, GetDataRow, getDataTable, getDictionary, getInherited, getIsBof, getIsConnected, getIsEmpty, getIsEof, getItem, getKey, GetLevel, getName, GetParentData, GetParentDataSource, GetParentRelations, getPosition, getPositionValue, getRealCount, getRelations, getRows, getStates, getVariableParameterByName, getVariableParameters, InvokeConnecting, InvokeDisconnecting, isEmpty, Last, Next, prepareData, Prior, ResetData, ResetDetailsRows, restoreState, RestoreState, saveState, setAlias, setColumns, setCorrectName, SetData, setDataTable, SetDetails, setDictionary, SetFilter, setInherited, setIsBof, setIsEof, setKey, setName, setPosition, setPositionValue, setRows, SetSort, setVariableParameters, size, toString

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Constructor Details

StiSqlSource

public StiSqlSource()

Creates a new object of the type StiSqlSource.

StiSqlSource

public StiSqlSource(String nameInSource,
 String name)

Creates a new object of the type StiSqlSource.

Parameters:

nameInSource - Name of Sql Connection in the DataStore.

name - Data Source name.

StiSqlSource

public StiSqlSource(String nameInSource,
 String name,
 String alias)

Creates a new object of the type StiSqlSource.

Parameters:

nameInSource - Name of Sql Connection in the DataStore.

name - Data Source name.

alias - Data Source alias.

StiSqlSource

public StiSqlSource(String nameInSource,
 String name,
 String alias,
 String sqlCommand)

Creates a new object of the type StiSqlSource.

Parameters:

nameInSource - Name of SqlConnection in the DataStore.

name - Data Source name.

alias - Data Source alias.

sqlCommand - SQL statement to execute at the Data Source.

StiSqlSource

public StiSqlSource(String nameInSource,
 String name,
 String alias,
 String sqlCommand,
 boolean connectOnStart)

StiSqlSource

public StiSqlSource(String nameInSource,
 String name,
 String alias,
 String sqlCommand,
 boolean connectOnStart,
 boolean reconnectOnEachRow)

StiSqlSource

public StiSqlSource(String nameInSource,
 String name,
 String alias,
 String sqlCommand,
 boolean connectOnStart,
 boolean reconnectOnEachRow,
 int commandTimeout)

Method Details

getConnectOnStart

public boolean getConnectOnStart()

Gets or sets value which indicates that datasource not connect to the data automatically.

Overrides:

getConnectOnStart in class StiDataSource

setConnectOnStart

public void setConnectOnStart(boolean value)

Overrides:

setConnectOnStart in class StiDataSource

getAllowExpressions

public final boolean getAllowExpressions()

Gets or sets value which indicates that datasource can contain script expressions or no.

setAllowExpressions

public final void setAllowExpressions(boolean value)

getType

public final StiSqlSourceType getType()

Gets or sets value which indicates type of sql datasource.

setType

public final void setType(StiSqlSourceType value)

getCommandTimeout

public final int getCommandTimeout()

setCommandTimeout

public final void setCommandTimeout(int value)

getReconnectOnEachRow

public final boolean getReconnectOnEachRow()

Gets or sets value which indicates that datasource reconnect on each master row in master-detail reports.

setReconnectOnEachRow

public final void setReconnectOnEachRow(boolean value)

getSqlCommand

public final String getSqlCommand()

Gets or sets Transact-SQL statement to execute at the Data Source.

setSqlCommand

public final void setSqlCommand(String value)

getParameters

public StiDataParametersCollection getParameters()

Description copied from class: StiDataSource

Gets or sets the parameter collection.

Overrides:

getParameters in class StiDataSource

setParameters

public void setParameters(StiDataParametersCollection value)

Overrides:

setParameters in class StiDataSource

UpdateParameters

public void UpdateParameters()

getQuery

public String getQuery()

Overrides:

getQuery in class StiDataStoreSource

getFinalSqlCommand

public String getFinalSqlCommand()

getNetType

public StiSystemType getNetType(int dbType)

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiDataTableSource

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiDataStoreSource

Throws:

JSONException