(file) Return to CQLExpression.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / CQL

Diff for /pegasus/src/Pegasus/CQL/CQLExpression.h between version 1.1 and 1.1.2.18

version 1.1, 2004/08/20 18:22:36 version 1.1.2.18, 2004/11/15 16:08:03
Line 0 
Line 1 
   //%2003////////////////////////////////////////////////////////////////////////
   //
   // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
   // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
   // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
   // IBM Corp.; EMC Corporation, The Open Group.
   //
   // 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.
   //
   //==============================================================================
   //
   // Authors: David Rosckes (rosckes@us.ibm.com)
   //          Bert Rivero (hurivero@us.ibm.com)
   //          Chuck Carmack (carmack@us.ibm.com)
   //          Brian Lucier (lucier@us.ibm.com)
   //
   // Modified By:
   //
   //%/////////////////////////////////////////////////////////////////////////////
   
   #ifndef Pegasus_CQLExpression_h
   #define Pegasus_CQLExpression_h
   
   #include <Pegasus/Common/Config.h>
   #include <Pegasus/CQL/CQLValue.h>
   #include <Pegasus/CQL/Linkage.h>
   #include <Pegasus/CQL/CQLTerm.h>
   
   #ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES
   
   PEGASUS_NAMESPACE_BEGIN
   
   class PEGASUS_CQL_LINKAGE CQLFactory;
   class PEGASUS_CQL_LINKAGE CQLExpressionRep;
   class PEGASUS_CQL_LINKAGE QueryContext;
   
   /**
       The enum is private, but the definition is public.
   */
   enum TermOpType {plus,minus};
   
   #ifndef PEGASUS_ARRAY_T
   #define PEGASUS_ARRAY_T TermOpType
   #include <Pegasus/Common/ArrayInter.h>
   #undef PEGASUS_ARRAY_T
   #endif
   
   /**
       The CQLExpression class encapsulates a generic CQL expression to make it
       easier to break into components and process the expression.
   */
   
   class PEGASUS_CQL_LINKAGE CQLExpression
   {
    public:
   
     /**
         Contructs CQLExpression default object.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     CQLExpression();
   
     /**
         Contructs CQLExpression with a CQLTerm.
   
         @param  - theTerm - A CQLTerm used to create CQLExpression.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     CQLExpression(const CQLTerm& theTerm);
   
     /**
         Contructs CQLExpression with a CQLExpression object. (copy-constructor)
   
         @param  - inExpress - Object to be copied.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     CQLExpression(const CQLExpression& inExpress);
   
     /**
         Destructs the CQLExpression object.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     ~CQLExpression();
   
     /** the resolveValue method evaluates the expression and returns the value.
         Any property that need to be resolved into a value is taken from the
         CIMInstance.
   
         @param  - CI - the CIMInstance to be evaluated.
         @param  - QueryCtx - The QueryContext used to access the repository.
         @return - CQLSyntaxErrorException
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     CQLValue resolveValue(const CIMInstance& CI, const QueryContext& QueryCtx);
   
     /** The appendOperation is used by Bison.
         It is invoked 0 or more times for the CQLExpression, and
         when invoked will always pass in an integer that is the Term operation
         type and a CQLTerm object.
   
         @param  - theTermOpType - the type of operation being appended.
         @param  - theTerm - the term to be operated on.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     void appendOperation(const TermOpType theTermOpType, const CQLTerm& theTerm);
   
     /**
         Returns a string representation of the object.
   
         @param  - None.
         @return - A string
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     String toString()const;
   
     /**
         Will return true if the object has only one CQLTerm object within it.
   
         @param  - None.
         @return - true or false
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     Boolean isSimple()const;
   
     /**
         Will return true if the CQLExpression resolves to a simple value.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     Boolean isSimpleValue()const;
   
     /**
         Retrieve an array of all the CQLTerms for this expression.
   
         @param  - None.
         @return - An array of CQLTerm.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     Array<CQLTerm> getTerms()const;
   
     /**
         Retrieve an array of all the TermOpType for this expression.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     Array<TermOpType> getOperators()const;
   
     /**
   
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     void applyContext(QueryContext& inContext,
                       CQLChainedIdentifier inCid = CQLChainedIdentifier());
   
     /**
         Contructs CQLTermRep default object.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     CQLExpression& operator=(const CQLExpression& rhs);
   
     /**
         Contructs CQLTermRep default object.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     Boolean operator==(const CQLExpression& expr)const;
   
     /**
         Contructs CQLTermRep default object.
   
         @param  - None.
         @return - None.
         @throw  - None.
         <I><B>Experimental Interface</B></I><BR>
     */
     Boolean operator!=(const CQLExpression& expr)const;
   
     friend class CQLFactory;
   
    private:
   
     CQLExpressionRep *_rep;
   };
   
   #ifndef PEGASUS_ARRAY_T
   #define PEGASUS_ARRAY_T CQLExpression
   #include <Pegasus/Common/ArrayInter.h>
   #undef PEGASUS_ARRAY_T
   #endif
   
   PEGASUS_NAMESPACE_END
   
   #endif

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.1.2.18
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2