Package lumis.doui.table.filter

Class CompositeTableSourceFilter

java.lang.Object

lumis.doui.table.filter.CompositeTableSourceFilter

All Implemented Interfaces:

ISourceFilter<TableSource>, ITableSourceFilter

public class CompositeTableSourceFilter
extends Object
implements ITableSourceFilter

A source filter that is composed of a list of source filters.

Since:

4.0.5

Version:

$Revision: 4930 $ $Date: 2006-11-01 14:15:48 -0300 (Wed, 01 Nov 2006) $

Constructor Summary

Constructors

Constructor	Description
CompositeTableSourceFilter()

Method Summary

Modifier and Type	Method	Description
ITableSourceFilter	getFilter(String filterId)	Returns the filter with the given id.
String	getInputControlType()	Returns the input control type for this filter doui frontend.
IQueryFilter	getQueryFilter(QueryBase queryBase, IParameters parameters)	Returns the query filter to be used with the given query.
void	init(TableSource source, Node filtersNode)	Creates and initializes the filters inside this composite filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface lumis.doui.source.filter.ISourceFilter

isEnabled

Constructor Detail

CompositeTableSourceFilter

public CompositeTableSourceFilter()

Method Detail

init

public void init(TableSource source,
                 Node filtersNode)
          throws PortalException

Creates and initializes the filters inside this composite filter.

Specified by:

init in interface ISourceFilter<TableSource>

Parameters:

source - the source the filter belongs to.

filtersNode - the filter definition node.

Throws:

PortalException - if the filter could not initialize itself.

Since:

4.0.5

getQueryFilter

public IQueryFilter getQueryFilter(QueryBase queryBase,
                                   IParameters parameters)
                            throws PortalException,
                                   RequiredFilterValueException

Description copied from interface: ITableSourceFilter

Returns the query filter to be used with the given query.

Specified by:

getQueryFilter in interface ITableSourceFilter

Parameters:

queryBase - the query.

parameters - the parameters to be used for the filter.

Returns:

the query filter.

Throws:

PortalException

RequiredFilterValueException - when a required value for the filter was not given. No results should be shown when this happen.

getFilter

public ITableSourceFilter getFilter(String filterId)
                             throws PortalException

Description copied from interface: ISourceFilter

Returns the filter with the given id. The filter instances should use a chain of responsability with their children to find and return the requested source filter.

Specified by:

getFilter in interface ISourceFilter<TableSource>

Specified by:

getFilter in interface ITableSourceFilter

Parameters:

filterId - the filter id.

Returns:

return the filter instance or null if the corresponding filter was not found.

Throws:

PortalException

getInputControlType

public String getInputControlType()
                           throws PortalException

Description copied from interface: ISourceFilter

Returns the input control type for this filter doui frontend.

Specified by:

getInputControlType in interface ISourceFilter<TableSource>

Returns:

the input control type, or null if there is no frontend for this filter instance.

Throws:

PortalException