JObjectSampler.hh

Go to the documentation of this file.

#ifndef __JLANG__JOBJECTSAMPLER__
#define __JLANG__JOBJECTSAMPLER__
 
#include "JLang/JObjectIterator.hh"
#include "JLang/JPointer.hh"
#include "JLang/JSampler.hh"
 
 
/**
 * \author mdejong
 */
 
namespace JLANG {}
namespace JPP { using namespace JLANG; }
 
namespace JLANG {
 
  /**
   * Auxiliary class to sample objects from a rewindable object iterator.
   *
   * Method hasNext normally returns true, unless 
   * - there are no available objects; or
   * - given sampler rejects every object.
   *
   * Note that the internal sampler is a copy of the specified sampler and not a reference thereof.
   *
   * This class implements the JObjectIterator interface.
   */
  template<class T, template<class> class JSampler_t = JSampler>
  class JObjectSampler :
    public JObjectIterator<T>
  {
  public:
 
    typedef typename JObjectIterator<T>::pointer_type  pointer_type;
 
    /**
     * Constructor.
     *
     * \param  input      input
     */
    JObjectSampler(JRewindableObjectIterator<T>& input) :
      in      (input),
      has_next(false)
    {}
 
  
    /**
     * Constructor.
     *
     * \param  input      input
     * \param  sampler    sampler
     */
    JObjectSampler(JRewindableObjectIterator<T>& input,
                   const JSampler_t<T>&          sampler) :
      in      (input),
      has_next(false)
    {
      this->sampler = sampler;
    }
 
  
    /**
     * Check availability of next element.
     *
     * \return            true if the iteration has more elements; else false
     */
    virtual bool hasNext()
    {
      while (!has_next) {
 
        if (!in.hasNext()) {
          in.rewind();
        }
 
        if (in.hasNext()) {
 
          ps.set(in.next());
          
          skip_type ns = sampler(*ps);
 
          if (ns == 0) {
 
            has_next = true;
 
          } else {
 
            while ((ns -= in.skip(ns)) != 0) {
              in.rewind();
            }
          }
 
        } else {
 
          // nothing to sample
          
          break;
        }
      }
 
      return has_next;
    }
 
 
    /**
     * Get next element.
     *
     * \return            pointer to element
     */
    virtual const pointer_type& next() 
    {
      if (!has_next) {
        ps.reset(NULL);
      }
 
      has_next = false;
      
      return ps;
    }
 
 
    /**
     * Get sampler.
     *
     * \return            sampler
     */
    const JSampler_t<T>& getSampler() const
    {
      return sampler;
    }
 
 
    /**
     * Get sampler.
     *
     * \return            sampler
     */
    JSampler_t<T>& getSampler()
    {
      return sampler;
    }
 
  protected:
    JRewindableObjectIterator<T>& in;
    JSampler_t<T> sampler;
    JPointer  <T> ps;
    bool          has_next;
  };
}
 
#endif