OWBI1_WQLSelectStatement.hpp

Go to the documentation of this file.

//%/////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,
// The Open Group, Tivoli Systems
// Portions Copyright (C) 2003-2004 Vintela, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
// Author: Mike Brasher (mbrasher@bmc.com)
//
// Modified By: Dan Nuffer
//
//%/////////////////////////////////////////////////////////////////////////////
#ifndef OWBI1_WQL_SELECT_STATEMENT_HPP_INCLUDE_GUARD_H_
#define OWBI1_WQL_SELECT_STATEMENT_HPP_INCLUDE_GUARD_H_
#include "OWBI1_config.h"
#include "OWBI1_Array.hpp"
#include "OWBI1_String.hpp"
#include "OWBI1_WQLOperation.hpp"
#include "OWBI1_WQLOperand.hpp"
#include "OWBI1_WQLPropertySource.hpp"

namespace OWBI1
{

class WQLCompile;
class OWBI1_OWBI1PROVIFC_API WQLSelectStatement
{
public:
   WQLSelectStatement();
   ~WQLSelectStatement();
   void clear();
   const String& getClassName() const
   {
      return _className;
   }
   void setClassName(const String& className)
   {
      _className = className;
   }
   UInt32 getSelectPropertyNameCount() const
   {
      return _selectPropertyNames.size();
   }
   const String& getSelectPropertyName(UInt32 i) const
   {
      return _selectPropertyNames[i];
   }
   const StringArray& getSelectPropertyNames() const
   {
      return _selectPropertyNames;
   }
   void appendSelectPropertyName(const String& x)
   {
      _selectPropertyNames.append(x);
   }
   UInt32 getWherePropertyNameCount() const
   {
      return _wherePropertyNames.size();
   }
   const String& getWherePropertyName(UInt32 i) const
   {
      return _wherePropertyNames[i];
   }
   bool appendWherePropertyName(const String& x);
   void appendOperation(WQLOperation x)
   {
      _operStack.push_back(x);
   }
   void appendOperand(const WQLOperand& x)
   {
      _operStack.push_back(x);
   }
   bool hasWhereClause() const
   {
      return !_operStack.empty();
   }
   bool evaluateWhereClause(const WQLPropertySource* source) const;
   void print(std::ostream& ostr) const;
   String toString() const;
   void compileWhereClause(const WQLPropertySource* source, WQLCompile& wcl);
private:

#ifdef OWBI1_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   //
   // The name of the target class. For example:
   //
   //  SELECT * 
   //  FROM TargetClass
   //  WHERE ...
   //
   String _className;
   //
   // The list of property names being selected. For example, see "firstName",
   // and "lastName" below.
   //
   //  SELECT firstName, lastName 
   //  FROM TargetClass
   //  WHERE ...
   //
   Array<String> _selectPropertyNames;
   //
   // The unique list of property names appearing in the WHERE clause.
   // Although a property may occur many times in the WHERE clause, it will
   // only appear once in this list.
   //
   Array<String> _wherePropertyNames;
   //
   // The list of operations encountered while parsing the WHERE clause.
   // Consider this query:
   //
   //  SELECT *
   //  FROM TargetClass
   //  WHERE count > 10 OR peak < 20 AND state = "OKAY"
   //
   // This would generate the following stream of WQLOperations:
   //
   //  WQL_GT
   //  WQL_LT
   //  WQL_EQ
   //  WQL_AND
   //  WQL_OR
   //
   //Array<WQLOperation> _operations;
   // 
   // The list of operands encountered while parsing the WHERE clause. They
   // query just above would generate the following stream of operands:
   //
   //  count, 10, peak, 20, state, "OKAY"
   //
   //Array<WQLOperand> _operands;
   struct OperandOrOperation
   {
      enum Type
      {
         OPERATION,
         OPERAND
      };
      OperandOrOperation(WQLOperation o)
         : m_type(OPERATION)
         , m_operation(o)
      {}
      OperandOrOperation(const WQLOperand& o)
         : m_type(OPERAND)
         , m_operand(o)
      {}
      Type m_type;
      WQLOperation m_operation;
      WQLOperand m_operand;
      String toString() const
      {
         if (m_type == OPERATION)
         {
            return WQLOperationToString(m_operation);
         }
         else
         {
            return m_operand.toString();
         }
      }
   };
   Array<OperandOrOperation> _operStack;
   friend class WQLCompile;

#ifdef OWBI1_WIN32
#pragma warning (pop)
#endif

};

} // end namespace OWBI1

#endif

---