All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.filters.FilterBase

java.lang.Object
   |
   +----org.xmlmiddleware.xmldbms.filters.FilterBase

public class FilterBase
extends Object
Base class for RootFilter and ResultSetFilter; contains TableFilters. For internal use.

Version:
2.0
Author:
Ronald Bourret, 2001

Method Index

 o createTableFilter(String, String, String, String)
Create a filter for a class table.
 o getTableFilter(String, String, String, String)
Get a table filter.
 o getTableFilter(Table)
Get a table filter.
 o getTableFilters()
Gets an Enumeration of all the table filters.
 o removeAllTableFilters()
Remove the filters for all tables.
 o removeTableFilter(String, String, String, String)
Remove the filter for a table.

Methods

 o getTableFilter
 public final TableFilter getTableFilter(String databaseName,
                                         String catalogName,
                                         String schemaName,
                                         String tableName)
Get a table filter.

Parameters:
databaseName - Name of the database. If this is null, "Default" is used.
catalogName - Name of the catalog. May be null.
schemaName - Name of the schema. May be null.
tableName - Name of the table.
Returns:
The TableFilter. Null if no filter exists for the table.
 o getTableFilter
 public final TableFilter getTableFilter(Table table)
Get a table filter.

Parameters:
table - The Table
Returns:
The TableFilter. Null if no filter exists for the table.
 o getTableFilters
 public final Enumeration getTableFilters()
Gets an Enumeration of all the table filters.

Returns:
The Enumeration. May be empty.
 o createTableFilter
 public TableFilter createTableFilter(String databaseName,
                                      String catalogName,
                                      String schemaName,
                                      String tableName) throws XMLMiddlewareException
Create a filter for a class table.

Parameters:
databaseName - Name of the database. If this is null, "Default" is used.
catalogName - Name of the catalog. May be null.
schemaName - Name of the schema. May be null.
tableName - Name of the table.
Returns:
The TableFilter for the table.
Throws: XMLMiddlewareException
Thrown if a filter already exists for the table or the table is not mapped as a class table.
 o removeTableFilter
 public void removeTableFilter(String databaseName,
                               String catalogName,
                               String schemaName,
                               String tableName) throws XMLMiddlewareException
Remove the filter for a table.

Parameters:
databaseName - Name of the database. If this is null, "Default" is used.
catalogName - Name of the catalog. May be null.
schemaName - Name of the schema. May be null.
tableName - Name of the table.
Throws: XMLMiddlewareException
Thrown if no filter exists for the table.
 o removeAllTableFilters
 public void removeAllTableFilters()
Remove the filters for all tables.


All Packages  Class Hierarchy  This Package  Previous  Next  Index