//%2006//////////////////////////////////////////////////////////////////////// // // 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. // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; // EMC Corporation; VERITAS Software Corporation; The Open Group. // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; // EMC Corporation; Symantec 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. // //============================================================================== // // Author: Mike Brasher (mbrasher@bmc.com) // // Modified By: Carol Ann Krug Graves, Hewlett-Packard Company // (carolann_graves@hp.com) // David Dillard, VERITAS Software Corp. // (david.dillard@veritas.com) // //%///////////////////////////////////////////////////////////////////////////// #ifndef Pegasus_WQLSelectStatement_h #define Pegasus_WQLSelectStatement_h #include #include #include #include #include #include #include #include #include #include #include #include PEGASUS_NAMESPACE_BEGIN class WQLSelectStatementRep; /** This class represents a compiled WQL1 select statement. An instance of WQLSelectStatement is passed to WQLParser::parse() which parses the WQL1 SELECT statement and initializes the WQLSelectStatement instance. A WQL1 SELECT statement has the following form: 
	SELECT <property>...
	FROM <class name>
	WHERE <where clause>
There are methods for obtaining the various elements of the select statement. The components of the where clause are stored in two arrays: one for operands and one for operators (these are placed in proper order by the YACC parser). Evaluation is performed using a Boolean stack. See the implementation of evaluateWhereClause() for details. */ class PEGASUS_WQL_LINKAGE WQLSelectStatement: public SelectStatement { public: WQLSelectStatement(String& queryLang, String& query); WQLSelectStatement(String& queryLang, String& query, QueryContext& inCtx); /** Default constructor. */ WQLSelectStatement(); WQLSelectStatement(const WQLSelectStatement& statement); /** Destructor. */ ~WQLSelectStatement(); WQLSelectStatement& operator=(const WQLSelectStatement& rhs); /** Clears all data members of this object. */ void clear(); /** Accessor. */ const CIMName& getClassName() const; /** Modifier. This method should not be called by the user (only by the parser). */ void setClassName(const CIMName& className); /** Returns true if the query selects all properties ("*") */ Boolean getAllProperties() const; /** Used by the parser to indicate the query selects all properties ("*") This method should not be called by the user (only by the parser). */ void setAllProperties(const Boolean allProperties); /** Returns the number of property names which were indicated in the selection list. This function should only be used if getAllProperties() returns false. */ Uint32 getSelectPropertyNameCount() const; /** Gets the i-th selected property name in the list. This function should only be used if getAllProperties() returns false. */ const CIMName& getSelectPropertyName(Uint32 i) const; /** Returns the required properties from the SELECT clause for the specified class. @param inClassName name of the class; must be one of the classes from the FROM clause @return CIMPropertyList containing the required properties from the SELECT clause for the specified class; or a null CIMPropertyList if all properties of the specified class are required */ CIMPropertyList getSelectPropertyList (const CIMObjectPath& inClassName = CIMObjectPath ()); /** Appends a property name to the property name list. The user should not call this method; it should only be called by the parser. */ void appendSelectPropertyName(const CIMName& x); /** Returns the number of unique property names from the where clause. */ Uint32 getWherePropertyNameCount() const; /** Gets the i-th unique property appearing in the where clause. */ const CIMName& getWherePropertyName(Uint32 i) const; /** Returns the required properties from the WHERE clause for the specified class. @param inClassName name of the class; must be one of the classes from the FROM clause @return CIMPropertyList containing the required properties from the WHERE clause for the specified class; or a null CIMPropertyList if all properties of the specified class are required */ CIMPropertyList getWherePropertyList (const CIMObjectPath& inClassName = CIMObjectPath ()); /** Appends a property name to the where property name list. The user should not call this method; it should only be called by the parser. @param x name of the property. @return false if a property with that name already exists. */ Boolean appendWherePropertyName(const CIMName& x); /** Appends an operation to the operation array. This method should only be called by the parser itself. */ void appendOperation(WQLOperation x); /** Appends an operand to the operation array. This method should only be called by the parser itself. */ void appendOperand(const WQLOperand& x); /** Returns true if this class has a where clause. */ Boolean hasWhereClause() const; /** Evalautes the where clause using the symbol table to resolve symbols. */ Boolean evaluateWhereClause(const WQLPropertySource* source) const; /** Inspect an instance and remove properties not listed in Select projection. @param allowMissing Boolean specifying whether missing project properties are allowed @exception Exception */ void applyProjection(CIMInstance& inst, Boolean allowMissing); void applyProjection(CIMObject& inst, Boolean allowMissing); /** Prints out the members of this class. */ void print() const; static const WQLSelectStatement EMPTY; Boolean evaluate(const CIMInstance& inCI); void validate(); CIMPropertyList getPropertyList(const CIMObjectPath& inClassName = CIMObjectPath()); Array getClassPathList(); private: WQLSelectStatementRep* _rep; //void f() const { } friend class CMPI_Wql2Dnf; }; PEGASUS_NAMESPACE_END #endif /* Pegasus_WQLSelectStatement_h */