version 1.15, 2001/07/10 22:31:21
|
version 1.32, 2007/07/06 13:50:36
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%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_InheritanceTree_h | #ifndef Pegasus_InheritanceTree_h |
|
|
| |
#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. |
| |
|
|
@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( |
|
const String& className, |
|
const String& superClassName, |
|
InheritanceTree& parentTree, |
|
NameSpace* parent); |
| |
/** Scan directory for file names of the form <ClassName>.<SuperClass> and | /** Scan directory for file names of the form <ClassName>.<SuperClass> and |
call insert on insert for each one. Note that root classes (classes with | call insert on insert for each one. Note that root classes (classes with |
|
|
@exception throws CannotOpenDirectory is invalid path specifies an | @exception throws CannotOpenDirectory is invalid path specifies an |
invalid directory. | invalid directory. |
*/ | */ |
void insertFromPath(const String& path); |
void insertFromPath(const String& path, |
|
InheritanceTree* parentTree = NULL, |
|
NameSpace* ns = NULL); |
| |
/** 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 |
|
|
@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. | /** Returns true if class1 is a subclass of class2. |
*/ | */ |
Boolean isSubClass(const String& class1, const String& class2); |
Boolean isSubClass(const CIMName& class1, const CIMName& class2) const; |
|
#endif |
| |
/** Get the names of all superclasses of this class (direct and indirect). | /** Get the names of all superclasses of this class (direct and indirect). |
*/ | */ |
Boolean getSuperClassNames( | Boolean getSuperClassNames( |
const String& className, |
const CIMName& className, |
Array<String>& subClassNames) const; |
Array<CIMName>& subClassNames) const; |
| |
/** Get the superclass of the given class. | /** Get the superclass of the given class. |
@param className name of class. | @param className name of class. |
|
|
@return true if class was found; false otherwise. | @return true if class was found; false otherwise. |
*/ | */ |
Boolean getSuperClass( | Boolean getSuperClass( |
const String& className, |
const CIMName& className, |
String& superClassName) const; |
CIMName& superClassName) const; |
| |
/** Returns true if the given class has sub-classes. */ | /** Returns true if the given class has sub-classes. */ |
Boolean hasSubClasses( | Boolean hasSubClasses( |
const String& className, |
const CIMName& className, |
Boolean& hasSubClasses) const; | Boolean& hasSubClasses) const; |
| |
/** Returns true if this inhertance tree contains the given class. */ | /** Returns true if this inhertance tree contains the given class. */ |
Boolean containsClass(const String& className) const; |
Boolean containsClass(const CIMName& className) const; |
| |
/** Removes the given class from the class graph. | /** Removes the given class from the class graph. |
@exception CIMException(CIM_ERR_CLASS_HAS_CHILDREN) | @exception CIMException(CIM_ERR_CLASS_HAS_CHILDREN) |
@exception CIMException(CIM_ERR_INVALID_CLASS) | @exception CIMException(CIM_ERR_INVALID_CLASS) |
*/ | */ |
void remove(const String& className); |
void remove(const CIMName& className, |
|
InheritanceTree& parentTree, |
|
NameSpace* ns = NULL); |
| |
/** Prints the class */ | /** Prints the class */ |
void print(PEGASUS_STD(ostream)& os) const; | void print(PEGASUS_STD(ostream)& os) const; |
|
|
InheritanceTree& operator=(const InheritanceTree&) { return *this; } | 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 |