NdbScanFilter.hpp

/*
   Copyright (C) 2003-2008 MySQL AB, 2008, 2009 Sun Microsystems, Inc.
    All rights reserved. Use is subject to license terms.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/

#ifndef NDB_SCAN_FILTER_HPP
#define NDB_SCAN_FILTER_HPP

#include <ndb_types.h>
#include "ndbapi_limits.h"

#include "NdbInterpretedCode.hpp"

class NdbScanFilter {
public:
  NdbScanFilter(NdbInterpretedCode* code);

  NdbScanFilter(class NdbOperation * op);

  ~NdbScanFilter();
  
  enum Group {
    AND  = 1,    
    OR   = 2,    
    NAND = 3,    
    NOR  = 4     
  };

  enum BinaryCondition 
  {
    COND_LE = 0,           
    COND_LT = 1,           
    COND_GE = 2,           
    COND_GT = 3,           
    COND_EQ = 4,           
    COND_NE = 5,           
    COND_LIKE = 6,         
    COND_NOT_LIKE = 7,     
    COND_AND_EQ_MASK = 8,  
    COND_AND_NE_MASK = 9,  
    COND_AND_EQ_ZERO = 10, 
    COND_AND_NE_ZERO = 11  
  };

  int begin(Group group = AND);    

  int end();

  int istrue();

  int isfalse();

  int cmp(BinaryCondition cond, int ColId, const void *val, Uint32 len = 0); 

  int eq(int ColId, Uint32 value) { return cmp(COND_EQ, ColId, &value, 4);}

  int ne(int ColId, Uint32 value) { return cmp(COND_NE, ColId, &value, 4);}  
  int lt(int ColId, Uint32 value) { return cmp(COND_LT, ColId, &value, 4);}
  int le(int ColId, Uint32 value) { return cmp(COND_LE, ColId, &value, 4);}
  int gt(int ColId, Uint32 value) { return cmp(COND_GT, ColId, &value, 4);} 
  int ge(int ColId, Uint32 value) { return cmp(COND_GE, ColId, &value, 4);}

  int eq(int ColId, Uint64 value) { return cmp(COND_EQ, ColId, &value, 8);}
  int ne(int ColId, Uint64 value) { return cmp(COND_NE, ColId, &value, 8);}
  int lt(int ColId, Uint64 value) { return cmp(COND_LT, ColId, &value, 8);}  
  int le(int ColId, Uint64 value) { return cmp(COND_LE, ColId, &value, 8);}
  int gt(int ColId, Uint64 value) { return cmp(COND_GT, ColId, &value, 8);}
  int ge(int ColId, Uint64 value) { return cmp(COND_GE, ColId, &value, 8);}
  int isnull(int ColId);             
  int isnotnull(int ColId);          
  
  enum Error {
    FilterTooLarge = 4294
  };

  const struct NdbError & getNdbError() const;

  const NdbInterpretedCode* getInterpretedCode() const;

  NdbOperation * getNdbOperation() const;
private:
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
  friend class NdbScanFilterImpl;
#endif
  class NdbScanFilterImpl & m_impl;
  NdbScanFilter& operator=(const NdbScanFilter&); 
};

#endif