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.4 and 1.19

version 1.1.2.4, 2001/12/09 02:57:09

version 1.19, 2008/02/08 19:24:22

Line 1

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

//%2006////////////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

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

Line 21

Line 29

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By:

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

Line 31

Line 36

#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

class WQLSelectStatementRep;

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

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

Line 51

Line 65

WHERE <where clause>

</pre>

The properties are obtained with the getProperties() method. The class

There are methods for obtaining the various elements of the select

name is obtained with getClassName(). The where clause is evaluated by

statement.

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

static const WQLSelectStatement EMPTY;

Boolean evaluate(const CIMInstance& inCI);

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

// SELECT *

// FROM TargetClass

// WHERE ...

String _className;

void validate();

CIMPropertyList getPropertyList(

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

const CIMObjectPath& inClassName = CIMObjectPath());

// and "lastName" below.

// SELECT firstName, lastName

// FROM TargetClass

// WHERE ...

Array<String> _propertyNames;

Array<CIMObjectPath> getClassPathList() const;

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.4
changed lines
	Added in v.1.19

No CVS admin address has been configured