ThinkUI SQL Client 1.1.3 API

thinkui.sqlclient
Class SQLClientPreferences

java.lang.Object
  extended bythinkui.common.ApplicationPreferences
      extended bythinkui.sqlclient.SQLClientPreferences

public class SQLClientPreferences
extends thinkui.common.ApplicationPreferences

Encapsulate the user's SQLClient preferences. The preferences are loaded from the application configuration and can be customized on a per user basis using the "Preferences" API.


Field Summary
static Attribute AUTHOR_NAME_ATTR
           
static Attribute CODE_GEN_DIR_ATTR
           
static Attribute DB_DIR_ATTR
           
static Attribute HEADER_TEXT_ATTR
           
static Attribute INSTALLED_DIR_ATTR
           
static Attribute INSTRUCTIONS_ATTR
           
static Attribute LOAD_META_DATA_ATTR
           
static Attribute LOAD_RELATED_DATA_ATTR
           
static Attribute LOGIN_TIMEOUT_ATTR
           
static Attribute MAX_BLOB_ATTR
           
static Attribute MAX_CLOB_ATTR
           
static Attribute MAX_RELATIONSHIPS_ATTR
           
static Attribute MAX_ROWS_ATTR
           
static Attribute PACKAGE_PREFIX_ATTR
           
static Attribute PROJECT_NAME_ATTR
           
static Attribute PROMPT_ON_EXIT_ATTR
           
static Attribute QUERY_TIMEOUT_ATTR
           
static Attribute SAVE_QUERY_HISTORY_ATTR
           
static Attribute SEQUENCE_START_VALUE_ATTR
           
static Attribute SHOW_RELATIONSHIPS_ATTR
           
static Attribute SHOW_SYSTEM_SCHEMA_ATTR
           
static Attribute TARGET_DATABASE_ATTR
           
static Attribute TEMPLATE_DIR_ATTR
           
static Attribute WELCOME_ATTR
           
 
Fields inherited from class thinkui.common.ApplicationPreferences
LOG_CONFIG_ATTR, LOG_DEBUG_ATTR, LOG_ERROR_ATTR, LOG_FATAL_ATTR, LOG_MESSAGE_ATTR, LOG_SQL_ATTR, LOG_TRACE_ATTR, LOG_WARNING_ATTR
 
Constructor Summary
SQLClientPreferences()
          SQLClientConfiguration constructor.
 
Method Summary
 void deletePreferences()
          Delete the "sqlclient" nodes from the user preference registry.
 java.io.File getApplicationInstalledDir()
           
 java.lang.String getApplicationInstalledVersion()
           
 java.lang.String getApplicationLicenseKey()
           
 java.lang.String getApplicationLicenseOwner()
           
 java.lang.String getAuthorName()
           
 java.io.File getBatchPathDir()
           
 java.io.File getCodeGenPathDir()
           
 java.io.File getDbPathDir()
           
 java.io.File getDocPathDir()
           
 java.lang.String getHeaderText()
           
 java.io.File getLibPathDir()
           
 int getLoginTimeout()
           
 int getMaxBlobSize()
           
 int getMaxClobSize()
           
 int getMaxRelationships()
           
 int getMaxRows()
           
 java.lang.String getPackagePrefix()
           
 java.lang.String getProjectName()
           
 int getQueryTimeout()
           
 long getSequenceStartValue()
           
 java.lang.String getSQLClientPassword()
           
 java.lang.String getSQLClientUserName()
           
 java.lang.String getTargetDatabase()
           
 java.io.File getTemplatePathDir()
           
 boolean isLoadMetaData()
           
 boolean isLoadRelatedData()
           
 boolean isSaveQueryHistory()
           
 boolean isShowRelationships()
           
 boolean isShowSystemSchema()
           
 boolean isSQLClientWelcome()
           
 boolean isSQLQueryInstructions()
           
 boolean isUseBackgroundThreads()
           
 void loadPreferences(thinkui.config.Config config)
          Load the properties from the user preference.
 void savePreferences()
          Save the properties to the user preference registry.
 void setApplicationInstalledDir(java.io.File sqlClientInstalledDir)
           
 void setApplicationInstalledVersion(java.lang.String sqlClientInstalledVersion)
           
 void setApplicationLicenseKey(java.lang.String sqlClientLicenseKey)
           
 void setApplicationLicenseOwner(java.lang.String sqlClientLicenseOwner)
           
 void setAuthorName(java.lang.String authorName)
           
 void setCodeGenPathDir(java.io.File codeGenDir)
          Set the path to the SQL Client code generation directory.
 void setDbPathDir(java.io.File dbDir)
          Set the path to the SQL Client database directory.
 void setHeaderText(java.lang.String headerText)
           
 void setLoadMetaData(boolean loadMetaData)
           
 void setLoadRelatedData(boolean loadRelatedData)
           
 void setLoginTimeout(int loginTimeout)
           
 void setMaxBlobSize(int maxBlobSize)
           
 void setMaxClobSize(int maxClobSize)
           
 void setMaxRelationships(int maxRelationships)
           
 void setMaxRows(int maxRows)
           
 void setPackagePrefix(java.lang.String packagePrefix)
           
 void setProjectName(java.lang.String projectName)
           
 void setQueryTimeout(int queryTimeout)
           
 void setSaveQueryHistory(boolean saveQueryHistory)
           
 void setSequenceStartValue(long sequenceStartValue)
           
 void setShowRelationships(boolean showRelationships)
           
 void setShowSystemSchema(boolean showSystemSchema)
           
 void setSQLClientPassword(java.lang.String sqlClientPassword)
           
 void setSQLClientUserName(java.lang.String sqlClientUserName)
           
 void setSQLClientWelcome(boolean sqlClientWelcome)
           
 void setSQLQueryInstructions(boolean sqlQueryInstructions)
           
 void setTargetDatabase(java.lang.String targetDatabase)
           
 void setTemplatePathDir(java.io.File templateDir)
          Set the path to the SQL Client template directory.
 void setUseBackgroundThreads(boolean useBackgroundThreads)
           
 
Methods inherited from class thinkui.common.ApplicationPreferences
getBoldFont, getLegendFont, getLnFClassName, getMessageFont, getMonospacedFont, getNormalFont, isAboutBox, isCodeGenMode, isDataEntryMode, isDebugMode, isLogConfig, isLogDebug, isLogError, isLogFatal, isLogMessage, isLogSQL, isLogTrace, isLogWarning, isPromptOnExit, isUseRegistry, isUserMode, setAboutBox, setBoldFont, setCodeGenMode, setDataEntryMode, setDebugMode, setLegendFont, setLnFClassName, setLogConfig, setLogDebug, setLogError, setLogFatal, setLogMessage, setLogSQL, setLogTrace, setLogWarning, setMessageFont, setMonospacedFont, setNormalFont, setPromptOnExit, setUseRegistry, setUserMode
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AUTHOR_NAME_ATTR

public static final Attribute AUTHOR_NAME_ATTR

CODE_GEN_DIR_ATTR

public static final Attribute CODE_GEN_DIR_ATTR

DB_DIR_ATTR

public static final Attribute DB_DIR_ATTR

HEADER_TEXT_ATTR

public static final Attribute HEADER_TEXT_ATTR

INSTALLED_DIR_ATTR

public static final Attribute INSTALLED_DIR_ATTR

INSTRUCTIONS_ATTR

public static final Attribute INSTRUCTIONS_ATTR

LOAD_META_DATA_ATTR

public static final Attribute LOAD_META_DATA_ATTR

LOAD_RELATED_DATA_ATTR

public static final Attribute LOAD_RELATED_DATA_ATTR

LOGIN_TIMEOUT_ATTR

public static final Attribute LOGIN_TIMEOUT_ATTR

MAX_BLOB_ATTR

public static final Attribute MAX_BLOB_ATTR

MAX_CLOB_ATTR

public static final Attribute MAX_CLOB_ATTR

MAX_RELATIONSHIPS_ATTR

public static final Attribute MAX_RELATIONSHIPS_ATTR

MAX_ROWS_ATTR

public static final Attribute MAX_ROWS_ATTR

PACKAGE_PREFIX_ATTR

public static final Attribute PACKAGE_PREFIX_ATTR

PROJECT_NAME_ATTR

public static final Attribute PROJECT_NAME_ATTR

PROMPT_ON_EXIT_ATTR

public static final Attribute PROMPT_ON_EXIT_ATTR

QUERY_TIMEOUT_ATTR

public static final Attribute QUERY_TIMEOUT_ATTR

SAVE_QUERY_HISTORY_ATTR

public static final Attribute SAVE_QUERY_HISTORY_ATTR

SEQUENCE_START_VALUE_ATTR

public static final Attribute SEQUENCE_START_VALUE_ATTR

SHOW_RELATIONSHIPS_ATTR

public static final Attribute SHOW_RELATIONSHIPS_ATTR

SHOW_SYSTEM_SCHEMA_ATTR

public static final Attribute SHOW_SYSTEM_SCHEMA_ATTR

TARGET_DATABASE_ATTR

public static final Attribute TARGET_DATABASE_ATTR

TEMPLATE_DIR_ATTR

public static final Attribute TEMPLATE_DIR_ATTR

WELCOME_ATTR

public static final Attribute WELCOME_ATTR
Constructor Detail

SQLClientPreferences

public SQLClientPreferences()
SQLClientConfiguration constructor.

Method Detail

deletePreferences

public final void deletePreferences()
                             throws java.lang.Exception
Delete the "sqlclient" nodes from the user preference registry.

Throws:
java.lang.Exception

getApplicationInstalledDir

public final java.io.File getApplicationInstalledDir()

getApplicationInstalledVersion

public final java.lang.String getApplicationInstalledVersion()

getApplicationLicenseKey

public final java.lang.String getApplicationLicenseKey()

getApplicationLicenseOwner

public final java.lang.String getApplicationLicenseOwner()

getAuthorName

public final java.lang.String getAuthorName()

getBatchPathDir

public final java.io.File getBatchPathDir()
Returns:
the path to the SQL Client batch directory.

getCodeGenPathDir

public final java.io.File getCodeGenPathDir()
Returns:
the path to the SQL Client code generation directory.

getDbPathDir

public final java.io.File getDbPathDir()
Returns:
the path to the SQL Client database directory.

getDocPathDir

public final java.io.File getDocPathDir()
Returns:
the path to the SQL Client documentation directory.

getHeaderText

public final java.lang.String getHeaderText()

getLibPathDir

public final java.io.File getLibPathDir()
Returns:
the path to the SQL Client lib directory.

getLoginTimeout

public final int getLoginTimeout()

getMaxBlobSize

public final int getMaxBlobSize()

getMaxClobSize

public final int getMaxClobSize()

getMaxRelationships

public final int getMaxRelationships()

getMaxRows

public final int getMaxRows()

getPackagePrefix

public final java.lang.String getPackagePrefix()

getProjectName

public final java.lang.String getProjectName()

getQueryTimeout

public final int getQueryTimeout()

getSequenceStartValue

public final long getSequenceStartValue()

getSQLClientPassword

public final java.lang.String getSQLClientPassword()

getSQLClientUserName

public final java.lang.String getSQLClientUserName()

getTargetDatabase

public final java.lang.String getTargetDatabase()

getTemplatePathDir

public final java.io.File getTemplatePathDir()
Returns:
the path to the SQL Client template directory.

isLoadMetaData

public final boolean isLoadMetaData()

isLoadRelatedData

public final boolean isLoadRelatedData()

isSaveQueryHistory

public final boolean isSaveQueryHistory()

isShowRelationships

public final boolean isShowRelationships()

isShowSystemSchema

public final boolean isShowSystemSchema()

isSQLClientWelcome

public final boolean isSQLClientWelcome()

isSQLQueryInstructions

public final boolean isSQLQueryInstructions()

isUseBackgroundThreads

public final boolean isUseBackgroundThreads()

loadPreferences

public final void loadPreferences(thinkui.config.Config config)
                           throws java.lang.Exception
Load the properties from the user preference. If a preference has not been set, use the default value from the config properties.

Throws:
java.lang.Exception

savePreferences

public final void savePreferences()
                           throws java.lang.Exception
Save the properties to the user preference registry.

Throws:
java.lang.Exception

setApplicationInstalledDir

public final void setApplicationInstalledDir(java.io.File sqlClientInstalledDir)

setApplicationInstalledVersion

public final void setApplicationInstalledVersion(java.lang.String sqlClientInstalledVersion)

setApplicationLicenseKey

public final void setApplicationLicenseKey(java.lang.String sqlClientLicenseKey)

setApplicationLicenseOwner

public final void setApplicationLicenseOwner(java.lang.String sqlClientLicenseOwner)

setAuthorName

public final void setAuthorName(java.lang.String authorName)

setCodeGenPathDir

public final void setCodeGenPathDir(java.io.File codeGenDir)
Set the path to the SQL Client code generation directory.


setDbPathDir

public final void setDbPathDir(java.io.File dbDir)
Set the path to the SQL Client database directory.


setHeaderText

public final void setHeaderText(java.lang.String headerText)

setLoadMetaData

public final void setLoadMetaData(boolean loadMetaData)

setLoadRelatedData

public final void setLoadRelatedData(boolean loadRelatedData)

setLoginTimeout

public final void setLoginTimeout(int loginTimeout)

setMaxBlobSize

public final void setMaxBlobSize(int maxBlobSize)

setMaxClobSize

public final void setMaxClobSize(int maxClobSize)

setMaxRelationships

public final void setMaxRelationships(int maxRelationships)

setMaxRows

public final void setMaxRows(int maxRows)

setPackagePrefix

public final void setPackagePrefix(java.lang.String packagePrefix)

setProjectName

public final void setProjectName(java.lang.String projectName)

setQueryTimeout

public final void setQueryTimeout(int queryTimeout)

setSaveQueryHistory

public final void setSaveQueryHistory(boolean saveQueryHistory)

setSequenceStartValue

public final void setSequenceStartValue(long sequenceStartValue)

setShowRelationships

public final void setShowRelationships(boolean showRelationships)

setShowSystemSchema

public final void setShowSystemSchema(boolean showSystemSchema)

setSQLClientPassword

public final void setSQLClientPassword(java.lang.String sqlClientPassword)

setSQLClientUserName

public final void setSQLClientUserName(java.lang.String sqlClientUserName)

setSQLClientWelcome

public final void setSQLClientWelcome(boolean sqlClientWelcome)

setSQLQueryInstructions

public final void setSQLQueryInstructions(boolean sqlQueryInstructions)

setTargetDatabase

public final void setTargetDatabase(java.lang.String targetDatabase)

setTemplatePathDir

public final void setTemplatePathDir(java.io.File templateDir)
Set the path to the SQL Client template directory.


setUseBackgroundThreads

public final void setUseBackgroundThreads(boolean useBackgroundThreads)

ThinkUI SQL Client 1.1.3 API

Copyright © 2007-2009. ThinkUI Software Inc. All rights reserved.