Class Hierarchy Previous Next Index
Class COM.cloudscape.database.PropertyInfo
java.lang.Object
|
+----COM.cloudscape.database.PropertyInfo
- public class PropertyInfo
- extends java.lang.Object
Copyright © 1998-2000, Informix Software, Inc. All rights reserved.
PropertyInfo is a class with static methods that:
- retrieve the properties associated with a table or index.
- set and retrieve properties associated with a database.
This class can only be used within an SQL-J statement. Using the methods
in application-side Java code results in Exceptions being thrown.
Cloudscape reserves the right to change, rename, or
remove this interface at any time.
INDEX-
TABLE-
PropertyInfo()
- No-arg constructor.
getConglomerateProperties(String, String, int)
- Get the Properties associated with a given conglomerate
getControlInfo()
- Get Cloudscape-specific control information
getDatabaseProperties()
- Fetch the complete set of properties of the database of the current connection.
getDatabaseProperty(String)
- Fetch the value of a property of the database on the current connection.
getIndexProperties(String, String)
- Get the Properties associated with a given index.
getTableProperties(String, String)
- Get the Properties associated with a given table.
setDatabaseProperty(String, String)
- Set the value of a property of the database on the current connection.
TABLE
protected static final int TABLE
INDEX
protected static final int INDEX
PropertyInfo
protected PropertyInfo()
No-arg constructor.
getTableProperties
public static java.util.Properties getTableProperties(java.lang.String schemaName,
java.lang.String tableName) throws java.sql.SQLException
Get the Properties associated with a given table.
- Parameters:
schemaName
- The name of the schema that the table is in.
tableName
- The name of the table.
- Returns:
- Properties The Properties associated with the specified table.
(An empty Properties is returned if the table does not exist.)
- Throws:
- java.sql.SQLException - on error
getIndexProperties
public static java.util.Properties getIndexProperties(java.lang.String schemaName,
java.lang.String indexName) throws java.sql.SQLException
Get the Properties associated with a given index.
- Parameters:
schemaName
- The name of the schema that the index is in.
indexName
- The name of the index.
- Returns:
- Properties The Properties associated with the specified index.
(An empty Properties is returned if the index does not exist.)
- Throws:
- java.sql.SQLException - on error
getDatabaseProperty
public static java.lang.String getDatabaseProperty(java.lang.String key) throws java.sql.SQLException
Fetch the value of a property of the database on the current connection.
- Parameters:
key
- the property key
- Returns:
- the value of the property or null if the property is not set.
- Throws:
- java.sql.SQLException - on error
setDatabaseProperty
public static void setDatabaseProperty(java.lang.String key,
java.lang.String value) throws java.sql.SQLException
Set the value of a property of the database on the current connection.
- Parameters:
key
- the property key
value
- the new value
- Throws:
- java.sql.SQLException - on error
getDatabaseProperties
public static java.util.Properties getDatabaseProperties() throws java.sql.SQLException
Fetch the complete set of properties of the database of the current connection.
- Returns:
- a Properties object
- Throws:
- java.sql.SQLException - throw on error.
getControlInfo
protected int getControlInfo()
Get Cloudscape-specific control information
- Returns:
- control word
getConglomerateProperties
protected java.util.Properties getConglomerateProperties(java.lang.String schemaName,
java.lang.String conglomerateName,
int conglomerateType) throws java.sql.SQLException
Get the Properties associated with a given conglomerate
- Parameters:
schemaName
- The name of the schema that the conglomerate is in.
conglomerateName
- The name of the conglomerate.
conglomerateType
- TABLE or INDEX.
- Returns:
- Properties The Properties associated with the specified conglomerate.
(An empty Properties is returned if the conglomerate does not exist.)
- Throws:
- java.sql.SQLException - on error
Class Hierarchy Previous Next Index