|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jalios.jcms.QueryFilter
public abstract class QueryFilter
A QueryFilter is notified for each query.
Field Summary | |
---|---|
static String |
BACKOFFICE_SEARCH
QueryHandler attribute used to indicate that we are processing a back office search. |
static String |
FRONTOFFICE_SEARCH
QueryHandler attribute used to indicate that we are processing a front office search. |
protected int |
order
|
static String |
PORTLET_QUERY
QueryHandler attribute used to indicate that we are processing a portlet's query. |
static String |
REVISION
|
Constructor Summary | |
---|---|
QueryFilter()
Constructs a QueryFilter with order = 0 |
|
QueryFilter(int order)
Constructs a QueryFilter with the given order |
Method Summary | |
---|---|
int |
compareTo(Object obj)
Compare this object with the specified object for order. |
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
QueryHandler |
filterQueryHandler(QueryHandler qh,
Map context)
This method should be overriden to filter the value of the QueryHandler |
QueryResultSet |
filterResultSet(QueryHandler qh,
QueryResultSet set,
Map context)
This method should be overriden to filter the result set |
int |
getOrder()
Retrieve the order value used to sort QueryFilter. |
boolean |
getSearchDefault()
This method may overriden if this QueryFilter is selectable from the search user interface. |
String |
getSearchDescription(String lang)
This method may be overriden if this QueryFilter is selectable from the search user interface. |
String |
getSearchLabel(String lang)
This method may be overriden if this QueryFilter is selectable from the search user interface. |
String |
getSearchParam()
This method must be overriden if this QueryFilter is selectable from the search user interface. |
boolean |
init(Plugin plugin)
Initialize the component with the given plugin configuration |
static boolean |
isBackOfficeSearch(QueryHandler qh)
Check if the specified QueryHandler is a back office search. |
static boolean |
isFrontOfficeSearch(QueryHandler qh)
Check if the specified QueryHandler is a front office search. |
static boolean |
isPortletQuery(QueryHandler qh)
Check if the specified QueryHandler is a portlet query. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String REVISION
public static final String FRONTOFFICE_SEARCH
isFrontOfficeSearch(QueryHandler)
.
public static final String BACKOFFICE_SEARCH
isBackOfficeSearch(QueryHandler)
.
public static final String PORTLET_QUERY
isPortletQuery(QueryHandler)
.
protected int order
Constructor Detail |
---|
public QueryFilter()
public QueryFilter(int order)
order
- the orderMethod Detail |
---|
public boolean init(Plugin plugin)
PluginComponent
init
in interface PluginComponent
plugin
- the calling plugin
PluginComponent.init(Plugin)
public QueryHandler filterQueryHandler(QueryHandler qh, Map context)
qh
- the QueryHandlercontext
- the context. Can be used to exchange data between custom QueryFilters.
public QueryResultSet filterResultSet(QueryHandler qh, QueryResultSet set, Map context)
qh
- the QueryHandlerset
- the result setcontext
- the context. Can be used to exchange data between custom QueryFilters.
public String getSearchParam()
public String getSearchLabel(String lang)
lang
- the user language
public String getSearchDescription(String lang)
lang
- the user language
public boolean getSearchDefault()
public int compareTo(Object obj)
compareTo
in interface Comparable
obj
- the Object to be compared.Comparable.compareTo(java.lang.Object)
public boolean equals(Object obj)
equals
in class Object
obj
- the Object to be compared.public int getOrder()
public static boolean isFrontOfficeSearch(QueryHandler qh)
"front/query.jsp"
.
qh
- the QueryHandler to check
public static boolean isBackOfficeSearch(QueryHandler qh)
"work/queryWork.jsp"
.
qh
- the QueryHandler to check
public static boolean isPortletQuery(QueryHandler qh)
"types/PortletQueryForeach/doQuery.jsp"
.
qh
- the QueryHandler to check
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |