pegasus/src/Pegasus/WQL/WQLSelectStatement.h - diff

Return to WQLSelectStatement.h CVS log

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

Diff for /pegasus/src/Pegasus/WQL/WQLSelectStatement.h between version 1.1.2.2 and 1.23

version 1.1.2.2, 2001/12/03 00:58:05

version 1.23, 2012/12/28 08:46:21

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%LICENSE////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Permission is hereby granted, free of charge, to any person obtaining a copy

// Licensed to The Open Group (TOG) under one or more contributor license

// of this software and associated documentation files (the "Software"), to

// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

// deal in the Software without restriction, including without limitation the

// this work for additional information regarding copyright ownership.

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// Each contributor licenses this file to you under the OpenPegasus Open

// sell copies of the Software, and to permit persons to whom the Software is

// Source License; you may not use this file except in compliance with the

// furnished to do so, subject to the following conditions:

// License.

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// Permission is hereby granted, free of charge, to any person obtaining a

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// copy of this software and associated documentation files (the "Software"),

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// to deal in the Software without restriction, including without limitation

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// and/or sell copies of the Software, and to permit persons to whom the

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// Software is furnished to do so, subject to the following conditions:

// 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.

// 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:

//%/////////////////////////////////////////////////////////////////////////////

Line 31

Line 34

#define Pegasus_WQLSelectStatement_h

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/WQL/Linkage.h>

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/ArrayInternal.h>

#include <Pegasus/Common/CIMName.h>

#include <Pegasus/Common/CIMPropertyList.h>

#include <Pegasus/Common/CIMInstance.h>

#include <Pegasus/Common/CIMObject.h>

#include <Pegasus/WQL/WQLOperation.h>

#include <Pegasus/WQL/WQLOperand.h>

#include <Pegasus/WQL/WQLPropertySource.h>

#include <Pegasus/Query/QueryCommon/SelectStatement.h>

#include <Pegasus/Query/QueryCommon/QueryContext.h>

PEGASUS_NAMESPACE_BEGIN

/** This class represents a compiled WBEMSQl1 select statement.

class WQLSelectStatementRep;

/** This class represents a compiled WQL1 select statement.

An instance of WQLSelectStatement is passed to WQLParser::parse() which

parses and WBEMSQL1 SELECT statement and initializes the WQLSelectStatement

parses the WQL1 SELECT statement and initializes the WQLSelectStatement

instance. The WBEMSWL1 SELECT statement has the following form:

instance. A WQL1 SELECT statement has the following form:

<pre>

SELECT <property>...

FROM <class name>

WHERE <where clause>

</pre>

The properties may be obtained with the getProperties() method.

There are methods for obtaining the various elements of the select

The class name may be obtained with getClassName(). The where clause

statement.

may be evaluated by calling evaluateWhereClause() with the appropriate

arguments. If hasWhereClause() returns false, then there is no where

clause.

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

class PEGASUS_WQL_LINKAGE WQLSelectStatement: public SelectStatement

{

public:

WQLSelectStatement(

const String& queryLang,

const String& query);

WQLSelectStatement(

const String& queryLang,

const String& query,

const 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 String& getClassName() const

const CIMName& getClassName() const;

{

return _className;

}

/** Modifier. This method should not be called by the user (only by the

parser).

void setClassName(const String& className)

void setClassName(const CIMName& className);

{

_className = 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 getPropertyNameCount() const

Uint32 getSelectPropertyNameCount() const;

{

return _propertyNames.size();

}

/** Gets the i-th 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.

const String& getPropertyName(Uint32 i)

const CIMName& getSelectPropertyName(Uint32 i) const;

{

return _propertyNames[i];

/**

}

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

/** Appends a property name to the property name list. This user should

@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 appendPropertyName(const String& x)

void appendSelectPropertyName(const CIMName& x);

{

_propertyNames.append(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)

void appendOperation(WQLOperation x);

{

_operations.append(x);

}

/** Appends an operand to the operation array. This method should only

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.

Boolean hasWhereClause() const

Boolean hasWhereClause() const;

{

return _operations.size() != 0;

}

/** Evalautes the where clause using the symbol table to resolve symbols.

Boolean evaluateWhereClause(const WQLPropertySource* symbolTable) 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.

void print() const;

private:

Boolean evaluate(const CIMInstance& inCI);

void validate();

// The name of the target class. For example:

// SELECT *

// FROM TargetClass

// WHERE ...

String _className;

CIMPropertyList getPropertyList(

const CIMObjectPath& inClassName = CIMObjectPath());

Array<CIMObjectPath> getClassPathList() const;

// The list of property names being selected. For example, see "firstName",

// and "lastName" below.

// SELECT firstName, lastName

// FROM TargetClass

// WHERE ...

Array<String> _propertyNames;

private:

// 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;

WQLSelectStatementRep* _rep;

//void f() const { }

// The list of operands encountered while parsing the WHERE clause. They

// query just above would generate the following stream of operands:

// count, 10, peak, 20, state, "OKAY"

Array<WQLOperand> _operands;

friend class CMPI_Wql2Dnf;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.1.2.2
changed lines
	Added in v.1.23

No CVS admin address has been configured