Return to CQLSelectStatement.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / CQL

BUG#: 1907

TITLE: CQL updates

DESCRIPTION: CQL updates

#ifndef CQLSELECTSTATEMENT_H_HEADER_INCLUDED_BEE5C36E
#define CQLSELECTSTATEMENT_H_HEADER_INCLUDED_BEE5C36E

#include <Pegasus/Common/Config.h>
#include <Pegasus/CQL/SelectStatement.h>
#include <Pegasus/CQL/CQLChainedIdentifier.h>
#include <Pegasus/CQL/CQLIdentifier.h>

#include <Pegasus/CQL/Linkage.h>


PEGASUS_NAMESPACE_BEGIN

/**  
This class is derived from the SelectStatement base class.  
The purpose of this class is to perform the select statement operations for
CIM Query Language (CQL). 

Notes on CQLSelectStatement class:

(A) Contains a CQLPredicate for the WHERE clause
(B) Contains an array of CQLIdentifiers for the SELECT projection
(C) Contains an array of classpaths from the FROM clause


   */
//##ModelId=40D98176032C
class PEGASUS_CQL_LINKAGE CQLSelectStatement : public SelectStatement
{
  public:
    /**  This is the constructor for the CQLSelectStatement object.  
           The ctor requires 3 parameters:   
                 query language (qlang) which is CQL,  
                 the query itself, 
                 and the name of the CIM namespace.
       */
    //##ModelId=40D9CF6C0307
    CQLSelectStatement(
        /**  The query language is needed so the
              base class can retrieve the query language.
              The class member variable where this data
              is stored is located in the base SelectStatement
              class.
           */
        String inQlang, 
        /**  input parameter containing the query string.
           */
        String inQuery, 
        
        QueryContext& inCtx);

    /**  Implements the evaluate method from the
          base SelectStatement class.
    
       */
    //##ModelId=40D9CF4B01C0
    Boolean evaluate(
        /**  The CIM instance that will be evaluated.
               The CIMInstance object is not modified by this method.
           */
        CIMInstance const inCI);

    /**  Implements the executeQuery method from the
          base SelectStatement class.
       */
    //##ModelId=40D9CF5000C3
    Array<CIMInstance> executeQuery(
        /** Input parameter that is an array of CIM Instance objects on which
             to execute the query.
           */
        Array<CIMInstance> inCIMInstanceArray) throw(Exception);

    /**  Implements the applyProjection method from the
          base SelectStatement class.
       */
    //##ModelId=40D9CF5403CC
    CIMInstance applyProjection(
        /**  Input the CIMInstance object in which to apply the
              projection.
           */
        CIMInstance inCI) throw(Exception);

    /**  Implements the validatedClass method from the
          base SelectStatement class.
       */
    //##ModelId=410513ED03D0
    void validateClass(const CIMObjectPath& inClassName) throw(Exception);

    /**  Implements the validatedProperties method from the
          base SelectStatement class.
       */
    //##ModelId=40D9CF5E0054
    void validateProperties() throw(Exception);

    /** Returns an array of CIMObjectPath objects that are the 
          class paths from the select statement in the FROM list.
     */
    //##ModelId=40F43FE503C2
    Array<CIMObjectPath> const getClassPathList();

    /** Returns the required properties from the combined SELECT and WHERE
         clauses for the classname passed in.
    
         If all the properties for the input classname are required, a null
         CIMPropertyList is returned.
       */
    //##ModelId=410512AC0316
    CIMPropertyList getPropertyList(
        /**  The input parameter className is one of the
              classes from the FROM list.
           */
        const CIMObjectPath& inClassName);

    /** Modifier. This method should not be called by the user (only by the
            parser).
         Appends a CQLIdentifier to an array of CIMObjectPaths from the FROM
    statement.
        */
    //##ModelId=40E01E7B01EE
    void appendClassPath(
        /**  
           */
        const CQLIdentifier& inIdentifier);

    /** Sets a predicate into this object. This method should only
            be called by Bison.
        */
    //##ModelId=40E0398E0346
    void setPredicate(
        // CQLOperation is an enum similar to the WQLOperation enum in CVS:
        // enum CQLOperation
        // {
        //     <,
        //     >,
        //     =,
        //    >=,
        //    <=,
        //     +,
        //     -,
        //     *,
        //     /,
        //     CQL_IS_NULL,
        //     CQL_IS_NOT_NULL,
        //     CQL_IS_A,
        //     CQL_LIKE
        // };
        CQLPredicate inPredicate);

    /**  This method calls QueryContext::insertClassPathAlias()  to insert a
    classpath-alias pair
          into the hash table.  The record is keyed by the class alias.
    
         This method is used by Bison.
    
        TODO:  think about exceptions such as duplicate key.
     */
    //##ModelId=40E03D3A03CC
    void insertClassPathAlias(
        /**  The CQLIdentifier object that contains the class path.
           */
        const CQLIdentifier& inIdentifier, 
        /**  The alias for the class.
           */
        String inAlias);

    /** Appends a CQL chained identifier to the CQL identifier list. The user
    should
            not call this method; it should only be called by the Bison.
        */
    //##ModelId=40F428D000A4
    void appendSelectIdentifier(const CQLChainedIdentifier& x);

    /** Appends a CQL Identifier to the where CQL identifier list. The user
    should not call this method; it should only be called by Bison.
    
            @param x  the CQL identifier.
            @return false if that identifier already exists.
    
    
        Since the identifiers in the WHERE clause must be distinct,
        a boolean is returned indicating if the identifier is not distinct.
    
     TODO:  THIS MAY BE NEEDED IN A FUTURE RELEASE.
       NOT IMPLEMENTED IN PEGASUS V2.5
        */
    //##ModelId=40F42AED028E
    Boolean appendWhereIdentifier(
        /**  Input the chained CQL identifiers to append. 
           */
        const CQLChainedIdentifier& x);

  protected:
    /** 
        // The list of CQL identifiers being selected. For example, see
    "firstName",
        // and "lastName" below.
        //
        //     SELECT firstName, lastName 
        //     FROM TargetClass
        //     WHERE ...
        //
        // NOTE: duplicate identifiers are not removed from the select list 
        // (e.g. SELECT firstName, firstName FROM...) results in a list of 
        // two identifiers
        //
    
        */
    //##ModelId=40F42CDC02EF
    Array<CQLIdentifier> _selectIdentifiers;

    /** 
        // The unique list of CQL query identifiers appearing in the WHERE clause.
        // Although a property may occur many times in the WHERE clause, it will
        // only appear once in this list.
        //
    
       TODO:  THIS MAY BE NEEDED IN A FUTURE RELEASE.
       NOT IMPLEMENTED IN PEGASUS V2.5
       */
    //##ModelId=40F42CE1006B
    Array<CQLIdentifier> _whereIdentifiers;

  private:
    //##ModelId=40F4427703B4
    CQLPredicate _predicate;

};

PEGASUS_NAMESPACE_END

#endif /* CQLSELECTSTATEMENT_H_HEADER_INCLUDED_BEE5C36E */