org.wandora.query

Class FilterDirective

java.lang.Object

org.wandora.query.FilterDirective

All Implemented Interfaces:

Directive

Direct Known Subclasses:

AndDirective, CompareDirective, ExistsDirective, IsContextTopicDirective, IsOfTypeDirective, IsTopicDirective, OrDirective

Deprecated.

public abstract class FilterDirective
extends java.lang.Object
implements Directive

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	not Deprecated.
protected Directive	query Deprecated.
static int	RES_EXCLUDE Deprecated.
static int	RES_IGNORE Deprecated.
static int	RES_INCLUDE Deprecated.

Constructor Summary

Constructors

Constructor and Description
FilterDirective(Directive query, boolean not) Deprecated. Creates a new instance of FilterDirective

Method Summary

Modifier and Type	Method and Description
protected abstract int	_includeRow(ResultRow row, Topic context, TopicMap tm, java.lang.Object param) Deprecated. Return one of RES_INCLUDE, RES_EXCLUDE or RES_INGORE to indicate how to filter the row.
void	endQuery(QueryContext context, java.lang.Object param) Deprecated. Called when query evaluation is done.
boolean	includeRow(ResultRow row, Topic context, TopicMap tm, java.lang.Object param) Deprecated.
boolean	isContextSensitive() Deprecated.
java.util.ArrayList<ResultRow>	query(QueryContext context) Deprecated.
java.lang.Object	startQuery(QueryContext context) Deprecated. Called when evaluation of this filter query is about to start.

Methods inherited from class java.lang.Object

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

Field Detail

RES_INCLUDE

public static final int RES_INCLUDE

Deprecated.

See Also:

Constant Field Values

RES_EXCLUDE

public static final int RES_EXCLUDE

Deprecated.

See Also:

Constant Field Values

RES_IGNORE

public static final int RES_IGNORE

Deprecated.

See Also:

Constant Field Values

query

protected Directive query

Deprecated.

not

protected boolean not

Deprecated.

Constructor Detail

FilterDirective

public FilterDirective(Directive query,
                       boolean not)

Deprecated.

Creates a new instance of FilterDirective

Method Detail

startQuery

public java.lang.Object startQuery(QueryContext context)
                            throws TopicMapException

Deprecated.

Called when evaluation of this filter query is about to start. The return value is passed as a parameter to _includeRow and endQuery later. Returning a null value should mean that _includeRow will return RES_EXCLUDE for all rows. So if you don't need a parameter object, just return any object (this, new Object() or whatever) and simply ignore it later.

Throws:

TopicMapException

endQuery

public void endQuery(QueryContext context,
                     java.lang.Object param)
              throws TopicMapException

Deprecated.

Called when query evaluation is done. If startQuery returned null, this method might not be called.

Throws:

TopicMapException

_includeRow

protected abstract int _includeRow(ResultRow row,
                                   Topic context,
                                   TopicMap tm,
                                   java.lang.Object param)
                            throws TopicMapException

Deprecated.

Return one of RES_INCLUDE, RES_EXCLUDE or RES_INGORE to indicate how to filter the row. RES_INCLUDE means that the row should be included in the resurt except when negation if query is desired. RES_EXCLUDE is the opposite, row is not included except in the case of negation. RES_IGNORE means that row is not included regardless of query being evaluated in negation mode or not. This can be because for example the association doesn't have the assumed players.

Throws:

TopicMapException

includeRow

public boolean includeRow(ResultRow row,
                          Topic context,
                          TopicMap tm,
                          java.lang.Object param)
                   throws TopicMapException

Deprecated.

Throws:

TopicMapException

query

public java.util.ArrayList<ResultRow> query(QueryContext context)
                                     throws TopicMapException

Deprecated.

Specified by:

query in interface Directive

Throws:

TopicMapException

isContextSensitive

public boolean isContextSensitive()

Deprecated.

Specified by:

isContextSensitive in interface Directive