org.sblim.cimclient.internal.util

Class MOF

public class MOF extends Object

Class MOF is responsible for helping MOF String generation.
Field Summary
static StringANY
ANY
static StringASSOCIATION
ASSOCIATION
static StringCLASS
CLASS
static intDEF_FLAVOR
OVERRIDABLE (true|false) 'true' -> DISABLEOVERRIDE=false TOSUBCLASS (true|false) 'true' -> RESTRICTED=false TOINSTANCE (true|false) 'false' TRANSLATABLE (true|false) 'false' -> TRANSLTE=false
static StringDISABLEOVERRIDE
DISABLEOVERRIDE
static StringDT_BOOL
DT_BOOL
static StringDT_CHAR16
DT_CHAR16
static StringDT_DATETIME
DT_DATETIME
static StringDT_REAL32
DT_REAL32
static StringDT_REAL64
DT_REAL64
static StringDT_SINT16
DT_SINT16
static StringDT_SINT32
DT_SINT32
static StringDT_SINT64
DT_SINT64
static StringDT_SINT8
DT_SINT8
static StringDT_STR
DT_STR
static StringDT_UINT16
DT_UINT16
static StringDT_UINT32
DT_UINT32
static StringDT_UINT64
DT_UINT64
static StringDT_UINT8
DT_UINT8
static StringEMPTY
EMPTY
static StringENABLEOVERRIDE
ENABLEOVERRIDE
static StringFALSE
FALSE
static StringINDENT
INDENT
static StringINDICATION
INDICATION
static StringINSTANCE
INSTANCE
static StringINSTOF
INSTOF
static StringINVALID
INVALID
static StringMETHOD
METHOD
static StringNAMESPACE
NAMESPACE
static StringNULL
NULL
static StringPARAMETER
PARAMETER
static StringPROPERTY
PROPERTY
static StringQUALIFIER
QUALIFIER
static StringREF
REF
static StringREFERENCE
REFERENCE
static StringRESTRICTED
RESTRICTED
static StringSCOPE
SCOPE
static StringTOSUBCLASS
TOSUBCLASS
static StringTRANSLATABLE
TRANSLATABLE
static StringTRUE
TRUE
Method Summary
static StringclassDeclaration(CIMClass pCl, String pInd)
        classDeclaration		=	[ qualifierList ] CLASS className [ superClass ]
       					"{" *classFeature "}" ";"
        classFeature			=	propertyDeclaration | methodDeclaration
        
        superClass				=	":" className
 
static StringconstantValue(CIMValuedElement pValuedElement, String pInd)
 constantValue = integerValue | realValue | charValue | stringValue | booleanValue | nullValue
 // | dateTimeValue | objectHandle
 
static StringconstantValue(Object pObj, boolean pTyped, String pInd)
constantValue
static StringconstantValue(Object pObj, String pInd)
constantValue
static StringdataType(CIMDataType pType)
 dataType = DT_UINT8 | DT_SINT8 | DT_UINT16 | DT_SINT16 | DT_UINT32 | DT_SINT32 | DT_UINT64
 		| DT_SINT64 | DT_REAL32 | DT_REAL64 | DT_CHAR16 | DT_STR | DT_BOOL | DT_DATETIME
 
Additionally it handles reference types too.
static StringdataType(CIMTypedElement pTypedElement)
static Stringflavor(int flavor)
 flavor = ENABLEOVERRIDE | DISABLEOVERRIDE | RESTRICTED | TOSUBCLASS | TRANSLATABLE
 
static StringinstanceDeclaration(CIMInstance pInst, String pInd)
instanceDeclaration = [ qualifierList ] INSTANCE OF className [ alias ] "{" 1*valueInitializer "}" ";"
static StringmethodDeclaration(CIMMethod pMethod, String pInd)
        methodDeclaration		=	[ qualifierList ] dataType methodName
       							"(" [ parameterList ] ")" ";"
 
static StringobjectHandle(CIMObjectPath pPath)
objectHandle
static StringobjectHandle(CIMObjectPath pPath, boolean pTyped, boolean pLocal)
objectHandle
static StringobjectHandleAsRef(CIMObjectPath pPath)
objectHandleAsRef
static StringobjectHandleAsRef(CIMObjectPath pPath, boolean pTyped)
objectHandleAsRef
static Stringparameter(CIMParameter pParam, String pInd)
parameter
static StringpropertyDeclaration(CIMProperty pProp, String pInd)
        propertyDeclaration	=	typedElement [ defaultValue ] ";"
        defaultValue			=	"=" initializer
 
static Stringqualifier(CIMQualifier pQuali)
        qualifier				=	qualifierName [ qualifierParameter ] [ ":" 1*flavor ]
 
static StringqualifierDeclaration(CIMQualifierType pQType)
        qualifierDeclaration	=	QUALIFIER qualifierName qualifierType scope 
        							[ defaultFlavor ] ";"
 
static StringqualifierList(CIMElement pElement, String pInd)
        qualifierList			=	"[" qualifier *( "," qualifier ) "]"
 
static Stringscope(int pScopes)
        scope		=	"," SCOPE "(" metaElement *( "," metaElement ) ")"
        metaElement	=	CLASS | ASSOCIATION | INDICATION | QUALIFIER
       					PROPERTY | REFERENCE | METHOD | PARAMETER | ANY
 
static StringtypedElement(CIMTypedElement pTypedElement, String pInd)
typedElement = [ qualifierList ] (dataType|objectRef) parameterName [ array ]
static StringvaluedElement(CIMValuedElement pValuedElement, String pInd)
        valuedElement 		=	typedElement [ defaultValue ] ";"
        defaultValue			=	"=" initializer
 
static StringvalueInitializer(CIMProperty pProp, String pInd)
        valueInitializer		= [ qualifierList ] ( propertyName | referenceName ) "="
 								  initializer ";"
 

Field Detail

ANY

public static final String ANY
ANY

ASSOCIATION

public static final String ASSOCIATION
ASSOCIATION

CLASS

public static final String CLASS
CLASS

DEF_FLAVOR

public static final int DEF_FLAVOR
OVERRIDABLE (true|false) 'true' -> DISABLEOVERRIDE=false TOSUBCLASS (true|false) 'true' -> RESTRICTED=false TOINSTANCE (true|false) 'false' TRANSLATABLE (true|false) 'false' -> TRANSLTE=false

DISABLEOVERRIDE

public static final String DISABLEOVERRIDE
DISABLEOVERRIDE

DT_BOOL

public static final String DT_BOOL
DT_BOOL

DT_CHAR16

public static final String DT_CHAR16
DT_CHAR16

DT_DATETIME

public static final String DT_DATETIME
DT_DATETIME

DT_REAL32

public static final String DT_REAL32
DT_REAL32

DT_REAL64

public static final String DT_REAL64
DT_REAL64

DT_SINT16

public static final String DT_SINT16
DT_SINT16

DT_SINT32

public static final String DT_SINT32
DT_SINT32

DT_SINT64

public static final String DT_SINT64
DT_SINT64

DT_SINT8

public static final String DT_SINT8
DT_SINT8

DT_STR

public static final String DT_STR
DT_STR

DT_UINT16

public static final String DT_UINT16
DT_UINT16

DT_UINT32

public static final String DT_UINT32
DT_UINT32

DT_UINT64

public static final String DT_UINT64
DT_UINT64

DT_UINT8

public static final String DT_UINT8
DT_UINT8

EMPTY

public static final String EMPTY
EMPTY

ENABLEOVERRIDE

public static final String ENABLEOVERRIDE
ENABLEOVERRIDE

FALSE

public static final String FALSE
FALSE

INDENT

public static final String INDENT
INDENT

INDICATION

public static final String INDICATION
INDICATION

INSTANCE

public static final String INSTANCE
INSTANCE

INSTOF

public static final String INSTOF
INSTOF

INVALID

public static final String INVALID
INVALID

METHOD

public static final String METHOD
METHOD

NAMESPACE

public static final String NAMESPACE
NAMESPACE

NULL

public static final String NULL
NULL

PARAMETER

public static final String PARAMETER
PARAMETER

PROPERTY

public static final String PROPERTY
PROPERTY

QUALIFIER

public static final String QUALIFIER
QUALIFIER

REF

public static final String REF
REF

REFERENCE

public static final String REFERENCE
REFERENCE

RESTRICTED

public static final String RESTRICTED
RESTRICTED

SCOPE

public static final String SCOPE
SCOPE

TOSUBCLASS

public static final String TOSUBCLASS
TOSUBCLASS

TRANSLATABLE

public static final String TRANSLATABLE
TRANSLATABLE

TRUE

public static final String TRUE
TRUE

Method Detail

classDeclaration

public static String classDeclaration(CIMClass pCl, String pInd)
        classDeclaration		=	[ qualifierList ] CLASS className [ superClass ]
       					"{" *classFeature "}" ";"
        classFeature			=	propertyDeclaration | methodDeclaration
        
        superClass				=	":" className
 

Parameters: pCl pInd

Returns: the MOF string

constantValue

public static String constantValue(CIMValuedElement pValuedElement, String pInd)
 constantValue = integerValue | realValue | charValue | stringValue | booleanValue | nullValue
 // | dateTimeValue | objectHandle
 

Parameters: pValuedElement pInd

Returns: the MOF string

constantValue

public static String constantValue(Object pObj, boolean pTyped, String pInd)
constantValue

Parameters: pObj pTyped pInd

Returns: the MOF string

See Also: MOF

constantValue

public static String constantValue(Object pObj, String pInd)
constantValue

Parameters: pObj pInd

Returns: the untyped MOF String

dataType

public static String dataType(CIMDataType pType)
 dataType = DT_UINT8 | DT_SINT8 | DT_UINT16 | DT_SINT16 | DT_UINT32 | DT_SINT32 | DT_UINT64
 		| DT_SINT64 | DT_REAL32 | DT_REAL64 | DT_CHAR16 | DT_STR | DT_BOOL | DT_DATETIME
 
Additionally it handles reference types too.
        objectType	=	objectRef
        objectRef		=	className REF
 

Parameters: pType

Returns: the MOF string

dataType

public static String dataType(CIMTypedElement pTypedElement)

Parameters: pTypedElement

Returns: th MOF string

See Also: dataType

flavor

public static String flavor(int flavor)
 flavor = ENABLEOVERRIDE | DISABLEOVERRIDE | RESTRICTED | TOSUBCLASS | TRANSLATABLE
 

Parameters: flavor

Returns: the MOF string

instanceDeclaration

public static String instanceDeclaration(CIMInstance pInst, String pInd)
instanceDeclaration = [ qualifierList ] INSTANCE OF className [ alias ] "{" 1*valueInitializer "}" ";"

Parameters: pInst pInd

Returns: the MOF string

methodDeclaration

public static String methodDeclaration(CIMMethod pMethod, String pInd)
        methodDeclaration		=	[ qualifierList ] dataType methodName
       							"(" [ parameterList ] ")" ";"
 

Parameters: pMethod pInd

Returns: the MOF string

objectHandle

public static String objectHandle(CIMObjectPath pPath)
objectHandle

Parameters: pPath

Returns: the Untyped MOF String

objectHandle

public static String objectHandle(CIMObjectPath pPath, boolean pTyped, boolean pLocal)
objectHandle

Parameters: pPath The path pTyped If true the URI is typed pLocal If true the path is local (omitting scheme, host and port)

Returns: the URI string

objectHandleAsRef

public static String objectHandleAsRef(CIMObjectPath pPath)
objectHandleAsRef

Parameters: pPath

Returns: the Untyped MOF String

objectHandleAsRef

public static String objectHandleAsRef(CIMObjectPath pPath, boolean pTyped)
objectHandleAsRef

Parameters: pPath pTyped

Returns: the MOF String

parameter

public static String parameter(CIMParameter pParam, String pInd)
parameter

Parameters: pParam - CIMParameter pInd

Returns: the MOF string

propertyDeclaration

public static String propertyDeclaration(CIMProperty pProp, String pInd)
        propertyDeclaration	=	typedElement [ defaultValue ] ";"
        defaultValue			=	"=" initializer
 

Parameters: pProp pInd

Returns: the MOF string

qualifier

public static String qualifier(CIMQualifier pQuali)
        qualifier				=	qualifierName [ qualifierParameter ] [ ":" 1*flavor ]
 

Parameters: pQuali

Returns: the MOF string

qualifierDeclaration

public static String qualifierDeclaration(CIMQualifierType pQType)
        qualifierDeclaration	=	QUALIFIER qualifierName qualifierType scope 
        							[ defaultFlavor ] ";"
 

Parameters: pQType

Returns: the MOF string

qualifierList

public static String qualifierList(CIMElement pElement, String pInd)
        qualifierList			=	"[" qualifier *( "," qualifier ) "]"
 

Parameters: pElement pInd

Returns: the MOF string +newLine if qualifiers present or empty string

scope

public static String scope(int pScopes)
        scope		=	"," SCOPE "(" metaElement *( "," metaElement ) ")"
        metaElement	=	CLASS | ASSOCIATION | INDICATION | QUALIFIER
       					PROPERTY | REFERENCE | METHOD | PARAMETER | ANY
 

Parameters: pScopes

Returns: the MOF string

typedElement

public static String typedElement(CIMTypedElement pTypedElement, String pInd)
typedElement = [ qualifierList ] (dataType|objectRef) parameterName [ array ]

Parameters: pTypedElement pInd

Returns: the MOF string

valuedElement

public static String valuedElement(CIMValuedElement pValuedElement, String pInd)
        valuedElement 		=	typedElement [ defaultValue ] ";"
        defaultValue			=	"=" initializer
 

Parameters: pValuedElement pInd

Returns: the MOF string

valueInitializer

public static String valueInitializer(CIMProperty pProp, String pInd)
        valueInitializer		= [ qualifierList ] ( propertyName | referenceName ) "="
 								  initializer ";"
 

Parameters: pProp pInd

Returns: the MOF string

Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.