org.apache.portals.graffito.search
Interface Filter

public interface Filter

Graffito Filter interface.

Version:

$Ip: Exp $

Method Summary

void	addBetween(java.lang.String arg0, java.lang.Object arg1, java.lang.Object arg2)
void	addEqualTo(java.lang.String arg0, java.lang.Object arg1)
void	addFullTextSearch(java.lang.String fullTextSearch) Search content based on a fullTextSearch.
void	addFullTextSearch(java.lang.String fullTextSearch, java.lang.String field) Search content based on a fullTextSearch.
void	addGreaterOrEqualThan(java.lang.String arg0, java.lang.Object arg1)
void	addGreaterThan(java.lang.String arg0, java.lang.Object arg1)
void	addIn(java.lang.String attribute, java.util.Collection values)
void	addIsNull(java.lang.String arg0)
void	addLessOrEqualThan(java.lang.String arg0, java.lang.Object arg1)
void	addLike(java.lang.Object arg0, java.lang.Object arg1)
void	addNotBetween(java.lang.String arg0, java.lang.Object arg1, java.lang.Object arg2)
void	addNotEqualTo(java.lang.String arg0, java.lang.Object arg1)
void	addNotLike(java.lang.String arg0, java.lang.Object arg1)
void	addNotNull(java.lang.String arg0)
void	addOrderByAscending(java.lang.String arg0)
void	addOrderByDescending(java.lang.String arg0)
void	addOrFilter(Filter arg0)
java.lang.String	getScope() Get the filter scope.
java.lang.String	getSearchField() Get the full text search field
void	setScope(java.lang.String scope) Set the filter scope.

Method Detail

setScope

public void setScope(java.lang.String scope)

Set the filter scope. The scope is an URI prefix specifying where to search in the content tree. For example, if the scope is '/myserver1/myfolder', the search engine will search all objects which are located below '/myserver1/myfolder'.

Parameters:

scope - The filter scope

getScope

public java.lang.String getScope()

Get the filter scope.

Returns:

The filter scope

addFullTextSearch

public void addFullTextSearch(java.lang.String fullTextSearch)

Search content based on a fullTextSearch. Depending on the full text search engine, you can also filter on properties.

Parameters:

fullTextSearch - The full text search string

addFullTextSearch

public void addFullTextSearch(java.lang.String fullTextSearch,
                              java.lang.String field)

Search content based on a fullTextSearch. Depending on the full text search engine, you can also filter on properties.

Parameters:

fullTextSearch - The full text search string

field - The field to be searched

getSearchField

public java.lang.String getSearchField()

Get the full text search field

Returns:

addBetween

public void addBetween(java.lang.String arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2)

See Also:

org.apache.ojb.broker.query.Criteria#addBetween(java.lang.String, java.lang.Object, java.lang.Object)

addEqualTo

public void addEqualTo(java.lang.String arg0,
                       java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addEqualTo(java.lang.String, java.lang.Object)

addGreaterOrEqualThan

public void addGreaterOrEqualThan(java.lang.String arg0,
                                  java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addGreaterOrEqualThan(java.lang.String, java.lang.Object)

addGreaterThan

public void addGreaterThan(java.lang.String arg0,
                           java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addGreaterThan(java.lang.String, java.lang.Object)

addIn

public void addIn(java.lang.String attribute,
                  java.util.Collection values)

See Also:

org.apache.ojb.broker.query.Criteria#addIn(java.lang.String, java.util.Collection)

addLessOrEqualThan

public void addLessOrEqualThan(java.lang.String arg0,
                               java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addLessOrEqualThan(java.lang.String, java.lang.Object)

addLike

public void addLike(java.lang.Object arg0,
                    java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addLike(java.lang.Object, java.lang.Object)

addNotBetween

public void addNotBetween(java.lang.String arg0,
                          java.lang.Object arg1,
                          java.lang.Object arg2)

See Also:

org.apache.ojb.broker.query.Criteria#addNotBetween(java.lang.String, java.lang.Object, java.lang.Object)

addNotEqualTo

public void addNotEqualTo(java.lang.String arg0,
                          java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addNotEqualTo(java.lang.String, java.lang.Object)

addNotLike

public void addNotLike(java.lang.String arg0,
                       java.lang.Object arg1)

See Also:

org.apache.ojb.broker.query.Criteria#addNotLike(java.lang.String, java.lang.Object)

addNotNull

public void addNotNull(java.lang.String arg0)

See Also:

org.apache.ojb.broker.query.Criteria#addNotNull(java.lang.String)

addIsNull

public void addIsNull(java.lang.String arg0)

addOrFilter

public void addOrFilter(Filter arg0)

See Also:

org.apache.ojb.broker.query.Criteria#addOrCriteria(org.apache.ojb.broker.query.Criteria)

addOrderByAscending

public void addOrderByAscending(java.lang.String arg0)

See Also:

org.apache.ojb.broker.query.Criteria#addOrderByAscending(java.lang.String)

addOrderByDescending

public void addOrderByDescending(java.lang.String arg0)

See Also:

org.apache.ojb.broker.query.Criteria#addOrderByDescending(java.lang.String)