Package 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, ICloneable, IStiAlias, IStiInherited, Cloneable

Direct Known Subclasses:

ChildDatabase, ParentDatabase, StiDatabaseEmpty, StiFileDatabase, StiJDBCDatabase, StiNoSqlDatabase

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

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	Description
StiDatabase()	Creates a new object of the type StiDatabase.
StiDatabase(String name)	Creates a new object of the type StiDatabase.
StiDatabase(String name, String alias)	Creates a new object of the type StiDatabase.

Method Summary

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

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

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 Details

StiDatabase

public StiDatabase()

Creates a new object of the type StiDatabase.

StiDatabase

public StiDatabase(String name)

Creates a new object of the type StiDatabase.

Parameters:

name - Name of database.

StiDatabase

public StiDatabase(String name,
 String alias)

Creates a new object of the type StiDatabase.

Parameters:

name - Name of database.

alias - Alias of database.

Method Details

clone

public Object clone()

Description copied from class: StiService

Creates a new object that is a copy of the current instance.

Specified by:

clone in interface ICloneable

Overrides:

clone in class StiService

Returns:

A new object that is a copy of this instance.

createDataSources

public void createDataSources(StiDictionary dictionary)
                       throws Exception

Throws:

Exception

invokeConnecting

public void invokeConnecting()

invokeConnected

public void invokeConnected()

invokeDisconnecting

public void invokeDisconnecting()

invokeDisconnected

public void invokeDisconnected()

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 String getKey()

Returns:

the key

setKey

public void setKey(String key)

Parameters:

key - the key to set

getServiceCategory

public final 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(EventArgs 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(EventArgs 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(EventArgs 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 String getName()

Gets or sets name of database.

Specified by:

getName in interface IStiName

setName

public final void setName(String value)

Specified by:

setName in interface IStiName

getAlias

public final String getAlias()

Gets or sets alias of database.

Specified by:

getAlias in interface IStiAlias

setAlias

public final void setAlias(String value)

Specified by:

setAlias in interface IStiAlias

getDatabaseInformation

public StiDatabaseInformation getDatabaseInformation(Connection con,
 StiAbstractAdapter adapter,
 StiReport report)
                                              throws Exception

Throws:

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 Class<?> getServiceType()

Description copied from class: StiService

Gets a service type.

Specified by:

getServiceType in class StiService

connect

public void connect(StiDataStoreSource source,
 StiReport report)
             throws StiException

Throws:

StiException

connect

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

Throws:

StiException

disconnect

public abstract void disconnect()

getServiceName

public String getServiceName()

Description copied from class: StiService

Gets a service name.

Overrides:

getServiceName in class StiService

toString

public String toString()

Overrides:

toString in class Object

getString

public String getString()

parsePath

protected String parsePath(String path,
 StiReport report)

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