org.nuxeo.ecm.platform.smart.query.jsf

Class SmartNXQLQueryActions

java.lang.Object

org.nuxeo.ecm.platform.smart.query.jsf.SmartNXQLQueryActions

All Implemented Interfaces:

Serializable

@Name(value="smartNXQLQueryActions")
@Scope(value=CONVERSATION)
public class SmartNXQLQueryActions
extends Object
implements Serializable

Seam component handling a IncrementalSmartNXQLQuery instance created for a given existing query string.

Also handles undo/redo actions and all ajax interactions for an incremental query build page.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	HISTORY_CAPACITY

Constructor Summary

Constructors

Constructor and Description
SmartNXQLQueryActions()

Method Summary

Methods

Modifier and Type	Method and Description
void	buildQueryPart(ActionEvent event) Updates the query part, asking the currentSmartQuery to build the new resulting query.
void	clearQueryPart(ActionEvent event) Sets the query part to an empty value.
boolean	getCanRedoQueryPartChanges()
boolean	getCanUndoQueryPartChanges()
SmartQuery	getCurrentSmartQuery()
String	getQueryPart()
List<SortInfo>	getSearchSortInfos()
List<String>	getSelectedLayoutColumns()
void	initCurrentSmartQuery(String existingQueryPart) Creates a new currentSmartQuery instance.
void	initCurrentSmartQuery(String existingQueryPart, boolean resetHistory)
boolean	isAjaxRequest() Returns true if current request is an ajax request.
void	queryPartChanged(ActionEvent event) Updates the current currentSmartQuery instance according to changes on the existing query part.
void	redoQueryPartChanges(ActionEvent event)
void	resetSelectedLayoutColumns()
void	setQueryPart(String queryPart)
void	setSearchSortInfos(List<SortInfo> searchSortInfos)
void	setSelectedLayoutColumns(List<String> selectedLayoutColumns)
void	undoHistoryChanges(ActionEvent event, HistoryList<String> history, HistoryList<String> redoHistory)
void	undoQueryPartChanges(ActionEvent event)
void	validateQueryPart(FacesContext context, UIComponent component, Object value) Validates the query part: throws a ValidatorException if query is not a String, or if IncrementalSmartNXQLQuery.isValid(String) returns false.

Methods inherited from class java.lang.Object

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

Field Detail

HISTORY_CAPACITY

public static final int HISTORY_CAPACITY

See Also:

Constant Field Values

Constructor Detail

SmartNXQLQueryActions

public SmartNXQLQueryActions()

Method Detail

getQueryPart

public String getQueryPart()

setQueryPart

public void setQueryPart(String queryPart)

getSelectedLayoutColumns

public List<String> getSelectedLayoutColumns()

setSelectedLayoutColumns

public void setSelectedLayoutColumns(List<String> selectedLayoutColumns)

resetSelectedLayoutColumns

public void resetSelectedLayoutColumns()

getSearchSortInfos

public List<SortInfo> getSearchSortInfos()

setSearchSortInfos

public void setSearchSortInfos(List<SortInfo> searchSortInfos)

initCurrentSmartQuery

public void initCurrentSmartQuery(String existingQueryPart,
                         boolean resetHistory)

initCurrentSmartQuery

public void initCurrentSmartQuery(String existingQueryPart)

Creates a new currentSmartQuery instance.

This method is supposed to be called once when loading a new page: it will initialize the smart query object according to the current existing qury part.

It should not be called when there are validation errors happening on the page, otherwise the new query part may be discarded.

getCurrentSmartQuery

public SmartQuery getCurrentSmartQuery()

queryPartChanged

public void queryPartChanged(ActionEvent event)
                      throws ClientException

Updates the current currentSmartQuery instance according to changes on the existing query part.

if request parameters updateQueryPart is true, the field queryPart will also be edited.

Throws:

ClientException

buildQueryPart

public void buildQueryPart(ActionEvent event)
                    throws ClientException

Updates the query part, asking the currentSmartQuery to build the new resulting query.

Throws:

ClientException

See Also:

#setQueryPart(ActionEvent, String)

clearQueryPart

public void clearQueryPart(ActionEvent event)
                    throws ClientException

Sets the query part to an empty value.

Throws:

ClientException

See Also:

#setQueryPart(ActionEvent, String)

getCanUndoQueryPartChanges

public boolean getCanUndoQueryPartChanges()

getCanRedoQueryPartChanges

public boolean getCanRedoQueryPartChanges()

undoHistoryChanges

public void undoHistoryChanges(ActionEvent event,
                      HistoryList<String> history,
                      HistoryList<String> redoHistory)
                        throws ClientException

Throws:

ClientException

undoQueryPartChanges

public void undoQueryPartChanges(ActionEvent event)
                          throws ClientException

Throws:

ClientException

redoQueryPartChanges

public void redoQueryPartChanges(ActionEvent event)
                          throws ClientException

Throws:

ClientException

validateQueryPart

public void validateQueryPart(FacesContext context,
                     UIComponent component,
                     Object value)

Validates the query part: throws a ValidatorException if query is not a String, or if IncrementalSmartNXQLQuery.isValid(String) returns false.

See Also:

IncrementalSmartNXQLQuery.isValid(String)

isAjaxRequest

public boolean isAjaxRequest()

Returns true if current request is an ajax request.

Useful when some component should be required only when the global form is submitted, and not when ajax calls are performed.