*** This class is subject to change ***

com.sas.dataselectors.filters
Class AbstractFilterableListModel

java.lang.Object
  |
  +--com.sas.dataselectors.filters.AbstractFilterableListModel

All Implemented Interfaces:

FilterableListModelInterface

Direct Known Subclasses:

BusinessModelToFilterableListModelAdapter, BusinessQueryToFilterableListModelAdapter

public abstract class AbstractFilterableListModel

extends java.lang.Object

implements FilterableListModelInterface

This class takes a model as input, decides what filterable items it contains, and constructs a list of FilterableItemInterface instances that define those filterable items and their individual filter models.

Field Summary

protected Object	_dataSource The data source for the model.
protected List	_filterableItems The list of filterable items in the model.
protected Object	_initialFilter An initial filter object in the native filter to focus the model on.
protected boolean	_initialized A flag to indicate whether the model has been initialized or not.
protected Locale	_locale The locale the model should use when generating UI elements.
protected int	environment The operating environment (e.g.

Constructor Summary

AbstractFilterableListModel()
Construct a new AbstractFilterableListModel.

AbstractFilterableListModel(Object dataSource)
Constructs a new model from the given source.

AbstractFilterableListModel(Object dataSource, int environment)
Constructs a new model from the given source and initial filter.

AbstractFilterableListModel(Object dataSource, Object initialFilter)
Constructs a new model from the given source and initial filter.

Method Summary

void	cancel() Cancels any changes to the filter model.
void	clearAll() Removes the filters from all filterable items.
void	clearFilter(int index) Removes the filter from the filterable item at the specified index.
boolean	commitChanges() Commits any changes made in the filter model to the native model.
protected abstract FilterableItemInterface	createFilterableItem(Object filterable) Creates an instance of FilterableItemInterface for the given object from the native filter model.
protected void	createFilterableItemList() Creates the list of filterable items based on the underlying native model.
int	getEnvironment() Gets the current operating environment.
FilterableItemInterface	getFilterableItem(Object filterable) Creates and returns the filterable item object for the given object from the native filter model.
List	getFilterableItems() Returns the list of filterable items from the source model.
protected abstract List	getFilterableObjects() Returns the list of native filter model objects that should be used for filterable items in the filter model.
Object	getInitialFilter() Returns the initial filter for the model.
Locale	getLocale() Returns the Locale currently assigned to the model.
Object	getModel() Returns the source native model for this adapter.
void	setEnvironment(int environment) Sets the operating environment to the specified value.
void	setInitialFilter(Object initialFilter) Sets the initial filter for the model.
void	setLocale(Locale locale) Sets the locale assigned to this model and all the filterable items.
void	setModel(Object model) Sets the source native model for this adapter.

Methods inherited from class java.lang.Object

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

Field Detail

_locale

protected Locale _locale

The locale the model should use when generating UI elements.

_dataSource

protected Object _dataSource

The data source for the model. This should be either a BusinessModel or a BusinessQuery object.

_initialFilter

protected Object _initialFilter

An initial filter object in the native filter to focus the model on. If omitted, all filterable items from the data source will be examined.

_initialized

protected boolean _initialized

A flag to indicate whether the model has been initialized or not. The model is considered initialized when the list of filterable items has been constructed.

_filterableItems

protected List _filterableItems

The list of filterable items in the model.

environment

protected int environment

The operating environment (e.g. Swing/JSP)

Constructor Detail

AbstractFilterableListModel

public AbstractFilterableListModel()

Construct a new AbstractFilterableListModel. Because the class is abstract, it cannot be instantiated directly.

AbstractFilterableListModel

public AbstractFilterableListModel(Object dataSource)

Constructs a new model from the given source.

Parameters:

dataSource - the source model

AbstractFilterableListModel

public AbstractFilterableListModel(Object dataSource,
                                   Object initialFilter)

Constructs a new model from the given source and initial filter.

Parameters:

dataSource - the source model

initialFilter - the initial filter object from the native model

AbstractFilterableListModel

public AbstractFilterableListModel(Object dataSource,
                                   int environment)

Constructs a new model from the given source and initial filter.

Parameters:

dataSource - the source model

initialFilter - the initial filter object from the native model

environment - the current operating environment

Method Detail

setInitialFilter

public void setInitialFilter(Object initialFilter)

Sets the initial filter for the model.

Parameters:

initialFilter - the initial filter object from the native model

getInitialFilter

public Object getInitialFilter()

Returns the initial filter for the model.

Specified by:

getInitialFilter in interface FilterableListModelInterface

Returns:

the initial filter object from the native model

getModel

public Object getModel()

Returns the source native model for this adapter.

Specified by:

getModel in interface FilterableListModelInterface

Returns:

the source native model

setModel

public void setModel(Object model)

Sets the source native model for this adapter.

Parameters:

model - the source native model

getFilterableItems

public List getFilterableItems()

Returns the list of filterable items from the source model.

Specified by:

getFilterableItems in interface FilterableListModelInterface

Returns:

the list of filterable items

getFilterableItem

public FilterableItemInterface getFilterableItem(Object filterable)

Creates and returns the filterable item object for the given object from the native filter model.

Specified by:

getFilterableItem in interface FilterableListModelInterface

Parameters:

filterable - the object to process from the native filter model

Returns:

the filterable item based on the given native filter object

createFilterableItemList

protected void createFilterableItemList()

Creates the list of filterable items based on the underlying native model.

getFilterableObjects

protected abstract List getFilterableObjects()

Returns the list of native filter model objects that should be used for filterable items in the filter model.

Returns:

the list of native filter model objects to process

createFilterableItem

protected abstract FilterableItemInterface createFilterableItem(Object filterable)

Creates an instance of FilterableItemInterface for the given object from the native filter model.

Parameters:

filterable - the native model object to process

Returns:

the FilterableItemInterface instance representing the given object

commitChanges

public boolean commitChanges()

Commits any changes made in the filter model to the native model. If the commit succeeds, TRUE is returned, FALSE otherwise.

Specified by:

commitChanges in interface FilterableListModelInterface

Returns:

TRUE if everything succeeds, FALSE otherwise

cancel

public void cancel()

Cancels any changes to the filter model.

Specified by:

cancel in interface FilterableListModelInterface

clearAll

public void clearAll()

Removes the filters from all filterable items.

Specified by:

clearAll in interface FilterableListModelInterface

clearFilter

public void clearFilter(int index)

Removes the filter from the filterable item at the specified index.

Specified by:

clearFilter in interface FilterableListModelInterface

Parameters:

index - the index in the list of filterable items of the filter to clear

getLocale

public Locale getLocale()

Returns the Locale currently assigned to the model.

Specified by:

getLocale in interface FilterableListModelInterface

Returns:

the model's current locale

setLocale

public void setLocale(Locale locale)

Sets the locale assigned to this model and all the filterable items.

Specified by:

setLocale in interface FilterableListModelInterface

Parameters:

locale - the locale to assign to all filterable items in this model

setEnvironment

public void setEnvironment(int environment)

Sets the operating environment to the specified value.

Parameters:

environment - The environment to set. Valid values are defined in com.sas.util.OperatingEnvironmentInterface.

getEnvironment

public int getEnvironment()

Gets the current operating environment.

Returns:

The operating environment. Valid values are defined in com.sas.util.OperatingEnvironmentInterface.

*** This class is subject to change ***