pegasus/src/Pegasus/Repository/InheritanceTree.h - diff

Return to InheritanceTree.h CVS log

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

Diff for /pegasus/src/Pegasus/Repository/InheritanceTree.h between version 1.10 and 1.33

version 1.10, 2001/05/20 20:34:03

version 1.33, 2008/08/19 17:19:20

Line 1

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

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

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

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

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

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

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

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

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

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

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

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

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

// DEALINGS IN THE SOFTWARE.

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

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

// rights to use, copy, modify, merge, publish, distribute, sublicense, 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:

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

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

#ifndef Pegasus_InheritanceTree_h

Line 30

Line 36

#include <iostream>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/ArrayInternal.h>

#include <Pegasus/Common/CIMName.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

struct InheritanceTreeRep;

class NameSpace;

/** The InheritanceTree class tracks inheritance relationships of CIM classes.

Line 106

Line 117

In this case, check() throws an InvalidInheritanceTree exception.

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>

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

{

Line 161

Line 136

@param superClassName - name of super class of class.

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

as a className argument to insert(). In other words, it checks that

Line 188

Line 158

@return true on success. False if no such class.

Boolean getSubClassNames(

const String& className,

const CIMName& className,

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 String& className,

const CIMName& className,

Array<String>& subClassNames) const;

Array<CIMName>& subClassNames) const;

/** Get the superclass of the given class.

@param className name of class.

Line 204

Line 181

@return true if class was found; false otherwise.

Boolean getSuperClass(

const String& className,

const CIMName& className,

String& superClassName) const;

CIMName& superClassName) const;

/** Returns true if the given class has sub-classes. */

Boolean hasSubClasses(

const String& className,

const CIMName& className,

Boolean& hasSubClasses) const;

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

@exception CIMException(CIMException::CLASS_HAS_CHILDREN)

@exception CIMException(CIM_ERR_CLASS_HAS_CHILDREN)

@exception CIMException(CIMException::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 */

void print(PEGASUS_STD(ostream)& os) const;

Line 231

Line 210

InheritanceTree& operator=(const InheritanceTree&) { return *this; }

InheritanceTreeRep* _rep;

friend struct InheritanceTreeNode;

};

/** The InvalidInheritanceTree exception is thrown when the

Line 238

Line 219

was not fully specified (when any class was passed as a superClassName

argument to insert() but never as a className argument.

class InvalidInheritanceTree : public Exception

class PEGASUS_REPOSITORY_LINKAGE InvalidInheritanceTree : public Exception

{

public:

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

Legend:

Removed from v.1.10
changed lines
	Added in v.1.33

No CVS admin address has been configured