SalesPoint Framework v3.1

data.filters
Class StoringStockFilter

java.lang.Object
  extended bydata.filters.AbstractStockFilter
      extended bydata.filters.StoringStockFilter
All Implemented Interfaces:
Cloneable, Comparable, DataBasketEntryDestination, DataBasketEntrySource, EventListener, ListenableStock, Nameable, Serializable, Stock, StockChangeListener, StockItem, StoringStock

public abstract class StoringStockFilter
extends AbstractStockFilter
implements StoringStock

StockFilter for StoringStocks.

The filter condition can be defined by overriding method contains(data.StockItem, data.DataBasket).

Since:
v2.0
Author:
Steffen Zschaler
See Also:
Serialized Form

Field Summary
 
Fields inherited from class data.filters.AbstractStockFilter
m_lhListeners, m_stSource
 
Fields inherited from interface data.Nameable
NAME_PROPERTY
 
Constructor Summary
StoringStockFilter(StoringStock ssSource)
          Create a new StoringStockFilter.
 
Method Summary
abstract  boolean contains(StockItem si, DataBasket db)
          Filter condition: Check whether a given item is contained in the filtered Stock.
 boolean containsStock(Stock st, DataBasket db)
          Check whether the given Stock is contained in the filtered Stock.
 int countItems(String sKey, DataBasket db)
          Count all StockItems for a given key that are contained in the filtered Stock.
 Iterator get(String sKey, DataBasket db, boolean fForEdit)
          Get all StockItems for a given key that are contained in the filtered Stock.
 
Methods inherited from class data.filters.AbstractStockFilter
add, addedStockItems, addNameListener, addPropertyChangeListener, addStock, addStockChangeListener, attach, canEditStockItems, canRemoveStockItems, clone, commitAddStockItems, commitEditStockItems, commitRemoveStockItems, compareTo, contains, detachNC, editingStockItems, fillStockWithValue, fireCanEditStockItems, fireCanRemoveStockItems, fireEditingStockItems, fireStockItemsAddCommit, fireStockItemsAdded, fireStockItemsAddRollback, fireStockItemsEditCommit, fireStockItemsEditRollback, fireStockItemsNoEdit, fireStockItemsNoRemove, fireStockItemsRemoveCommit, fireStockItemsRemoved, fireStockItemsRemoveRollback, getAssociatedItem, getCatalog, getMainStock, getName, getStock, iterator, keySet, noEditStockItems, noRemoveStockItems, remove, remove, removedStockItems, removeNameListener, removePropertyChangeListener, removeStockChangeListener, rollbackAddStockItems, rollbackEditStockItems, rollbackRemoveStockItems, setName, size, sumStock
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface data.Stock
add, addStock, contains, fillStockWithValue, getCatalog, iterator, keySet, remove, remove, size, sumStock
 
Methods inherited from interface data.StockItem
clone, getAssociatedItem, getStock
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface data.Nameable
addNameListener, addPropertyChangeListener, attach, detachNC, getName, removeNameListener, removePropertyChangeListener, setName
 

Constructor Detail

StoringStockFilter

public StoringStockFilter(StoringStock ssSource)
Create a new StoringStockFilter.

Parameters:
ssSource - the source Stock.
Method Detail

get

public Iterator get(String sKey,
                    DataBasket db,
                    boolean fForEdit)
Get all StockItems for a given key that are contained in the filtered Stock.

Specified by:
get in interface Stock
Parameters:
sKey - the key for which to retrieve the StockItems.
db - the DataBasket relative to which to retrieve the StockItems.
fForEdit - if true, the StockItems will be retrieved for editing.
Override:
Never

countItems

public int countItems(String sKey,
                      DataBasket db)
Count all StockItems for a given key that are contained in the filtered Stock.

Specified by:
countItems in interface Stock
Parameters:
sKey - the key for which to count the StockItems.
db - the DataBasket that is used to determine visibility.
Override:
Never

contains

public abstract boolean contains(StockItem si,
                                 DataBasket db)
Filter condition: Check whether a given item is contained in the filtered Stock.

Specified by:
contains in interface Stock
Parameters:
si - the StockItem to be checked.
db - the DataBasket to be used to check visibility.
Returns:
true if the given item is to be contained in the filtered Stock.
Override:
Always

containsStock

public boolean containsStock(Stock st,
                             DataBasket db)
Check whether the given Stock is contained in the filtered Stock.

Specified by:
containsStock in interface Stock
Parameters:
st - the Stock for which to check containment.
db - the DataBasket used to determine visibility.
Override:
Never

SalesPoint Framework v3.1