com.aspose.cells

Class DBConnection

public class DBConnection 
extends ExternalConnection

Specifies all properties associated with an ODBC or OLE DB external data connection.

Property Getters/Setters Summary
booleangetBackgroundRefresh()
void
setBackgroundRefresh(booleanvalue)
Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground.
java.lang.StringgetCommand()
void
setCommand(java.lang.Stringvalue)
The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
intgetCommandType()
void
setCommandType(intvalue)
Specifies the OLE DB command type. 1. Query specifies a cube name 2. Query specifies a SQL statement 3. Query specifies a table name 4. Query specifies that default information has been given, and it is up to the provider how to interpret. 5. Query is against a web based List Data Provider. The value of the property is OLEDBCommandType integer constant.
java.lang.StringgetConnectionDescription()
void
setConnectionDescription(java.lang.Stringvalue)
Specifies the user description for this connection
intgetConnectionId()
Specifies The unique identifier of this connection.
java.lang.StringgetConnectionInfo()
void
setConnectionInfo(java.lang.Stringvalue)
The connection information string is used to make contact with an OLE DB or ODBC data source.
intgetCredentials()
void
setCredentials(intvalue)
Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.
intgetId()
Gets the id of the connection.
booleanisDeleted()
void
setDeleted(booleanvalue)
Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
booleanisNew()
void
setNew(booleanvalue)
True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning.
booleangetKeepAlive()
void
setKeepAlive(booleanvalue)
True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information.
java.lang.StringgetName()
void
setName(java.lang.Stringvalue)
Specifies the name of the connection. Each connection must have a unique name.
java.lang.StringgetOdcFile()
void
setOdcFile(java.lang.Stringvalue)
Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook.
booleangetOnlyUseConnectionFile()
void
Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute
ConnectionParameterCollectiongetParameters()
Gets ConnectionParameterCollection for an ODBC or web query.
intgetReConnectionMethod()
void
Specifies what the spreadsheet application should do when a connection fails.The default value is ReConnectionMethodType.Required. The value of the property is ReConnectionMethodType integer constant.
intgetRefreshInternal()
void
Specifies the number of minutes between automatic refreshes of the connection.
booleangetRefreshOnLoad()
True if this connection should be refreshed when opening the file; otherwise, false.
booleangetSaveData()
void
setSaveData(booleanvalue)
True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
booleangetSavePassword()
void
setSavePassword(booleanvalue)
True if the password is to be saved as part of the connection string; otherwise, False.
java.lang.StringgetSourceFile()
void
setSourceFile(java.lang.Stringvalue)
Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation.
java.lang.StringgetSSOId()
void
setSSOId(java.lang.Stringvalue)
Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
intgetType()
void
setType(intvalue)
Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.
 

    • Property Getters/Setters Detail

      • getConnectionInfo/setConnectionInfo

        public java.lang.String getConnectionInfo() / public void setConnectionInfo(java.lang.String value)
        
        The connection information string is used to make contact with an OLE DB or ODBC data source.
      • getCommandType/setCommandType

        public int getCommandType() / public void setCommandType(int value)
        
        Specifies the OLE DB command type. 1. Query specifies a cube name 2. Query specifies a SQL statement 3. Query specifies a table name 4. Query specifies that default information has been given, and it is up to the provider how to interpret. 5. Query is against a web based List Data Provider. The value of the property is OLEDBCommandType integer constant.
      • getCommand/setCommand

        public java.lang.String getCommand() / public void setCommand(java.lang.String value)
        
        The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
      • getId

        public int getId()
        
        Gets the id of the connection.
      • getType/setType

        public int getType() / public void setType(int value)
        
        Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.
      • getSourceFile/setSourceFile

        public java.lang.String getSourceFile() / public void setSourceFile(java.lang.String value)
        
        Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation.
      • getSSOId/setSSOId

        public java.lang.String getSSOId() / public void setSSOId(java.lang.String value)
        
        Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
      • getSavePassword/setSavePassword

        public boolean getSavePassword() / public void setSavePassword(boolean value)
        
        True if the password is to be saved as part of the connection string; otherwise, False.
      • getSaveData/setSaveData

        public boolean getSaveData() / public void setSaveData(boolean value)
        
        True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
      • getRefreshOnLoad

        public boolean getRefreshOnLoad()
        
        True if this connection should be refreshed when opening the file; otherwise, false.
      • getReConnectionMethod/setReConnectionMethod

        public int getReConnectionMethod() / public void setReConnectionMethod(int value)
        
        Specifies what the spreadsheet application should do when a connection fails.The default value is ReConnectionMethodType.Required. The value of the property is ReConnectionMethodType integer constant.
      • getOnlyUseConnectionFile/setOnlyUseConnectionFile

        public boolean getOnlyUseConnectionFile() / public void setOnlyUseConnectionFile(boolean value)
        
        Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute
      • getOdcFile/setOdcFile

        public java.lang.String getOdcFile() / public void setOdcFile(java.lang.String value)
        
        Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook.
      • isNew/setNew

        public boolean isNew() / public void setNew(boolean value)
        
        True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning.
      • getName/setName

        public java.lang.String getName() / public void setName(java.lang.String value)
        
        Specifies the name of the connection. Each connection must have a unique name.
      • getKeepAlive/setKeepAlive

        public boolean getKeepAlive() / public void setKeepAlive(boolean value)
        
        True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information.
      • getRefreshInternal/setRefreshInternal

        public int getRefreshInternal() / public void setRefreshInternal(int value)
        
        Specifies the number of minutes between automatic refreshes of the connection.
      • getConnectionId

        public int getConnectionId()
        
        Specifies The unique identifier of this connection.
      • getConnectionDescription/setConnectionDescription

        public java.lang.String getConnectionDescription() / public void setConnectionDescription(java.lang.String value)
        
        Specifies the user description for this connection
      • isDeleted/setDeleted

        public boolean isDeleted() / public void setDeleted(boolean value)
        
        Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
      • getCredentials/setCredentials

        public int getCredentials() / public void setCredentials(int value)
        
        Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.
      • getBackgroundRefresh/setBackgroundRefresh

        public boolean getBackgroundRefresh() / public void setBackgroundRefresh(boolean value)
        
        Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground.