javax.cim
Class CIMClass

java.lang.Object
  javax.cim.CIMElement
      javax.cim.CIMClass

All Implemented Interfaces:

javax.cim.CIMNamedElementInterface, CIMQualifiedElementInterface, java.io.Serializable

public class CIMClass

extends CIMElement

implements CIMQualifiedElementInterface, javax.cim.CIMNamedElementInterface, java.io.Serializable

This class represents a CIM class as defined by the Distributed Management Task Force (DMTF) CIM Infrastructure Specification (DSP004). A CIMClass has the following attributes

an object path describing the location and name of the class

super class name (can be null if no super class)

an array of qualifiers for the class

an array of properties

an array of methods

Since:

JSR48 1.0.0

See Also:

Serialized Form

Constructor Summary

CIMClass(CIMObjectPath path, java.lang.String superclass, CIMQualifier[] qualifiers, CIMClassProperty[] props, CIMMethod[] pMethods, boolean pIsAssociation, boolean pIsKeyed)
Creates and instantiates a Java object representing a CIM Class.

CIMClass(java.lang.String name, java.lang.String superclass, CIMQualifier[] qualifiers, CIMClassProperty[] props, CIMMethod[] methods)
Creates and instantiates a Java object representing a CIM Class.

Method Summary

CIMClass	filterProperties(boolean localOnly, boolean includeQualifiers, boolean includeClassOrigin, java.lang.String[] propertyList) This method returns a new CIMClass with properties filtered according to the input parameters.
CIMClassProperty[]	getKeys() Returns a list of key properties for this CIM class.
CIMMethod	getMethod(int pIndex) Get a method by index.
CIMMethod	getMethod(java.lang.String name) Returns the specified CIM method in this CIM class.
CIMMethod	getMethod(java.lang.String name, java.lang.String originClass) Returns the CIM method specified by its name and optionally, its origin class.
int	getMethodCount() Get the number of methods defined in this CIM class.
CIMMethod[]	getMethods() Get the CIM methods defined in this CIM class.
CIMObjectPath	getObjectPath() This method returns the CIMObjectPath that represents this CIM class.
CIMClassProperty[]	getProperties() Get the properties defined for this CIM class.
CIMClassProperty	getProperty(int pIndex) Get a class property by index.
CIMClassProperty	getProperty(java.lang.String name) Gets the specified property.
CIMClassProperty	getProperty(java.lang.String name, java.lang.String originClass) Gets the specified property.
int	getPropertyCount() Get the number of properties defined in this CIMClass.
CIMQualifier	getQualifier(int pIndex) Get a qualifier by index.
CIMQualifier	getQualifier(java.lang.String pName) Gets a qualifier by name.
int	getQualifierCount() Get the number of qualifiers defined in this CIM class.
CIMQualifier[]	getQualifiers() Returns the list of qualifiers for the CIM class.
java.lang.Object	getQualifierValue(java.lang.String name) Gets a qualifier value by name.
java.lang.String	getSuperClassName() Gets the name of the parent of this CIM class.
boolean	hasQualifier(java.lang.String pName) Checks whether the specified qualifier is one of the qualifiers in this CIM class.
boolean	hasQualifierValue(java.lang.String name, java.lang.Object value) Checks whether the specified qualifier is one of the qualifiers defined for this class with the specified value.
boolean	isAssociation() Identifies whether or not this CIM class is an association.
boolean	isKeyed() Identifies whether or not this class is keyed.
CIMInstance	newInstance() Returns a new CIM instance initialized with the default CIM properties, values and name of this CIM class.
java.lang.String	toString() Returns a String representation of the CIM class.

Methods inherited from class javax.cim.CIMElement

equals, getName, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CIMClass

public CIMClass(CIMObjectPath path,
                java.lang.String superclass,
                CIMQualifier[] qualifiers,
                CIMClassProperty[] props,
                CIMMethod[] pMethods,
                boolean pIsAssociation,
                boolean pIsKeyed)

Creates and instantiates a Java object representing a CIM Class.

Parameters:

path - Object Name of the CIM class.

superclass - Name of the superclass.

qualifiers - List of qualifiers of the CIM class.

props - List of properties of the CIM class.

pMethods - List of methods of the CIM class.

pIsAssociation - True if the CIM class is an Association, false otherwise.

pIsKeyed - True if the CIM class has Keys, false otherwise.

CIMClass

public CIMClass(java.lang.String name,
                java.lang.String superclass,
                CIMQualifier[] qualifiers,
                CIMClassProperty[] props,
                CIMMethod[] methods)

Creates and instantiates a Java object representing a CIM Class.

Parameters:

name - Name of the CIM class.

superclass - Name of the superclass.

qualifiers - List of qualifiers of the CIM class.

props - List of properties of the CIM class.

methods - List of methods of the CIM class.

Method Detail

filterProperties

public CIMClass filterProperties(boolean localOnly,
                                 boolean includeQualifiers,
                                 boolean includeClassOrigin,
                                 java.lang.String[] propertyList)

This method returns a new CIMClass with properties filtered according to the input parameters. Inclusion of class origin and qualifiers can also be controlled. Methods will not be included in the class returned.

Parameters:

localOnly - If true only the elements defined in this class are included; otherwise all elements are included.

includeQualifiers - If true qualifiers are included on all elements; otherwise no qualifiers are included.

includeClassOrigin - If true, the ClassOrigin attribute is included

propertyList - If the PropertyList input parameter is not NULL, the members of the array define one or more Property names. The CIMClass returned does not include elements for any Properties missing from this list. If the PropertyList input parameter is an empty array this signifies that no Properties are included in the class returned. If the PropertyList input parameter is NULL this specifies that all Properties are included in the class returned. If the PropertyList contains duplicate elements or invalid property names, they are ignored.

Returns:

CIMClass matching the reqested criteria

getKeys

public CIMClassProperty[] getKeys()

Returns a list of key properties for this CIM class.

Returns:

CIMClassProperty[] The list of CIM properties that are keys for this CIM class

getMethod

public CIMMethod getMethod(int pIndex)

Get a method by index.

Parameters:

pIndex - The index of the method to retrieve

Returns:

The CIMMethod at the specified index.

getMethod

public CIMMethod getMethod(java.lang.String name)

Returns the specified CIM method in this CIM class.

Parameters:

name - The string name of the method to retrieve. The name may be specified in the form "originClass.methodName".

Returns:

The CIM method specified or null if the method does not exist

getMethod

public CIMMethod getMethod(java.lang.String name,
                           java.lang.String originClass)

Returns the CIM method specified by its name and optionally, its origin class. The origin class is the class in which the method is defined.

Parameters:

name - The string name of the method to get.

originClass - (Optional) The class in which the method was defined.

Returns:

The CIM method specified or null if the method does not exist

getMethodCount

public int getMethodCount()

Get the number of methods defined in this CIM class.

Returns:

int The number of methods defined in the CIM class.

getMethods

public CIMMethod[] getMethods()

Get the CIM methods defined in this CIM class.

Returns:

CIMMethod[] A clone of the methods in this CIM class.

getObjectPath

public CIMObjectPath getObjectPath()

This method returns the CIMObjectPath that represents this CIM class.

Specified by:

getObjectPath in interface javax.cim.CIMNamedElementInterface

Returns:

The CIMObjectPath that represents this CIM class.

getProperties

public CIMClassProperty[] getProperties()

Get the properties defined for this CIM class.

Returns:

CIMProperty[] A clone of the properties for this class.

getProperty

public CIMClassProperty getProperty(int pIndex)

Get a class property by index.

Parameters:

pIndex - The index of the class property to retrieve

Returns:

The CIMClassProperty at the specified index.

getProperty

public CIMClassProperty getProperty(java.lang.String name)

Gets the specified property.

Parameters:

name - The text string for the name of the property

Returns:

CIMClassProperty The property requested or null if the property does not exist

getProperty

public CIMClassProperty getProperty(java.lang.String name,
                                    java.lang.String originClass)

Gets the specified property.

Parameters:

name - The string name of the property to get.

originClass - (Optional) The string name of the class in which the property was defined.

Returns:

CIMClassProperty The property requested or null if the property does not exist

getPropertyCount

public int getPropertyCount()

Get the number of properties defined in this CIMClass.

Returns:

int The number of properties defined in the CIMClass.

getQualifier

public CIMQualifier getQualifier(int pIndex)

Get a qualifier by index.

Specified by:

getQualifier in interface CIMQualifiedElementInterface

Parameters:

pIndex - The index of the qualifier to retrieve

Returns:

The Qualifier at the specified index.

getQualifier

public CIMQualifier getQualifier(java.lang.String pName)

Gets a qualifier by name.

Specified by:

getQualifier in interface CIMQualifiedElementInterface

Parameters:

pName - The name of the qualifier to get.

Returns:

CIMQualifier The qualifier requested or null if the qualifier does not exist

getQualifierCount

public int getQualifierCount()

Get the number of qualifiers defined in this CIM class.

Specified by:

getQualifierCount in interface CIMQualifiedElementInterface

Returns:

int The number of qualifiers defined in the CIM class.

getQualifiers

public CIMQualifier[] getQualifiers()

Returns the list of qualifiers for the CIM class.

Specified by:

getQualifiers in interface CIMQualifiedElementInterface

Returns:

CIMQualifier[] Qualifiers for this class

getQualifierValue

public java.lang.Object getQualifierValue(java.lang.String name)

Gets a qualifier value by name.

Specified by:

getQualifierValue in interface CIMQualifiedElementInterface

Parameters:

name - The name of the qualifier to get.

Returns:

Null if the qualifier does not exist or value is null, otherwise returns the reference to the qualifier.

getSuperClassName

public java.lang.String getSuperClassName()

Gets the name of the parent of this CIM class.

Returns:

The name of the parent class.

hasQualifier

public boolean hasQualifier(java.lang.String pName)

Checks whether the specified qualifier is one of the qualifiers in this CIM class.

Specified by:

hasQualifier in interface CIMQualifiedElementInterface

Parameters:

pName - the name of the qualifier

Returns:

True if the qualifier exists in this CIM class, otherwise false.

hasQualifierValue

public boolean hasQualifierValue(java.lang.String name,
                                 java.lang.Object value)

Checks whether the specified qualifier is one of the qualifiers defined for this class with the specified value. This method will return false if the qualifier is not applied or if the value does not match

Specified by:

hasQualifierValue in interface CIMQualifiedElementInterface

Parameters:

name - the name of the qualifier

value - the value to be tested

Returns:

True if the qualifier exists and has the value, otherwise false.

isAssociation

public boolean isAssociation()

Identifies whether or not this CIM class is an association. An association is a relationship between two or more classes or instances of two or more classes. The properties of an association class include references, or pointers, to the two or more instances. All CIM classes can be included in one or more associations.

Returns:

True if this CIM class is an association; otherwise, false.

isKeyed

public boolean isKeyed()

Identifies whether or not this class is keyed. Only keyed classes can have instances. True if this CIM class has a one or more key property. Otherwise, returns false.

Returns:

True if this CIM class has a key property. otherwise returns false.

newInstance

public CIMInstance newInstance()

Returns a new CIM instance initialized with the default CIM properties, values and name of this CIM class.

Returns:

CIMInstance A CIM instance of this CIM class.

toString

public java.lang.String toString()

Returns a String representation of the CIM class. This method is intended to be used only for debugging purposes, and the format of the string returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

toString in class CIMElement

Returns:

String A string representation of this CIM class