com.stimulsoft.report.dictionary.databases

Class StiDatabase

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.dictionary.databases.StiDatabase

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiInherited, java.lang.Cloneable

Direct Known Subclasses:

StiDatabaseEmpty, StiJDBCDatabase, StiJsonDatabase, StiXmlDatabase

public abstract class StiDatabase
extends StiService
implements IStiInherited, IStiName, IStiJsonReportObject

Field Summary

Fields inherited from class com.stimulsoft.base.services.StiService

properties

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

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiDatabase() Creates a new object of the type StiDatabase.
StiDatabase(java.lang.String name) Creates a new object of the type StiDatabase.
StiDatabase(java.lang.String name, java.lang.String alias) Creates a new object of the type StiDatabase.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDatabaseInformation(StiDatabaseInformation info, StiReport report, StiDatabaseInformation allInfo)
abstract void	connect(StiDataStoreSource source, java.lang.Boolean fillTable, StiReport report)
abstract void	connect(StiDataStoreSource stiDataStoreSource, StiReport report)
void	createDataSources(StiDictionary dictionary)
abstract void	disconnect()
int	edit(boolean newDatabase) Calls the form for database edition.
java.lang.String	getAlias() Gets or sets alias of database.
StiConnectedEvent	getConnectedEvent() Occurs when connection is activated.
StiConnectingEvent	getConnectingEvent() Occurs when connection is activating.
StiDatabaseInformation	getDatabaseInformation(java.sql.Connection con, StiAbstractAdapter adapter, StiReport report)
StiDisconnectedEvent	getDisconnectedEvent() Occurs when connection is deactivated.
StiDisconnectingEvent	getDisconnectingEvent() Occurs when connection is deactivating.
boolean	getInherited()
java.lang.String	getKey()
java.lang.String	getName() Gets or sets name of database.
java.lang.String	getServiceCategory() Gets a service category.
java.lang.String	getServiceName()
java.lang.Class<?>	getServiceType()
java.lang.String	getString()
void	LoadFromJsonObject(JSONObject jObject)
protected void	onConnected(StiEventHandlerArgs e) Raises the Connected event for this component.
protected void	onDisconnected(StiEventHandlerArgs e) Raises the Disconnected event for this connection.
protected void	onDisconnecting(StiEventHandlerArgs e) Raises the Disconnecting event for this connection.
void	regData(StiDictionary dictionary, boolean loadData) Registers the database in dictionary.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAlias(java.lang.String value)
void	setConnectedEvent(StiConnectedEvent value)
void	setConnectingEvent(StiConnectingEvent value)
void	setDisconnectedEvent(StiDisconnectedEvent value)
void	setDisconnectingEvent(StiDisconnectingEvent value)
void	setInherited(boolean value)
void	setKey(java.lang.String key)
void	setName(java.lang.String value)
java.lang.String	toString()

Methods inherited from class com.stimulsoft.base.services.StiService

clone, getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, packService, properties, setProperties, setServiceEnabled

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

Constructor Detail

StiDatabase

public StiDatabase()

Creates a new object of the type StiDatabase.

StiDatabase

public StiDatabase(java.lang.String name)

Creates a new object of the type StiDatabase.

Parameters:

name - Name of database.

StiDatabase

public StiDatabase(java.lang.String name,
           java.lang.String alias)

Creates a new object of the type StiDatabase.

Parameters:

name - Name of database.

alias - Alias of database.

Method Detail

createDataSources

public void createDataSources(StiDictionary dictionary)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getInherited

public final boolean getInherited()

Specified by:

getInherited in interface IStiInherited

setInherited

public final void setInherited(boolean value)

Specified by:

setInherited in interface IStiInherited

getKey

public java.lang.String getKey()

Returns:

the key

setKey

public void setKey(java.lang.String key)

Parameters:

key - the key to set

getServiceCategory

public final java.lang.String getServiceCategory()

Gets a service category.

Overrides:

getServiceCategory in class StiService

getConnectingEvent

public final StiConnectingEvent getConnectingEvent()

Occurs when connection is activating.

setConnectingEvent

public final void setConnectingEvent(StiConnectingEvent value)

onConnected

protected void onConnected(StiEventHandlerArgs e)

Raises the Connected event for this component.

getConnectedEvent

public final StiConnectedEvent getConnectedEvent()

Occurs when connection is activated.

setConnectedEvent

public final void setConnectedEvent(StiConnectedEvent value)

onDisconnecting

protected void onDisconnecting(StiEventHandlerArgs e)

Raises the Disconnecting event for this connection.

getDisconnectingEvent

public final StiDisconnectingEvent getDisconnectingEvent()

Occurs when connection is deactivating.

setDisconnectingEvent

public final void setDisconnectingEvent(StiDisconnectingEvent value)

onDisconnected

protected void onDisconnected(StiEventHandlerArgs e)

Raises the Disconnected event for this connection.

getDisconnectedEvent

public final StiDisconnectedEvent getDisconnectedEvent()

Occurs when connection is deactivated.

setDisconnectedEvent

public final void setDisconnectedEvent(StiDisconnectedEvent value)

getName

public final java.lang.String getName()

Gets or sets name of database.

Specified by:

getName in interface IStiName

setName

public final void setName(java.lang.String value)

Specified by:

setName in interface IStiName

getAlias

public final java.lang.String getAlias()

Gets or sets alias of database.

setAlias

public final void setAlias(java.lang.String value)

getDatabaseInformation

public StiDatabaseInformation getDatabaseInformation(java.sql.Connection con,
                                            StiAbstractAdapter adapter,
                                            StiReport report)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

applyDatabaseInformation

public void applyDatabaseInformation(StiDatabaseInformation info,
                            StiReport report,
                            StiDatabaseInformation allInfo)

edit

public int edit(boolean newDatabase)

Calls the form for database edition.

Parameters:

newDatabase -

Returns:

Result of editing.

regData

public void regData(StiDictionary dictionary,
           boolean loadData)

Registers the database in dictionary.

Parameters:

dictionary - Dictionary in which is registered database.

loadData - Load the data or no.

getServiceType

public java.lang.Class<?> getServiceType()

Specified by:

getServiceType in class StiService

connect

public abstract void connect(StiDataStoreSource stiDataStoreSource,
           StiReport report)
                      throws StiException

Throws:

StiException

connect

public abstract void connect(StiDataStoreSource source,
           java.lang.Boolean fillTable,
           StiReport report)
                      throws StiException

Throws:

StiException

disconnect

public abstract void disconnect()

getServiceName

public java.lang.String getServiceName()

Overrides:

getServiceName in class StiService

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getString

public java.lang.String getString()

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException