org.apache.portals.graffito.services.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()
void	setScope(java.lang.String scope) Set the filter scope.

Method Detail

setScope

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

java.lang.String getScope()

Get the filter scope.

Returns:

The filter scope

addFullTextSearch

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

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

java.lang.String getSearchField()

Returns:

the full text search field

addBetween

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

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

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

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

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

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

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

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

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

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

void addNotNull(java.lang.String arg0)

See Also:

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

addIsNull

void addIsNull(java.lang.String arg0)

addOrFilter

void addOrFilter(Filter arg0)

See Also:

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

addOrderByAscending

void addOrderByAscending(java.lang.String arg0)

See Also:

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

addOrderByDescending

void addOrderByDescending(java.lang.String arg0)

See Also:

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