All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.filters.RootFilter

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

public class RootFilter
extends FilterBase
A filter to retrieve a document fragment based on a condition on a root table. For internal use.

Version:
2.0
Author:
Ronald Bourret, 2001

Method Index

 o createRootFilterConditions(String, String, String, String)
Create the root filter conditions.
 o createRootFilterConditions(Table)
Create the root filter conditions.
 o getRootFilterConditions()
Get the root filter conditions.

Methods

 o getRootFilterConditions
 public final FilterConditions getRootFilterConditions()
Get the root filter conditions.

Returns:
The root filter conditions
 o createRootFilterConditions
 public FilterConditions createRootFilterConditions(String databaseName,
                                                    String catalogName,
                                                    String schemaName,
                                                    String tableName) throws XMLMiddlewareException
Create the root filter conditions.

If a root filter conditions already exist, they are overwritten.

Parameters:
databaseName - Name of the root database. If this is null, "Default" is used.
catalogName - Name of the root catalog. May be null.
schemaName - Name of the root schema. May be null.
tableName - Name of the root table.
Returns:
The root filter conditions.
Throws: XMLMiddlewareException
Thrown if the table is not mapped as a class table.
 o createRootFilterConditions
 public FilterConditions createRootFilterConditions(Table table) throws XMLMiddlewareException
Create the root filter conditions.

If a root filter conditions already exist, they are overwritten.

Parameters:
table - The root table.
Returns:
The root filter conditions.
Throws: XMLMiddlewareException
Thrown if the table is not mapped as a class table.

All Packages  Class Hierarchy  This Package  Previous  Next  Index