com.pega.pegarules.pub.database

Interface DatabaseTable

public interface DatabaseTable

Contains information about a database table.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	TABLE_TYPE_TABLE A table type of 'TABLE'
static java.lang.String	TABLE_TYPE_VIEW A table type of 'VIEW'
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogName() Returns the catalog name for this database table;
java.lang.String	getDBName() Gets the name of the database.
java.lang.String	getFullyQualifiedTableName() Returns the fully qualified table name of this database table.
java.lang.String	getSchemaName() Deprecated. Instead use getSchemaNameForTable()
java.lang.String	getSchemaNameForTable() Returns the value of the pySchemaName property of this Data-Admin-DB-Table instance.
java.lang.String	getTableName() Returns the table name of this database table.
java.lang.String	getTableType() Returns the table type for this database table;
boolean	hasStream() Indicates whether this database table have a stream column?
boolean	isTable() Indicates whether or not the database table is a table (as opposed to a view or something else).
boolean	isView() Indicates whether or not the database table is a view (as opposed to a table or something else).

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

TABLE_TYPE_TABLE

static final java.lang.String TABLE_TYPE_TABLE

A table type of 'TABLE'

See Also:

Constant Field Values

TABLE_TYPE_VIEW

static final java.lang.String TABLE_TYPE_VIEW

A table type of 'VIEW'

See Also:

Constant Field Values

Method Detail

getCatalogName

java.lang.String getCatalogName()

Returns the catalog name for this database table;

Returns:

The catalog name.

getSchemaName

java.lang.String getSchemaName()

Deprecated. Instead use getSchemaNameForTable()

Returns the value of the pySchemaName property of this Data-Admin-DB-Table instance.

Returns:

The schema name as configured by the Database Table instance.

getSchemaNameForTable

java.lang.String getSchemaNameForTable()
                                throws DatabaseException

Returns the value of the pySchemaName property of this Data-Admin-DB-Table instance.

Returns:

The schema name as configured by the Database Table instance.

Throws:

DatabaseException - If the obtaining the schema name using the vendor specific query fails.

getDBName

java.lang.String getDBName()

Gets the name of the database.

Returns:

the name of the database

getTableName

java.lang.String getTableName()

Returns the table name of this database table.

Returns:

The table name.

getFullyQualifiedTableName

java.lang.String getFullyQualifiedTableName()

Returns the fully qualified table name of this database table.

Returns:

The fully qualified table name.

getTableType

java.lang.String getTableType()

Returns the table type for this database table;

Returns:

The table type.

isTable

boolean isTable()
         throws ConfigurationException,
                DatabaseException

Indicates whether or not the database table is a table (as opposed to a view or something else).

Returns:

True if this database table is a table.

Throws:

ConfigurationException

DatabaseException

isView

boolean isView()
        throws ConfigurationException,
               DatabaseException

Indicates whether or not the database table is a view (as opposed to a table or something else).

Returns:

True if this database table is a table.

Throws:

ConfigurationException

DatabaseException

hasStream

boolean hasStream()
           throws ConfigurationException,
                  DatabaseException

Indicates whether this database table have a stream column?

Returns:

True if it has a valid stream column

Throws:

ConfigurationException

DatabaseException