javax.cim
public class CIMClass extends CIMElement implements CIMQualifiedElementInterface, CIMNamedElementInterface, Serializable
CIMClass
represents a CIM class as defined by the Distributed
Management Task Force (www.dmtf.org) CIM Infrastructure Specification. A
CIMClass
has the following attributes:
Constructor Summary | |
---|---|
CIMClass(CIMObjectPath pPath, String pSuperClass, CIMQualifier[] pQualifiers, CIMClassProperty[] pProps, CIMMethod[] pMethods, boolean pIsAssociation, boolean pIsKeyed)
Creates and instantiates a Java object representing a CIM Class.
| |
CIMClass(String pName, String pSuperClass, CIMQualifier[] pQualifiers, CIMClassProperty[] pProps, CIMMethod[] pMethods)
Creates and instantiates a Java object representing a CIM Class.
|
Method Summary | |
---|---|
boolean | equals(Object pObj)
Compares this object against the specified object. |
CIMClass | filterProperties(boolean pLocalOnly, boolean pIncludeQualifiers, boolean pIncludeClassOrigin, String[] pPropertyList)
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(String pName)
Returns the specified CIM method in this CIM class.
|
CIMMethod | getMethod(String pName, String pOriginClass)
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(String pName)
Gets the specified property.
|
CIMClassProperty | getProperty(String pName, String pOriginClass)
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(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.
|
Object | getQualifierValue(String pName) |
String | getSuperClassName()
Gets the name of the parent of this CIM class.s
|
boolean | hasQualifier(String pName)
Checks whether the specified qualifier is one of the qualifiers in this
CIM class.
|
boolean | hasQualifierValue(String pName, Object pValue) |
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.
|
String | toString()
Returns a String representation of the CIM class. |
Parameters: pPath -
Object Name of the CIM class. pSuperClass -
Name of the superclass. pQualifiers -
List of qualifiers of the CIM class. pProps -
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.
Parameters: pName - Name of the CIM class. pSuperClass - Name of the superclass. pQualifiers - List of qualifiers of the CIM class. pProps - List of properties of the CIM class. pMethods - List of methods of the CIM class.
true
if and only if the argument is not null
and is a CIMValuedObject
that represents the same name,
type and value as this object.
Parameters: pObj - The object to compare with.
Returns: true
if the objects are the same;
false
otherwise.
See Also: java.lang.Object#equals(java.lang.Object)
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: pLocalOnly -
If
If the true
only the elements defined in this class
are included; otherwise all elements are included. pIncludeQualifiers -
If true
qualifiers are included on all
elements; otherwise no qualifiers are included. pIncludeClassOrigin -
If true
, the ClassOrigin attribute is
included. pPropertyList
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.
Returns: The list of CIM properties that are keys for this CIM class.
Parameters: pIndex - The index of the method to retrieve
Returns: The CIMMethod
at the specified index.
Parameters: pName
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.
Parameters: pName - The string name of the method to get. pOriginClass - (Optional) The class in which the method was defined.
Returns: The CIM method specified or null
if the method
does not exist.
Returns: The number of methods defined in the CIM class.
Returns: A clone of the methods in this CIM class.
CIMObjectPath
that represents this
CIM class.
Returns: The CIMObjectPath
that represents this CIM class.
Returns: A clone of the properties for this class.
Parameters: pIndex - The index of the class property to retrieve
Returns: The CIMClassProperty
at the specified index.
Parameters: pName - The text string for the name of the property
Returns: CIMClassProperty
The property requested or
null
if the property does not exist.
Parameters: pName - The string name of the property to get. pOriginClass - (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
CIMClass
.
Returns: The number of properties defined in the CIMClass
.
Parameters: pIndex - The index of the qualifier to retrieve.
Returns: The Qualifier at the specified index.
Parameters: pName - The name of the qualifier to get.
Returns: The qualifier requested or null
if the qualifier
does not exist.
Returns: The number of qualifiers defined in the CIM class.
Returns: Qualifiers for this class.
See Also: CIMQualifiedElementInterface
Returns: The name of the parent class.
Parameters: pName - the name of the qualifier.
Returns: true
if the qualifier exists in this CIM class,
otherwise false
.
See Also: CIMQualifiedElementInterface
Returns: true
if this CIM class is an association;
otherwise, false
.
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
.
Returns: A CIM instance of this CIM class.
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
.
Returns: A String
representation of this CIM class.