com.goldencode.p2j.ui.client

Class ClientBrowseModel

java.lang.Object

com.goldencode.p2j.ui.client.ClientBrowseModel

All Implemented Interfaces:

BrowseModel

public class ClientBrowseModel
extends java.lang.Object
implements BrowseModel

This class implements client side of the BrowseModel used by the Browse widget. The implementation is just forwards all requests to the remote side using ServerExports interface.

Author:

SIY

Field Summary

Fields

Modifier and Type	Field and Description
private int	browseId ID of the associated browse widget.
private WidgetConfig[]	editorConfigsCache Cache of editing widgets' configurations.

Constructor Summary

Constructors

Constructor and Description
ClientBrowseModel(int browseId) Construct an instance of adapter class using specified query ID and reference to server interface.

Method Summary

Modifier and Type	Method and Description
boolean	applyEnhancedConfig(EnhancedBrowseConfig config) Apply the given enhanced browse configuration to this browse.
java.lang.String[]	getColumnFiltersMappedDataTypes() For enhanced filtering: get data types of the fields mapped using DB-FILTER-FIELD-MAPPING.
int	getCurrentRow() Get current row in the model.
WidgetConfig[]	getEditorsConfigs() Get configurations of editors (fill-ins, toggle-boxes or combo-boxes) used for in-browse editing.
EnhancedBrowseSaveTarget[]	getEnhancedBrowseResetTargets() Get enhanced browse configuration reset targets available for the current browse and the current user.
EnhancedBrowseSaveTarget[]	getEnhancedBrowseSaveTargets() Get save targets for an enhanced browse configuration, which are available for the current user.
int	getRowCount() Get the number of rows iterated by the query (for preselect queries - matches result size, for adaptive queries - matches the size of the part of the result set the query has already iterated over).
int	getRowCount(int startRow) Get number of available rows starting from the given one.
BrowseRow[]	getRows(char searchChar, int searchColumn, int viewportTopRow, int viewportBottomRow, int rowDisplayTriggerId, ScreenBuffer[] sb) This function is used when search by key is performed in a browse.
BrowseRow[]	getRows(int startRowIndex, int count, boolean forward, int rowDisplayTriggerId, ScreenBuffer[] sb, RowDisplayStrategy displayStrategy) Retrieves several subsequent rows from the database.
boolean	isRowAvailable(int rowIndex) Determines if the specified browse row is "available", i.e.
void	moveColumn(int src, int dest) Implements the MOVE-COLUMN() widget method.
void	notifyBrowseLayoutPerformed() Notify server that browse layout has been performed on the client side.
void	resetEditorsConfigsCache() Reset cache of editors configurations.
EhBrowseConfigKey	resetEnhancedConfig(EnhancedBrowseSaveTarget resetTarget) Reset (delete) an enhanced configuration at the certain level for this browse.
boolean	runReport(java.lang.String outputFileName, MediaType outputFormat) Run browse report.
EnhancedBrowseConfig	saveOrCacheEnhancedConfig(EnhancedBrowseSaveTarget saveTarget) Save the current enhanced browse configuration using the specified save target.
int	setCurrentRow(int rowIndex) Inform server about current row in the browse.
void	setDynamicFiltering(int[] columnOrdinals, BaseDataType[] values) Set dynamic filtering for the browse.
void	setDynamicSorting(int[] columnOrdinals, boolean[] ascending) Set dynamic sorting for the browse.
void	updateRow(int rowIndex, int[] cellIndices, BaseDataType[] cellValues, boolean onlyNotifyRowReleased) Updates selected cells in the given row.

Methods inherited from class java.lang.Object

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

Field Detail

browseId

private int browseId

ID of the associated browse widget.

editorConfigsCache

private WidgetConfig[] editorConfigsCache

Cache of editing widgets' configurations.

Constructor Detail

ClientBrowseModel

public ClientBrowseModel(int browseId)

Construct an instance of adapter class using specified query ID and reference to server interface.

Parameters:

browseId - ID of the browse widget to forward request to.

Method Detail

getEditorsConfigs

public WidgetConfig[] getEditorsConfigs()

Get configurations of editors (fill-ins, toggle-boxes or combo-boxes) used for in-browse editing.

Specified by:

getEditorsConfigs in interface BrowseModel

Returns:

Array of configurations of editor widgets (fill-ins, toggle-boxes or combo-boxes) which are used for in-browse editing. An array element is configuration of the editor widget for the corresponding editable column or null if the column is not editable. Return value is null if the browse is read-only.

resetEditorsConfigsCache

public void resetEditorsConfigsCache()

Reset cache of editors configurations.

Specified by:

resetEditorsConfigsCache in interface BrowseModel

getRowCount

public int getRowCount()

Get the number of rows iterated by the query (for preselect queries - matches result size, for adaptive queries - matches the size of the part of the result set the query has already iterated over).

Specified by:

getRowCount in interface BrowseModel

Returns:

number of iterated rows in the result set.

getRowCount

public int getRowCount(int startRow)

Get number of available rows starting from the given one.

Specified by:

getRowCount in interface BrowseModel

Parameters:

startRow - Initial row to start count rows from.

Returns:

Number of available rows.

getRows

public BrowseRow[] getRows(int startRowIndex,
                           int count,
                           boolean forward,
                           int rowDisplayTriggerId,
                           ScreenBuffer[] sb,
                           RowDisplayStrategy displayStrategy)

Retrieves several subsequent rows from the database.

Specified by:

getRows in interface BrowseModel

Parameters:

startRowIndex - Index of the first row to retrieve (0-based).

count - Maximum count of rows to return. -1 for no limit.

forward - true if rows are retrieved in the forward direction, false if rows are retrieved in the backward direction.

rowDisplayTriggerId - Trigger ID of the ROW-DISPLAY trigger. -1 if there is no ROW-DISPLAY trigger for this browse.

sb - Screen buffer for the ROW-DISPLAY trigger. null if there is no ROW-DISPLAY trigger for this browse.

displayStrategy - Specifies type of action for which rows are fetched and defines how rows are iterated / displayed.

Returns:

Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. Note that if rows are fetched in the backward direction, the resulting rows are returned in the straight order starting from the row with the least row number. If no query is specified or the query is closed, null is returned.

getRows

public BrowseRow[] getRows(char searchChar,
                           int searchColumn,
                           int viewportTopRow,
                           int viewportBottomRow,
                           int rowDisplayTriggerId,
                           ScreenBuffer[] sb)

This function is used when search by key is performed in a browse. Retrieves the set of rows which should be in view after search is completed. There are complex rules which determine the top row of the view depending on how the current row is positioned relatively to the current view and how the found row is positioned relatively to the current view and to the current row.

Specified by:

getRows in interface BrowseModel

Parameters:

searchChar - Character to be searched for. Search is performed using only the first character (in the visual data representation) in the current column. Specifying a character puts this function in the search mode. This parameter is null for non-search mode.

searchColumn - For search mode: 0-based index of the column to be searched.

viewportTopRow - For search mode: 0-based index (in the result set) of the top row in the current view.

viewportBottomRow - For search mode: 0-based index (in the result set) of the bottom row in the current view.

rowDisplayTriggerId - Trigger ID of the ROW-DISPLAY trigger. -1 if there is no ROW-DISPLAY trigger for this browse.

sb - Screen buffer for the ROW-DISPLAY trigger. null if there is no ROW-DISPLAY trigger for this browse.

Returns:

Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. If no query is specified or the query is closed, null is returned.

updateRow

public void updateRow(int rowIndex,
                      int[] cellIndices,
                      BaseDataType[] cellValues,
                      boolean onlyNotifyRowReleased)
               throws DataValidationException

Updates selected cells in the given row.

Specified by:

updateRow in interface BrowseModel

Parameters:

rowIndex - Index of the row to update.

cellIndices - Cells for update indexes.

cellValues - Cells for update new values.

onlyNotifyRowReleased - Only notify server that the row has been released. Data is not updated.

Throws:

DataValidationException - New values don't passed database validation rules.

setCurrentRow

public int setCurrentRow(int rowIndex)

Inform server about current row in the browse.

Specified by:

setCurrentRow in interface BrowseModel

Parameters:

rowIndex - 0-based index of the current row.

Returns:

New current row.

getCurrentRow

public int getCurrentRow()

Get current row in the model.

Specified by:

getCurrentRow in interface BrowseModel

Returns:

The current row index in the model.

isRowAvailable

public boolean isRowAvailable(int rowIndex)

Determines if the specified browse row is "available", i.e. it is not deleted.

Specified by:

isRowAvailable in interface BrowseModel

Parameters:

rowIndex - 0-base index of the target row in the browse model.

Returns:

true if the row is "available", i.e. it is not deleted.

moveColumn

public void moveColumn(int src,
                       int dest)

Implements the MOVE-COLUMN() widget method.

Repositions a column in the browse widget.

Specified by:

moveColumn in interface BrowseModel

Parameters:

src - 0-based position of the column to be moved (column ordinal).

dest - 0-based position to which the column is moved (column ordinal).

notifyBrowseLayoutPerformed

public void notifyBrowseLayoutPerformed()

Notify server that browse layout has been performed on the client side.

Specified by:

notifyBrowseLayoutPerformed in interface BrowseModel

runReport

public boolean runReport(java.lang.String outputFileName,
                         MediaType outputFormat)

Run browse report.

Specified by:

runReport in interface BrowseModel

Parameters:

outputFileName - Name of the output file.

outputFormat - Format of the output format.

Returns:

true on success.

getEnhancedBrowseSaveTargets

public EnhancedBrowseSaveTarget[] getEnhancedBrowseSaveTargets()

Get save targets for an enhanced browse configuration, which are available for the current user.

Specified by:

getEnhancedBrowseSaveTargets in interface BrowseModel

Returns:

see above.

getColumnFiltersMappedDataTypes

public java.lang.String[] getColumnFiltersMappedDataTypes()

For enhanced filtering: get data types of the fields mapped using DB-FILTER-FIELD-MAPPING. They are used in column filters. E.g. if a column has DB-FILTER-FIELD-MAPPING set to "some-table.some-date-field", data type from this column would be "date".

Specified by:

getColumnFiltersMappedDataTypes in interface BrowseModel

Returns:

array of data types, each array element corresponds a browse column. If a column doesn't have DB-FILTER-FIELD-MAPPING set, corresponding array element is null.

getEnhancedBrowseResetTargets

public EnhancedBrowseSaveTarget[] getEnhancedBrowseResetTargets()

Get enhanced browse configuration reset targets available for the current browse and the current user. It is a list of levels which have existing enhanced browse configurations defined for the current browse, filtered according to the user's access rights.

Specified by:

getEnhancedBrowseResetTargets in interface BrowseModel

Returns:

see above.

resetEnhancedConfig

public EhBrowseConfigKey resetEnhancedConfig(EnhancedBrowseSaveTarget resetTarget)

Reset (delete) an enhanced configuration at the certain level for this browse.

Specified by:

resetEnhancedConfig in interface BrowseModel

Parameters:

resetTarget - Defines the level at which the configuration will be reset.

Returns:

key of the configuration that has been deleted or null if there is no configuration at this level.

applyEnhancedConfig

public boolean applyEnhancedConfig(EnhancedBrowseConfig config)

Apply the given enhanced browse configuration to this browse.

Specified by:

applyEnhancedConfig in interface BrowseModel

Parameters:

config - Enhanced browse configuration to apply.

Returns:

true on success.

saveOrCacheEnhancedConfig

public EnhancedBrowseConfig saveOrCacheEnhancedConfig(EnhancedBrowseSaveTarget saveTarget)

Save the current enhanced browse configuration using the specified save target. If the configuration is supposed to be stored on the client side then on the server side it is only cached.

Specified by:

saveOrCacheEnhancedConfig in interface BrowseModel

Parameters:

saveTarget - Save target (if configuration is applied to "all browses" / "specific browse" and "all users" / "current user").

Returns:

the configuration that has been saved or cached. null on error.

setDynamicSorting

public void setDynamicSorting(int[] columnOrdinals,
                              boolean[] ascending)

Set dynamic sorting for the browse.

Specified by:

setDynamicSorting in interface BrowseModel

Parameters:

columnOrdinals - Array of the ordinals of the sort columns. Inside the array ordinals are positioned from the column which defines the most coarse sorting to the most granular.

ascending - Array of the sorting directions of the sort columns. true for ascending, false for descending. Inside the array directions are positioned from the column which defines the most coarse sorting to the most granular.

setDynamicFiltering

public void setDynamicFiltering(int[] columnOrdinals,
                                BaseDataType[] values)

Set dynamic filtering for the browse.

Specified by:

setDynamicFiltering in interface BrowseModel

Parameters:

columnOrdinals - Array of the ordinals of the filtered columns.

values - Array of the filter values for the filtered columns..