fr.ifremer.suiviobsmer.ui.base
Class AbstractFilteredPage

java.lang.Object
  fr.ifremer.suiviobsmer.ui.base.AbstractFilteredPage

Direct Known Subclasses:

Boats, Contacts, Synthesis

public abstract class AbstractFilteredPage
extends Object

AbstractFilteredPage Created: 14 janv. 2010 This class uses the BoatFilter bean (also SamplingFilter and UserFilter which are supertypes). Known implementations are Synthesis and Contacts You must override the three abstract methods and call #initFilter() in the setupRender of the page.

 - BoatName uses an Autocomplete mixins :
      
 - SampleRow select value is sampleRowId :
      
 - Company select value is companyId :
      
 - Observer select value is observerId :
      

 Use submit button with specific ids to refresh data depends on select change:
 - id="refreshByCompany" : refresh facadeSelect, sectorSelect, sampleRowSelect 
   and observerSelect
 - id="refreshByFacade" : refresh sectorSelect and sampleRowSelect
 - id="refreshBySector" : refresh sampleRowSelect

 

Version:

$Revision: 285 $ Mise a jour: $Date: 2010-01-27 18:08:47 +0100 (mer., 27 janv. 2010) $ par : $Author$

Author:

fdesbois

Constructor Summary

AbstractFilteredPage()

Method Summary

protected abstract boolean	getAvailableDataForFiltersOnly() Used to show only active company and observers.
GenericSelectModel<Company>	getCompanySelectModel() Get select model for companies.
org.apache.tapestry5.SelectModel	getFacadeSelectModel() Get select model for fishingZone facade.
protected abstract BoatFilter	getFilter()
GenericSelectModel<WaoUser>	getObserverSelectModel() Get the select model for observers.
GenericSelectModel<SampleRow>	getSampleRowSelectModel() Get select model for sampleRows.
org.apache.tapestry5.SelectModel	getSectorSelectModel() Get select model for fishingZone sector.
protected void	initSelectFilters(boolean companySelect, boolean observerSelect) Initialize all select for filters.
protected boolean	isEdited() Used to indicate that a refresh as been triggered.
String[]	onProvideCompletionsFromBoatName(String input)
void	onSelectedFromRefreshByCompany() EVENT :: selected on refreshByCompany submit button.
void	onSelectedFromRefreshByFacade() EVENT :: selected on refreshByFacade submit button.
void	onSelectedFromRefreshBySector() EVENT :: selected on refreshBySector submit button.
void	onSelectedFromSearch() Called when search submit button is pressed.
protected void	resetFacadeSelect()
protected void	resetSampleRowSelect()
protected void	resetSectorSelect()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilteredPage

public AbstractFilteredPage()

Method Detail

initSelectFilters

protected void initSelectFilters(boolean companySelect,
                                 boolean observerSelect)
                          throws SuiviObsmerException

Initialize all select for filters. By default, only facade, sector and sampleRow selects will be initialized.

Parameters:

companySelect - if true, company select will be initialized

observerSelect - if true, observer select will be initialized

Throws:

SuiviObsmerException

resetFacadeSelect

protected void resetFacadeSelect()
                          throws SuiviObsmerException

Throws:

SuiviObsmerException

resetSectorSelect

protected void resetSectorSelect()
                          throws SuiviObsmerException

Throws:

SuiviObsmerException

resetSampleRowSelect

protected void resetSampleRowSelect()
                             throws SuiviObsmerException

Throws:

SuiviObsmerException

getFacadeSelectModel

public org.apache.tapestry5.SelectModel getFacadeSelectModel()
                                                      throws SuiviObsmerException

Get select model for fishingZone facade. Depends on company set in filter.

Returns:

the SelectModel for facade names

Throws:

SuiviObsmerException

getSectorSelectModel

public org.apache.tapestry5.SelectModel getSectorSelectModel()
                                                      throws SuiviObsmerException

Get select model for fishingZone sector. Depends on facadeName and company set in filter.

Returns:

the SelectModel for sector names

Throws:

SuiviObsmerException

getSampleRowSelectModel

public GenericSelectModel<SampleRow> getSampleRowSelectModel()
                                                      throws SuiviObsmerException

Get select model for sampleRows. Depends on filter (Sampling part only). The sampleRow set from filter is temporarly extracted to avoid returning only one element in the select.

Returns:

the GenericSelectModel for sampleRows

Throws:

SuiviObsmerException

getCompanySelectModel

public GenericSelectModel<Company> getCompanySelectModel()
                                                  throws SuiviObsmerException

Get select model for companies. Depends on getAvailableDataForFiltersOnly() to return only activated companies. This select model is only used by admin users.

Returns:

the GenericSelectModel for companies

Throws:

SuiviObsmerException

getObserverSelectModel

public GenericSelectModel<WaoUser> getObserverSelectModel()
                                                   throws SuiviObsmerException

Get the select model for observers. Depends on getAvailableDataForFiltersOnly() to return only activated companies.

Returns:

the GenericSelectModel for observers

Throws:

SuiviObsmerException

getFilter

protected abstract BoatFilter getFilter()
                                 throws SuiviObsmerException

Throws:

SuiviObsmerException

getAvailableDataForFiltersOnly

protected abstract boolean getAvailableDataForFiltersOnly()

Used to show only active company and observers.

Returns:

true if only active users will be showed, false otherwise

onProvideCompletionsFromBoatName

public String[] onProvideCompletionsFromBoatName(String input)
                                          throws SuiviObsmerException

Throws:

SuiviObsmerException

onSelectedFromSearch

public void onSelectedFromSearch()
                          throws SuiviObsmerException

Called when search submit button is pressed. This method is useful to refresh all filters data from selects.

Throws:

SuiviObsmerException

onSelectedFromRefreshByCompany

public void onSelectedFromRefreshByCompany()
                                    throws SuiviObsmerException

EVENT :: selected on refreshByCompany submit button. Reset selects for company selected : facades, sectors, sampleRows and observers. This method set the state to edited, you can use isEdited() method to test it.

Throws:

SuiviObsmerException

See Also:

onSelectedFromRefreshByFacade()

onSelectedFromRefreshByFacade

public void onSelectedFromRefreshByFacade()
                                   throws SuiviObsmerException

EVENT :: selected on refreshByFacade submit button. Reset selects for facade selected : sectors and sampleRows. This method set the state to edited, you can use isEdited() method to test it.

Throws:

SuiviObsmerException

See Also:

onSelectedFromRefreshBySector()

onSelectedFromRefreshBySector

public void onSelectedFromRefreshBySector()
                                   throws SuiviObsmerException

EVENT :: selected on refreshBySector submit button. After refreshing data selected, reset selects for sector selected : sampleRows. This method set the state to edited, you can use isEdited() method to test it.

Throws:

SuiviObsmerException

See Also:

onSelectedFromSearch()

isEdited

protected boolean isEdited()

Used to indicate that a refresh as been triggered.

Returns:

true if the page filter is in edited state.