version 1.16, 2001/12/13 14:53:55
|
version 1.40, 2008/03/05 21:31:45
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM |
// 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 | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_QualifierList_h | #ifndef Pegasus_QualifierList_h |
#define Pegasus_QualifierList_h | #define Pegasus_QualifierList_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/Common/Linkage.h> |
|
#include <Pegasus/Common/Constants.h> |
|
#include <Pegasus/Common/CIMName.h> |
#include <Pegasus/Common/CIMQualifier.h> | #include <Pegasus/Common/CIMQualifier.h> |
|
#include <Pegasus/Common/CIMScope.h> |
#include <Pegasus/Common/Array.h> | #include <Pegasus/Common/Array.h> |
#include <Pegasus/Common/Pair.h> | #include <Pegasus/Common/Pair.h> |
|
#include <Pegasus/Common/Buffer.h> |
|
#include <Pegasus/Common/OrderedSet.h> |
| |
|
|
|
/* ATTN: P2 KS 25 Mar 2002 - The function names are a mismash of local and |
|
taken from the class and instance functions. Thus, we have getCount but |
|
getQualifier. This causes confusion with the functions in class and |
|
instance which are specifically getQualifier. We should clean up so the |
|
names here remove the Qualifier portion. |
|
*/ |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class DeclContext; | class DeclContext; |
| |
|
/* ATTN: KS P3 DEFER 1 May 2002. |
|
We have list processors (really array processors) for |
|
qualifiers, properties, methods(???) but they are all slightly different. |
|
Should we create a common base?? |
|
*/ |
|
/** This class is for representing Qualifier lists in the CIM interface. |
|
|
|
Members are provided for accessing elements of the the internal property |
|
list. There are none for modifying elements (the entire array must be |
|
formed and passed to the constructor or replaced by calling set()). |
|
*/ |
|
|
class PEGASUS_COMMON_LINKAGE CIMQualifierList | class PEGASUS_COMMON_LINKAGE CIMQualifierList |
{ | { |
public: | public: |
| |
|
/// constructor - Constructs a NULL qualifier list. |
CIMQualifierList(); | CIMQualifierList(); |
| |
|
/// |
~CIMQualifierList(); | ~CIMQualifierList(); |
| |
|
/** add adds a single CIMQualifier to a CIMQualifierList |
|
*/ |
CIMQualifierList& add(const CIMQualifier& qualifier); | CIMQualifierList& add(const CIMQualifier& qualifier); |
| |
|
/** getCount - Returns the count of qualifiers in the list |
|
@return Zero origin count of qualifiers in the qualifier list. |
|
*/ |
Uint32 getCount() const | Uint32 getCount() const |
{ | { |
return _qualifiers.size(); | return _qualifiers.size(); |
} | } |
| |
CIMQualifier& getQualifier(Uint32 pos); |
/** getQualifer - Gets the qaulifier defined at the index provided |
|
in the Qualifier list. |
|
@param index - The position in the qualifierlist containing the |
|
qualifier. |
|
@return CIMQualifier object. |
|
@exception - Throws OutofBounds exception of pso not within the |
|
qualifier list. |
|
ATTN: P0 KS Mar 2002 Add the outofbounds exception. |
|
*/ |
|
CIMQualifier& getQualifier(Uint32 index); |
| |
const CIMQualifier& getQualifier(Uint32 pos) const |
const CIMQualifier& getQualifier(Uint32 index) const |
{ | { |
return _qualifiers[pos]; |
return _qualifiers[index]; |
} | } |
// ATTN: KS 18 may 2001 |
|
/** removeQualifier - Removes the Qualifier defined by | /** removeQualifier - Removes the Qualifier defined by |
the pos parameter |
the index parameter |
@exception Throws "OutOfBounds" if pos not within |
@exception IndexOutOfBoundsException if index not within |
range of current qualifiers. | range of current qualifiers. |
*/ | */ |
void removeQualifier(Uint32 pos); |
void removeQualifier(Uint32 index); |
| |
Uint32 find(const String& name) const; |
/** |
|
Removes all the qualifiers from the list. |
|
*/ |
|
void clear(); |
| |
Uint32 findReverse(const String& name) const; |
/** find - Searches for a qualifier with the specified ` |
|
input name if it exists in the class |
|
@param name CIMName of the qualifier |
|
to be found @return Position of the qualifier in the Class. |
|
@return Returns index of the qualifier found or PEG_NOT_FOUND |
|
if not found. |
|
*/ |
|
Uint32 find(const CIMName& name) const; |
| |
void resolve( |
/** exists - Returns true if the qualifier with the |
DeclContext* declContext, |
specified name exists in the class |
const String& nameSpace, |
@param name CIMName name of the qualifier object being tested. |
Uint32 scope, |
@return True if the qualifier exits in the list. Otherwise |
Boolean isInstancePart, |
false is returned. |
CIMQualifierList& inheritedQualifiers); |
*/ |
| |
void toXml(Array<Sint8>& out) const; |
Boolean exists(const CIMName& name) const |
|
{ |
|
return (find(name) != PEG_NOT_FOUND); |
|
} |
| |
void toMof(Array<Sint8>& out) const; |
/** isTrue - Determines if the qualifier defined by |
|
the input parameter exists for the class, is Boolean, and |
|
has a value of true. |
|
This function is useful to quickly determine the state of a |
|
qualifier. |
|
@param CIMName containing the qualifier name. |
|
@return Boolean True if the qualifier exists, |
|
*/ |
|
Boolean isTrue(const CIMName& name) const; |
| |
|
/** resolve - Resolves the qualifierList based on the information provided. |
|
The resolved qualifiers are the result of validating and testing the |
|
qualifiers against the inherited qualifiers and qualifier declarations. |
|
The qualifier list contains the set of resolved qualifiers when the |
|
function is complete. |
|
|
|
Resolution includes: |
|
1. Determining if the qualifier is declared (obtainable form |
|
declContext). |
|
2. Qualifier is same type as declaration |
|
3. Valid for the scope provided (Qualifier scope contains the provided |
|
scope). |
|
4. Whether qualifier can be overridden. |
|
5. Whether it should be propagated to subclass |
|
If a qualifier can be overridden it is put into the qualifiers array. |
|
|
|
@param declContext Declaration context for this resolution (ex |
|
repository, simple) |
|
@param nameSpace Namespace in which to find the declaration. |
|
@param scope - Scope of the entity doing the resolution (ex. Class, |
|
association, etc.) |
|
@param isInstancePart - TBD |
|
@param inheritedQualifiers - CimQualifierList defining List of |
|
inherited qualifiers |
|
@param propagateQualifiers Boolean indicator whether to propagate |
|
qualifiers. |
|
@exception - There are a number of different |
|
*/ |
|
void resolve( |
|
DeclContext* declContext, |
|
const CIMNamespaceName & nameSpace, |
|
CIMScope scope, |
|
Boolean isInstancePart, |
|
CIMQualifierList& inheritedQualifiers, |
|
Boolean propagateQualifiers); |
| |
|
/// |
void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const; | void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const; |
| |
|
/// |
Boolean identical(const CIMQualifierList& x) const; | Boolean identical(const CIMQualifierList& x) const; |
| |
|
/// |
void cloneTo(CIMQualifierList& x) const; | void cloneTo(CIMQualifierList& x) const; |
| |
|
Boolean isKey() const; |
|
|
private: | private: |
| |
Array<CIMQualifier> _qualifiers; |
typedef OrderedSet<CIMQualifier, |
|
CIMQualifierRep, |
|
PEGASUS_QUALIFIER_ORDEREDSET_HASHSIZE> QualifierSet; |
|
QualifierSet _qualifiers; |
|
|
|
/** Index of key qualifier or the meaning is as follows: |
|
PEGASUS_ORDEREDSET_INDEX_NOTFOUND -- |
|
there is no key qualifier in the list. |
|
PEGASUS_ORDEREDSET_INDEX_UNKNOWN -- |
|
the index is unresolved. |
|
*/ |
|
Uint32 _keyIndex; |
|
|
|
friend class CIMPropertyInternal; |
}; | }; |
| |
|
/** |
|
Applies a specified qualifier list to a specified object, using an |
|
addQualifier method which is expected to exist for the object type. |
|
@param qualifierList The CIMQualifierList to apply to the object. |
|
@param object The object to which to apply the qualifierList. |
|
*/ |
|
template <class T> |
|
void applyQualifierList(CIMQualifierList& qualifierList, T& object) |
|
{ |
|
for (Uint32 i = 0; i < qualifierList.getCount(); i++) |
|
{ |
|
object.addQualifier(qualifierList.getQualifier(i)); |
|
} |
|
qualifierList.clear(); |
|
} |
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif /* Pegasus_QualifierList_h */ | #endif /* Pegasus_QualifierList_h */ |