version 1.5, 2001/04/27 20:44:38
|
version 1.34, 2008/12/01 17:51:08
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM |
// 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 | // Permission is hereby granted, free of charge, to any person obtaining a |
// copy of this software and associated documentation files (the "Software"), | // copy of this software and associated documentation files (the "Software"), |
|
|
// and/or sell copies of the Software, and to permit persons to whom the | // 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: | // Software is furnished to do so, subject to the following conditions: |
// | // |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
// The above copyright notice and this permission notice shall be included |
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
// in all copies or substantial portions of the Software. |
// 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) |
// 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. |
// | // |
// Modified By: |
////////////////////////////////////////////////////////////////////////// |
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
| |
#include <iostream> | #include <iostream> |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/Common/ArrayInternal.h> |
|
#include <Pegasus/Common/CIMName.h> |
#include <Pegasus/Common/String.h> | #include <Pegasus/Common/String.h> |
#include <Pegasus/Common/Exception.h> |
#include <Pegasus/Common/InternalException.h> |
|
#include <Pegasus/Repository/Linkage.h> |
|
#include <Pegasus/Common/MessageLoader.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
struct InheritanceTreeRep; | struct InheritanceTreeRep; |
|
class NameSpace; |
| |
/** The InheritanceTree class tracks inheritance relationships of CIM classes. | /** The InheritanceTree class tracks inheritance relationships of CIM classes. |
| |
|
|
In this case, check() throws an InvalidInheritanceTree exception. | In this case, check() throws an InvalidInheritanceTree exception. |
| |
The InheritanceTree may be printed by calling the print() method. | The InheritanceTree may be printed by calling the print() method. |
|
|
The insertFromPath() method is used to build up an InheritanceTree from |
|
the file names in a certain directory as used by the CIMRepository. The |
|
CIMRepository contains a disk file per class and the name has this form: |
|
|
|
<pre> |
|
<ClassName>.<SuperClassName> |
|
</pre> |
|
|
|
For example, a class called "ThisClass" with super class "ThatClass" |
|
has this name: |
|
|
|
<pre> |
|
ThisClass.ThisClass |
|
</pre> |
|
|
|
The file or course contains the XML encoding of the ThisClass class (which |
|
is irrelevant for the InheritanceTree). A root class (with no superclass |
|
has the following form): |
|
|
|
<pre> |
|
<ClassName>.# |
|
</pre> |
|
|
|
Suppose that ThatClass is a root class; then its file name is: |
|
|
|
<pre> |
|
ThatClass.# |
|
</pre> |
|
|
|
It must be obvious by now that the insertFromPath() method just scans |
|
the file names in a directory and calls insert() for each one (splitting |
|
the class name from superclass name and translating '#' to an empty string). |
|
|
|
The insertFromPath() method does NOT call check(), so it still must be |
|
called to verify the InheritanceTree. |
|
*/ | */ |
class PEGASUS_REPOSITORY_LINKAGE InheritanceTree | class PEGASUS_REPOSITORY_LINKAGE InheritanceTree |
{ | { |
|
|
@param superClassName - name of super class of class. | @param superClassName - name of super class of class. |
*/ | */ |
void insert(const String& className, const String& superClassName); | void insert(const String& className, const String& superClassName); |
|
void insert( |
/** Scan directory for file names of the form <ClassName>.<SuperClass> and |
const String& className, |
call insert on insert for each one. Note that root classes (classes with |
const String& superClassName, |
no superclass) will use "#" for a SuperClass name. |
InheritanceTree& parentTree, |
@param path - directory that contains files describing inheritance |
NameSpace* parent); |
infoformation. |
|
@exception throws CannotOpenDirectory is invalid path specifies an |
|
invalid directory. |
|
*/ |
|
void insertFromPath(const String& path); |
|
| |
/** Checks that every superClassName passed to insert() was also passed | /** Checks that every superClassName passed to insert() was also passed |
as a className argument to insert(). In other words, it checks that | as a className argument to insert(). In other words, it checks that |
|
|
*/ | */ |
void check() const; | void check() const; |
| |
/** Prints the class */ |
|
void print(std::ostream& os) const; |
|
|
|
/** Get subclass names of the given class. | /** Get subclass names of the given class. |
@param className - class whose subclass names will be gotten. If | @param className - class whose subclass names will be gotten. If |
className is empty, all classnames are returned. | className is empty, all classnames are returned. |
|
|
@return true on success. False if no such class. | @return true on success. False if no such class. |
*/ | */ |
Boolean getSubClassNames( | Boolean getSubClassNames( |
const String& className, |
const CIMName& className, |
Boolean deepInheritance, | Boolean deepInheritance, |
Array<String>& subClassNames) const; |
Array<CIMName>& subClassNames, |
|
NameSpace* ns = NULL) const; |
|
|
|
#if 0 |
|
/** Returns true if class1 is a subclass of class2. |
|
*/ |
|
Boolean isSubClass(const CIMName& class1, const CIMName& class2) const; |
|
#endif |
|
|
|
/** Get the names of all superclasses of this class (direct and indirect). |
|
*/ |
|
Boolean getSuperClassNames( |
|
const CIMName& className, |
|
Array<CIMName>& subClassNames) const; |
|
|
|
/** Get the superclass of the given class. |
|
@param className name of class. |
|
@param superClassName name of superclass upon return. |
|
@return true if class was found; false otherwise. |
|
*/ |
|
Boolean getSuperClass( |
|
const CIMName& className, |
|
CIMName& superClassName) const; |
|
|
|
/** Returns true if the given class has sub-classes. */ |
|
Boolean hasSubClasses( |
|
const CIMName& className, |
|
Boolean& hasSubClasses) const; |
|
|
|
/** Returns true if this inhertance tree contains the given class. */ |
|
Boolean containsClass(const CIMName& className) const; |
|
|
|
/** Removes the given class from the class graph. |
|
@exception CIMException(CIM_ERR_CLASS_HAS_CHILDREN) |
|
@exception CIMException(CIM_ERR_INVALID_CLASS) |
|
*/ |
|
void remove(const CIMName& className, |
|
InheritanceTree& parentTree, |
|
NameSpace* ns = NULL); |
|
|
|
/** Prints the class */ |
|
void print(PEGASUS_STD(ostream)& os) const; |
| |
private: | private: |
| |
|
InheritanceTree(const InheritanceTree&) { } |
|
|
|
InheritanceTree& operator=(const InheritanceTree&) { return *this; } |
|
|
InheritanceTreeRep* _rep; | InheritanceTreeRep* _rep; |
|
|
|
friend struct InheritanceTreeNode; |
}; | }; |
| |
/** The InvalidInheritanceTree exception is thrown when the | /** The InvalidInheritanceTree exception is thrown when the |
|
|
was not fully specified (when any class was passed as a superClassName | was not fully specified (when any class was passed as a superClassName |
argument to insert() but never as a className argument. | argument to insert() but never as a className argument. |
*/ | */ |
class InvalidInheritanceTree : public Exception |
class PEGASUS_REPOSITORY_LINKAGE InvalidInheritanceTree : public Exception |
{ | { |
public: | public: |
|
|
InvalidInheritanceTree(const String& className) | InvalidInheritanceTree(const String& className) |
: Exception("Invalid inheritance tree: unknown class: " + className) { } |
: Exception(MessageLoaderParms( |
|
"Repository.InheritanceTree.INVALID_INHERITANCE_TREE", |
|
"Invalid inheritance tree: unknown class: $0", className)) |
|
{ |
|
} |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |