cqlselectstatement.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

      Pre-condition: QueryContext has been set into this object.

      @param None
      @return Array of FROM list class paths.
      @throw CQLRuntimeException if the QueryContext had not been set.

      <I><B>Experimental Interface</B></I><BR>
     */
    Array<CIMObjectPath> getClassPathList();

    /**
      Returns the required properties from the combined SELECT and WHERE
      clauses for the classname passed in.  The classname parameter is
      needed in case scoping operators are used in the select statement.
      This function does not return properties for the classname if they
      are required on embedded objects.  This function does not return
      required array indices.

      Pre-condition: QueryContext has been set into this object.
      Post-condition: Chained identifiers have been normalized
      ie.applyContext has been called.  See the applyContext function.

      @param inClassName - class to determine the required properties.  Defaults
      to the FROM class.
      @return CIMPropertyList containing the required properties for the class.
      If all the properties are required, a null CIMPropertyList is returned.
      If no properties are required, an empty CIMPropertyList is returned.
      @throw CQLRuntimeException if the QueryContext had not been set.
      @throw CQLValidationException for applyContext error.
      @throw CQLSyntaxErrorException for applyContext error.

      <I><B>Experimental Interface</B></I><BR>
    */
    CIMPropertyList getPropertyList(const CIMObjectPath& inClassName = CIMObjectPath());

    /**
      Returns the required properties from the SELECT clause for the
      classname passed in.  The classname parameter is needed in case
      scoping operators are used in the select statement.  This function
      does not return properties for the classname if they are required
      on embedded objects. This function does not return required array indices.

      Pre-condition: QueryContext has been set into this object.
      Post-condition: Chained identifiers have been normalized
      ie.applyContext has been called.  See the applyContext function.

      @param inClassName - class to determine the required properties.  Defaults
      to the FROM class.
      @return CIMPropertyList containing the required properties for the class.
      If all the properties are required, a null CIMPropertyList is returned.
      If no properties are required, an empty CIMPropertyList is returned.
      @throw CQLRuntimeException if the QueryContext had not been set.
      @throw CQLValidationException for applyContext error.
      @throw CQLSyntaxErrorException for applyContext error.

      <I><B>Experimental Interface</B></I><BR>
    */
    CIMPropertyList getSelectPropertyList(const CIMObjectPath& inClassName = CIMObjectPath());

    /**
      Returns the required properties from the WHERE clause for the
      classname passed in.  The classname parameter is needed in case
      scoping operators are used in the select statement.  This function
      does not return properties for the classname if they are required
      on embedded objects.  This function does not return required array indices.

      Pre-condition: QueryContext has been set into this object.
      Post-condition: Chained identifiers have been normalized
      ie.applyContext has been called.  See the applyContext function.

      @param inClassName - class to determine the required properties.  Defaults
      to the FROM class.
      @return CIMPropertyList containing the required properties for the class.
      If all the properties are required, a null CIMPropertyList is returned.
      If no properties are required, an empty CIMPropertyList is returned.
      @throw CQLRuntimeException if the QueryContext had not been set.
      @throw CQLValidationException for applyContext error.
      @throw CQLSyntaxErrorException for applyContext error.

      <I><B>Experimental Interface</B></I><BR>
    */
    CIMPropertyList getWherePropertyList(const CIMObjectPath& inClassName = CIMObjectPath());

    /**
      Returns the chained identifiers from the SELECT clause.  These chained
      identifiers contain the fully qualified property names, including embedded
      objects, array indices, scoping operators, and symbolic constants.

      Post-condition: Chained identifiers have been normalized
      ie.applyContext has been called.  See the applyContext function.

      @param None
      @return Array of chained identifiers.
      @throw CQLValidationException for applyContext error.
      @throw CQLSyntaxErrorException for applyContext error.

      <I><B>Experimental Interface</B></I><BR>
     */
    Array<CQLChainedIdentifier> getSelectChainedIdentifiers();

    /**
      Returns the chained identifiers from the WHERE clause.  These chained
      identifiers contain the fully qualified property names, including embedded
      objects, array indices, scoping operators, and symbolic constants.

      Pre-condition: QueryContext has been set into this object.
      Post-condition: Chained identifiers have been normalized
      ie.applyContext has been called.  See the applyContext function.

      @param None
      @return Array of chained identifiers.
      @throw CQLRuntimeException if the QueryContext had not been set.
      @throw CQLValidationException for applyContext error.
      @throw CQLSyntaxErrorException for applyContext error.

      <I><B>Experimental Interface</B></I><BR>
     */
    Array<CQLChainedIdentifier> getWhereChainedIdentifiers();

    /**
      Gets the top-level CQLPredicate of this object.
      This is the predicate that contains the top-level
      of any nested boolean operations in the WHERE clause.

      @param None.
      @return Top-level predicate
      @throw None.

      <I><B>Experimental Interface</B></I><BR>
    */
    CQLPredicate getPredicate() const;

    /**
      Determines whether the select statement has a WHERE clause.

      @param None
      @return True if there is a WHERE clause.
      @throw None

      <I><B>Experimental Interface</B></I><BR>
    */
    Boolean hasWhereClause();

    /**
      Returns the select statement in string form.
      Note that this can be different than the original
      statement after it has been parsed, and applyContext
      has been called.

      Pre-condition: QueryContext has been set into this object.

      @param None
      @return String containing the select statement.
      @throw

      <I><B>Experimental Interface</B></I><BR>
    */
    String toString();

    /*
       ATTN - the following methods should only be set by CQLParser.
       These should be made private, and CQLParser made a friend.
    */

    /**
      Appends a CQLIdentifier/alias combination into the FROM list of the
      statement. This method should only be called by the CQL parser.

      @param inIdentifier - CQLIdentifier to append.
      @param inAlias - Alias of the identifier.
      @return None
      @throw QueryException if the identifier/alias cannot be appended.

      <I><B>Experimental Interface</B></I><BR>
    */
    void insertClassPathAlias(const CQLIdentifier& inIdentifier,
                              String inAlias);

    /**
      Appends a CQLIdentifier into the FROM list of the statement.
      This method should only be called by the CQL parser.

      @param inIdentifier - CQLIdentifier to append.
      @return None
      @throw QueryException if the identifier cannot be appended.

      <I><B>Experimental Interface</B></I><BR>
    */
    void appendClassPath(const CQLIdentifier& inIdentifier);

    /**
      Appends a CQLChainedIdentifier to the select list.
      This method should only be called by the CQL parser.

      @param x - CQLChainedIdentifier to append.
      @return None
      @throw None

      <I><B>Experimental Interface</B></I><BR>
    */
    void appendSelectIdentifier(const CQLChainedIdentifier& x);

    /** Sets a predicate into this object. This method should only
            be called by Bison.
        */
    /**
      Sets the top-level CQLPredicate into this object.
      This method should only be called by the CQL parser.

      @param Predicate to set into this object.
      @return None
      @throw None.

      <I><B>Experimental Interface</B></I><BR>
    */
    void setPredicate(const CQLPredicate& inPredicate);

    /**
      Sets the select statement to have a WHERE clause.
      This method should only be called by the CQL parser.

      @param None
      @return None
      @throw None

      <I><B>Experimental Interface</B></I><BR>
    */
    void setHasWhereClause();

    /**
      Clears the internal data structures.
      This method should only be called by the CQL parser.

      Pre-condition: QueryContext has been set into this object.

      @param None
      @return None.
      @throw CQLRuntimeException if the QueryContext had not been set.

      <I><B>Experimental Interface</B></I><BR>
    */
    void clear();

  private:
    CQLSelectStatementRep* _rep;

};

PEGASUS_NAMESPACE_END
#endif
#endif