CollectionFilterBase Class Reference Base class for collection filters. More... #include <collectionfilter.h> Inheritance diagram for CollectionFilterBase: [legend]List of all members. Public Member Functions virtual void  clear ()=0   Remove all objects from collection. virtual Storeable &  create ()=0   Create or return reference to Storeable derived object for getting tables or loading from database. virtual CollectionFilterIterator *  createIterator () const =0   Create new iterator for traversal. virtual const Storeable &  find (id pKey)   Find object with given id in collection. virtual std::vector< id >  getIds ()   Get array of id values for all objects in collection. virtual void *  getRef () const =0   Get pointer to collection. virtual void  put ()=0   Insert just loaded Storeable derived class to collection. virtual void  updateRef (void *pNewMember)=0   Update reference to collection. virtual  ~CollectionFilterBase ()   Destructor. Detailed Description Base class for collection filters. This base is used by streams to interact with user collections binded using BIND_COL store table entry. Member Function Documentation virtual Storeable& create (   )  [pure virtual]   Create or return reference to Storeable derived object for getting tables or loading from database. Returns: empty Storeable derived instance Implemented in InstanceFilter, Single, InstanceFilter< std::multiset< T >, T >, InstanceFilter< std::deque< T >, T >, InstanceFilter< std::vector< T >, T >, InstanceFilter< std::list< T >, T >, and InstanceFilter< std::set< T >, T >. virtual CollectionFilterIterator* createIterator (   )  const [pure virtual]   Create new iterator for traversal. Returns: new iterator instance Implemented in Single, stdDeque, stdList, stdMultiset, stdSet, and stdVector. virtual const Storeable& find (  id  pKey  )  [virtual]   Find object with given id in collection. Parameters: pKey  id of object to find virtual std::vector<id> getIds (   )  [virtual]   Get array of id values for all objects in collection. Returns: vector of id values virtual void put (   )  [pure virtual]   Insert just loaded Storeable derived class to collection. Filters for lists implements this by adding reference to Storeable object returned by create() to contained collection See also: InstanceFilter::put implmementation Implemented in InstanceFilter, Single, InstanceFilter< std::multiset< T >, T >, InstanceFilter< std::deque< T >, T >, InstanceFilter< std::vector< T >, T >, InstanceFilter< std::list< T >, T >, and InstanceFilter< std::set< T >, T >. virtual void updateRef (  void *  pNewMember  )  [pure virtual]   Update reference to collection. Used by streams to adjust member before using this filter Parameters: pNewMember  pointer to new class member or variable Implemented in CollectionFilter, CollectionFilter< std::set< T > >, CollectionFilter< Storeable >, CollectionFilter< std::multiset< T > >, CollectionFilter< std::vector< T > >, CollectionFilter< std::list< T > >, and CollectionFilter< std::deque< T > >. The documentation for this class was generated from the following file: collectionfilter.h		Documentation Quick start Examples Search API Documentation Class hierarchy Member index API Reference Store filters Store table macros
Back

---

Generated by doxygen at Sun Nov 9 02:08:17 2008