version 1.5.6.1, 2003/01/27 21:26:52
|
version 1.22.12.1, 2013/02/12 15:41:20
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// |
|
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
|
// The Open Group, Tivoli Systems |
|
// |
|
// 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. |
|
// | // |
//============================================================================== |
// Licensed to The Open Group (TOG) under one or more contributor license |
|
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
|
// this work for additional information regarding copyright ownership. |
|
// Each contributor licenses this file to you under the OpenPegasus Open |
|
// Source License; you may not use this file except in compliance with the |
|
// License. |
|
// |
|
// 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) |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
#define Pegasus_WQLSelectStatement_h | #define Pegasus_WQLSelectStatement_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/WQL/Linkage.h> |
#include <Pegasus/Common/ArrayInternal.h> | #include <Pegasus/Common/ArrayInternal.h> |
#include <Pegasus/Common/CIMName.h> | #include <Pegasus/Common/CIMName.h> |
#include <Pegasus/Common/CIMPropertyList.h> | #include <Pegasus/Common/CIMPropertyList.h> |
|
#include <Pegasus/Common/CIMInstance.h> |
|
#include <Pegasus/Common/CIMObject.h> |
#include <Pegasus/WQL/WQLOperation.h> | #include <Pegasus/WQL/WQLOperation.h> |
#include <Pegasus/WQL/WQLOperand.h> | #include <Pegasus/WQL/WQLOperand.h> |
#include <Pegasus/WQL/WQLPropertySource.h> | #include <Pegasus/WQL/WQLPropertySource.h> |
|
#include <Pegasus/Query/QueryCommon/SelectStatement.h> |
|
#include <Pegasus/Query/QueryCommon/QueryContext.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
|
|
|
class WQLSelectStatementRep; |
|
|
/** This class represents a compiled WQL1 select statement. | /** This class represents a compiled WQL1 select statement. |
| |
An instance of WQLSelectStatement is passed to WQLParser::parse() which | An instance of WQLSelectStatement is passed to WQLParser::parse() which |
|
|
YACC parser). Evaluation is performed using a Boolean stack. See the | YACC parser). Evaluation is performed using a Boolean stack. See the |
implementation of evaluateWhereClause() for details. | implementation of evaluateWhereClause() for details. |
*/ | */ |
class PEGASUS_WQL_LINKAGE WQLSelectStatement |
class PEGASUS_WQL_LINKAGE WQLSelectStatement: public SelectStatement |
{ | { |
public: | public: |
| |
|
WQLSelectStatement( |
|
const String& queryLang, |
|
const String& query); |
|
|
|
WQLSelectStatement( |
|
const String& queryLang, |
|
const String& query, |
|
const QueryContext& inCtx); |
|
|
/** Default constructor. | /** Default constructor. |
*/ | */ |
WQLSelectStatement(); | WQLSelectStatement(); |
| |
|
WQLSelectStatement(const WQLSelectStatement& statement); |
|
|
/** Destructor. | /** Destructor. |
*/ | */ |
~WQLSelectStatement(); | ~WQLSelectStatement(); |
| |
|
WQLSelectStatement& operator=(const WQLSelectStatement& rhs); |
|
|
/** Clears all data members of this object. | /** Clears all data members of this object. |
*/ | */ |
void clear(); | void clear(); |
| |
/** Accessor. | /** Accessor. |
*/ | */ |
const CIMName& getClassName() const |
const CIMName& getClassName() const; |
{ |
|
return _className; |
|
} |
|
| |
/** Modifier. This method should not be called by the user (only by the | /** Modifier. This method should not be called by the user (only by the |
parser). | parser). |
*/ | */ |
void setClassName(const CIMName& className) |
void setClassName(const CIMName& className); |
{ |
|
_className = className; |
|
} |
|
| |
/** | /** |
Returns true if the query selects all properties ("*") | Returns true if the query selects all properties ("*") |
|
|
selection list. | selection list. |
This function should only be used if getAllProperties() returns false. | This function should only be used if getAllProperties() returns false. |
*/ | */ |
Uint32 getSelectPropertyNameCount() const |
Uint32 getSelectPropertyNameCount() const; |
{ |
|
return _selectPropertyNames.size(); |
|
} |
|
| |
/** Gets the i-th selected property name in the list. | /** Gets the i-th selected property name in the list. |
This function should only be used if getAllProperties() returns false. | This function should only be used if getAllProperties() returns false. |
*/ | */ |
const CIMName& getSelectPropertyName(Uint32 i) const |
const CIMName& getSelectPropertyName(Uint32 i) const; |
{ |
|
return _selectPropertyNames[i]; |
|
} |
|
| |
/** | /** |
Returns a CIMPropertyList containing the selected properties. |
Returns the required properties from the SELECT clause for the specified |
The list is NULL if the query selects all properties (SELECT * FROM...). |
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 |
*/ | */ |
const CIMPropertyList getSelectPropertyList() const; |
CIMPropertyList getSelectPropertyList( |
|
const CIMObjectPath& inClassName = CIMObjectPath()); |
| |
/** Appends a property name to the property name list. The user should | /** Appends a property name to the property name list. The user should |
not call this method; it should only be called by the parser. | not call this method; it should only be called by the parser. |
*/ | */ |
void appendSelectPropertyName(const CIMName& x) |
void appendSelectPropertyName(const CIMName& x); |
{ |
|
_selectPropertyNames.append(x); |
|
} |
|
| |
/** Returns the number of unique property names from the where clause. | /** Returns the number of unique property names from the where clause. |
*/ | */ |
Uint32 getWherePropertyNameCount() const |
Uint32 getWherePropertyNameCount() const; |
{ |
|
return _wherePropertyNames.size(); |
|
} |
|
| |
/** Gets the i-th unique property appearing in the where clause. | /** Gets the i-th unique property appearing in the where clause. |
*/ | */ |
const CIMName& getWherePropertyName(Uint32 i) const |
const CIMName& getWherePropertyName(Uint32 i) const; |
{ |
|
return _wherePropertyNames[i]; |
|
} |
|
| |
/** | /** |
Returns a CIMPropertyList containing the unique properties used in the |
Returns the required properties from the WHERE clause for the specified |
WHERE clause |
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 |
*/ | */ |
const CIMPropertyList getWherePropertyList() const; |
CIMPropertyList getWherePropertyList( |
|
const CIMObjectPath& inClassName = CIMObjectPath()); |
| |
/** Appends a property name to the where property name list. The user | /** 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. | should not call this method; it should only be called by the parser. |
|
|
/** Appends an operation to the operation array. This method should only | /** Appends an operation to the operation array. This method should only |
be called by the parser itself. | be called by the parser itself. |
*/ | */ |
void appendOperation(WQLOperation x) |
void appendOperation(WQLOperation x); |
{ |
|
_operations.append(x); |
|
} |
|
| |
/** Appends an operand to the operation array. This method should only | /** Appends an operand to the operation array. This method should only |
be called by the parser itself. | be called by the parser itself. |
*/ | */ |
void appendOperand(const WQLOperand& x) |
void appendOperand(const WQLOperand& x); |
{ |
|
_operands.append(x); |
|
} |
|
| |
/** Returns true if this class has a where clause. | /** Returns true if this class has a where clause. |
*/ | */ |
Boolean hasWhereClause() const |
Boolean hasWhereClause() const; |
{ |
|
return _operations.size() != 0; |
|
} |
|
| |
/** Evalautes the where clause using the symbol table to resolve symbols. | /** Evalautes the where clause using the symbol table to resolve symbols. |
*/ | */ |
Boolean evaluateWhereClause(const WQLPropertySource* source) const; | 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. | /** Prints out the members of this class. |
*/ | */ |
void print() const; | void print() const; |
| |
private: |
Boolean evaluate(const CIMInstance& inCI); |
|
|
// |
|
// The name of the target class. For example: |
|
// |
|
// SELECT * |
|
// FROM TargetClass |
|
// WHERE ... |
|
// |
|
|
|
CIMName _className; |
|
|
|
// |
|
// Indicates that all properties are selected (i.e. SELECT * FROM ...) |
|
// |
|
Boolean _allProperties; |
|
|
|
// |
|
// The list of property names being selected. For example, see "firstName", |
|
// and "lastName" below. |
|
// |
|
// SELECT firstName, lastName |
|
// FROM TargetClass |
|
// WHERE ... |
|
// |
|
// NOTE: if the query selects all properties, this list is empty, and |
|
// _allProperties is true |
|
// |
|
// NOTE: duplicate property names are not removed from the select list |
|
// (e.g. SELECT firstName, firstName FROM...) results in a list of |
|
// two properties |
|
// |
|
|
|
Array<CIMName> _selectPropertyNames; |
|
| |
// |
void validate(); |
// 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<CIMName> _wherePropertyNames; |
CIMPropertyList getPropertyList( |
|
const CIMObjectPath& inClassName = CIMObjectPath()); |
| |
// |
Array<CIMObjectPath> getClassPathList() const; |
// 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; |
private: |
| |
// |
WQLSelectStatementRep* _rep; |
// The list of operands encountered while parsing the WHERE clause. The |
|
// query just above would generate the following stream of operands: |
|
// |
|
// count, 10, peak, 20, state, "OKAY" |
|
// |
|
| |
Array<WQLOperand> _operands; |
//void f() const { } |
| |
void f() const { } |
friend class CMPI_Wql2Dnf; |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |