Package de.uplanet.lucy.server.newsagent
Interface IFilter
- All Known Implementing Classes:
AbstractFilter
,AppGuidFilter
,AppGuidNullFilter
,AppIdFilter
,AppIdNullFilter
,IdentityFilter
,NewsArchiveReceivedFilter
,NewsArchiveSentFilter
,NotExpiredFilter
,RecipientFilter
,SingleAppGuidFilter
,SingleAppIdFilter
@Scriptable
public interface IFilter
Used for news filtering on collection and / or database level.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
filter
(List<de.uplanet.lucy.server.newsagent.Message> p_from, List<de.uplanet.lucy.server.newsagent.Message> p_to) Do the filtering, operating on array lists.void
forConnection
(de.uplanet.jdbc.JdbcConnection p_conn) Initialize the filter with a database connection.void
Prepare the filter for a specific user.boolean
Indicates if post-processing is needed after SQL retrieval.boolean
pass
(de.uplanet.lucy.server.newsagent.Message p_message) Decide if the given message passes the filter.sqlQuery()
Provide a SQL search query.
-
Method Details
-
forConnection
void forConnection(de.uplanet.jdbc.JdbcConnection p_conn) Initialize the filter with a database connection.This may be used if the property
needsSqlPostProcessing()
depends on the database used.- Parameters:
p_conn
- The database connection used.
-
forUser
Prepare the filter for a specific user.- Parameters:
p_strUserId
- The sender's or the recipient's GUID.
-
sqlQuery
String sqlQuery()Provide a SQL search query.- Returns:
- A SQL query, or
null
if the filter cannot be applied at database level.
-
needsSqlPostProcessing
boolean needsSqlPostProcessing()Indicates if post-processing is needed after SQL retrieval.- Returns:
true
if post-processing is needed after SQL retrieval,false
otherwise.
-
pass
boolean pass(de.uplanet.lucy.server.newsagent.Message p_message) Decide if the given message passes the filter.- Parameters:
p_message
- The message to be filtered.- Returns:
true
if the message passes the filter,false
otherwise.
-
filter
void filter(List<de.uplanet.lucy.server.newsagent.Message> p_from, List<de.uplanet.lucy.server.newsagent.Message> p_to) Do the filtering, operating on array lists.- Parameters:
p_from
- Collection of messages to be filtered.p_to
- The filtered collection.
-