All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.filters.TableFilter 

java.lang.Object
   |
   +----org.xmlmiddleware.xmldbms.filters.TableFilter
public class TableFilter
extends Object
A container for filters between a class table and child tables. For internal use.

Version:
2.0
Author:
Ronald Bourret, 2001

Method Index

o createRelatedTableFilter(String, String, String, String, String, String)
Create a filter for a related table.
o getRelatedTableFilter(PropertyTableMap)
Get the filter for a property table.
o getRelatedTableFilter(RelatedClassTableMap)
Get the filter for a related class table.
o getRelatedTableFilter(String, String, String, String, String, String)
Get the filter for a related table by name.
o getRelatedTableFilters()
Get the filters for all related tables.
o getTable()
Get the table to which the filter applies.
o removeAllRelatedTableFilters()
Remove all related table filters.
o removeRelatedTableFilter(String, String, String, String, String, String)
Remove a filter for a related table.

Methods

o getTable 
 public final Table getTable()
Get the table to which the filter applies.

Returns:
The table.
o getRelatedTableFilter 
 public final RelatedTableFilter getRelatedTableFilter(String databaseName,
                                                       String catalogName,
                                                       String schemaName,
                                                       String tableName,
                                                       String parentKeyName,
                                                       String childKeyName) throws XMLMiddlewareException
Get the filter for a related table by name.

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.
parentKeyName - Name of the parent key used to link the table and the related table. If the related table only appears once as a child of the parent table, this may be null.
childKeyName - Name of the child key used to link the table and the related table. If the related table only appears once as a child of the parent table, this may be null.
Returns:
The filter. May be null.
Throws: XMLMiddlewareException
Returned if the specified table is not related to the table that uses this TableFilter.
o getRelatedTableFilter 
 public final RelatedTableFilter getRelatedTableFilter(RelatedClassTableMap relatedClassTableMap)
Get the filter for a related class table.

Parameters:
relatedClassTableMap - RelatedClassTableMap that describes the related table.
Returns:
The filter. May be null.
o getRelatedTableFilter 
 public final RelatedTableFilter getRelatedTableFilter(PropertyTableMap propTableMap)
Get the filter for a property table.

Parameters:
propTableMap - PropertyTableMap that describes the related table.
Returns:
The filter. May be null.
o getRelatedTableFilters 
 public final Enumeration getRelatedTableFilters()
Get the filters for all related tables.

Returns:
An Enumeration of RelatedTableFilter objects. May be empty.
o createRelatedTableFilter 
 public RelatedTableFilter createRelatedTableFilter(String databaseName,
                                                    String catalogName,
                                                    String schemaName,
                                                    String tableName,
                                                    String parentKeyName,
                                                    String childKeyName) throws XMLMiddlewareException
Create a filter for a related 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.
parentKeyName - Name of the parent key used to link the table and the related table. If the related table only appears once as a child of the parent table, this may be null.
childKeyName - Name of the child key used to link the table and the related table. If the related table only appears once as a child of the parent table, this may be null.
Returns:
The filter
Throws: XMLMiddlewareException
Returned if the filter already exists or the specified table is not related to the table that uses this TableFilter.
o removeRelatedTableFilter 
 public void removeRelatedTableFilter(String databaseName,
                                      String catalogName,
                                      String schemaName,
                                      String tableName,
                                      String parentKeyName,
                                      String childKeyName) throws XMLMiddlewareException
Remove a filter for a related 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.
parentKeyName - Name of the parent key used to link the table and the related table. If the related table only appears once as a child of the parent table, this may be null.
childKeyName - Name of the child key used to link the table and the related table. If the related table only appears once as a child of the parent table, this may be null.
Throws: XMLMiddlewareException
Returned if the filter does not exist.
o removeAllRelatedTableFilters 
 public void removeAllRelatedTableFilters()
Remove all related table filters. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index