Class Hierarchy        Index

Class COM.cloudscape.database.PropertyInfo

java.lang.Object
   |
   +----COM.cloudscape.database.PropertyInfo

public class PropertyInfo
extends Object
Copyright © 1998-1999, Cloudscape, Inc. All rights reserved.

PropertyInfo is a class with static methods that:

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.


Variable Index

 o INDEX
 o TABLE

Constructor Index

 o PropertyInfo()
No-arg constructor.

Method Index

 o getConglomerateProperties(String, String, int)
Get the Properties associated with a given conglomerate
 o getControlInfo()
Get Cloudscape-specific control information
 o getDatabaseProperties()
Fetch the complete set of properties of the database of the current connection.
 o getDatabaseProperty(String)
Fetch the value of a property of the database on the current connection.
 o getIndexProperties(String, String)
Get the Properties associated with a given index.
 o getTableProperties(String, String)
Get the Properties associated with a given table.
 o setDatabaseProperty(String, String)
Set the value of a property of the database on the current connection.

Variables

 o TABLE
 protected static final int TABLE
 o INDEX
 protected static final int INDEX

Constructors

 o PropertyInfo
 public PropertyInfo()
No-arg constructor.

Methods

 o getTableProperties
 public static Properties getTableProperties(String schemaName,
                                             String tableName) throws StandardException
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: StandardException
on error
 o getIndexProperties
 public static Properties getIndexProperties(String schemaName,
                                             String indexName) throws StandardException
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: StandardException
on error
 o getDatabaseProperty
 public static String getDatabaseProperty(String key) throws StandardException
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: StandardException
on error
 o setDatabaseProperty
 public static void setDatabaseProperty(String key,
                                        String value) throws StandardException
Set the value of a property of the database on the current connection.

Parameters:
key - the property key
value - the new value
Throws: StandardException
on error
 o getDatabaseProperties
 public static Properties getDatabaseProperties() throws StandardException
Fetch the complete set of properties of the database of the current connection.

Returns:
a Properties object
Throws: StandardException
throw on error.
 o getControlInfo
 public int getControlInfo()
Get Cloudscape-specific control information

Returns:
control word
 o getConglomerateProperties
 protected Properties getConglomerateProperties(String schemaName,
                                                String conglomerateName,
                                                int conglomerateType) throws StandardException
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: StandardException
on error

  Class Hierarchy        Index