org.sblim.cimclient.internal.util
Class MOF

java.lang.Object
  extended by org.sblim.cimclient.internal.util.MOF

public class MOF
extends java.lang.Object

Class MOF is responsible for helping MOF String generation.


Field Summary
static java.lang.String ANY
          CLASS
static java.lang.String ASSOCIATION
          CLASS
static java.lang.String CLASS
          CLASS
static 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
static java.lang.String DISABLEOVERRIDE
          CLASS
static java.lang.String DT_BOOL
          CLASS
static java.lang.String DT_CHAR16
          CLASS
static java.lang.String DT_DATETIME
          CLASS
static java.lang.String DT_REAL32
          CLASS
static java.lang.String DT_REAL64
          CLASS
static java.lang.String DT_SINT16
          CLASS
static java.lang.String DT_SINT32
          CLASS
static java.lang.String DT_SINT64
          CLASS
static java.lang.String DT_SINT8
          CLASS
static java.lang.String DT_STR
          CLASS
static java.lang.String DT_UINT16
          CLASS
static java.lang.String DT_UINT32
          CLASS
static java.lang.String DT_UINT64
          CLASS
static java.lang.String DT_UINT8
          CLASS
static java.lang.String EMPTY
          CLASS
static java.lang.String ENABLEOVERRIDE
          CLASS
static java.lang.String FALSE
          CLASS
static java.lang.String INDENT
          CLASS
static java.lang.String INDICATION
          CLASS
static java.lang.String INSTANCE
          CLASS
static java.lang.String INSTOF
          CLASS
static java.lang.String INVALID
          CLASS
static java.lang.String METHOD
          CLASS
static java.lang.String NAMESPACE
          CLASS
static java.lang.String NULL
          CLASS
static java.lang.String PARAMETER
          CLASS
static java.lang.String PROPERTY
          CLASS
static java.lang.String QUALIFIER
          CLASS
static java.lang.String REF
          CLASS
static java.lang.String REFERENCE
          CLASS
static java.lang.String RESTRICTED
          CLASS
static java.lang.String SCOPE
          CLASS
static java.lang.String TOSUBCLASS
          CLASS
static java.lang.String TRANSLATABLE
          CLASS
static java.lang.String TRUE
          CLASS
 
Constructor Summary
MOF()
           
 
Method Summary
static java.lang.String classDeclaration(CIMClass pCl, java.lang.String pInd)
           classDeclaration = [ qualifierList ] CLASS className [ superClass ] "{" *classFeature "}" ";" classFeature = propertyDeclaration | methodDeclaration superClass = ":" className
static java.lang.String constantValue(CIMValuedElement pValuedElement, java.lang.String pInd)
           constantValue = integerValue | realValue | charValue | stringValue | booleanValue | nullValue // | dateTimeValue | objectHandle
static java.lang.String constantValue(java.lang.Object pObj, boolean pTyped, java.lang.String pInd)
          constantValue
static java.lang.String constantValue(java.lang.Object pObj, java.lang.String pInd)
          constantValue
static java.lang.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
static java.lang.String dataType(CIMTypedElement pTypedElement)
           
static java.lang.String flavor(int flavor)
           flavor = ENABLEOVERRIDE | DISABLEOVERRIDE | RESTRICTED | TOSUBCLASS | TRANSLATABLE
static java.lang.String instanceDeclaration(CIMInstance pInst, java.lang.String pInd)
          instanceDeclaration = [ qualifierList ] INSTANCE OF className [ alias ] "{" 1*valueInitializer "}" ";"
valueInitializer = [ qualifierList ] ( propertyName | referenceName ) "=" initializer ";"
static java.lang.String methodDeclaration(CIMMethod pMethod, java.lang.String pInd)
           methodDeclaration = [ qualifierList ] dataType methodName "(" [ parameterList ] ")" ";"
static java.lang.String objectHandle(CIMObjectPath pPath)
          objectHandle
static java.lang.String objectHandle(CIMObjectPath pPath, boolean pTyped, boolean pLocal)
          objectHandle
static java.lang.String objectHandleAsRef(CIMObjectPath pPath)
          objectHandleAsRef
static java.lang.String objectHandleAsRef(CIMObjectPath pPath, boolean pTyped)
          objectHandleAsRef
static java.lang.String parameter(CIMParameter pParam, java.lang.String pInd)
          parameter
static java.lang.String propertyDeclaration(CIMProperty pProp, java.lang.String pInd)
           propertyDeclaration = typedElement [ defaultValue ] ";" defaultValue = "=" initializer
static java.lang.String qualifier(CIMQualifier pQuali)
           qualifier = qualifierName [ qualifierParameter ] [ ":" 1*flavor ]
static java.lang.String qualifierDeclaration(CIMQualifierType pQType)
           qualifierDeclaration = QUALIFIER qualifierName qualifierType scope [ defaultFlavor ] ";"
static java.lang.String qualifierList(CIMElement pElement, java.lang.String pInd)
           qualifierList = "[" qualifier *( "," qualifier ) "]"
static java.lang.String scope(int pScopes)
           scope = "," SCOPE "(" metaElement *( "," metaElement ) ")" metaElement = CLASS | ASSOCIATION | INDICATION | QUALIFIER PROPERTY | REFERENCE | METHOD | PARAMETER | ANY
static java.lang.String typedElement(CIMTypedElement pTypedElement, java.lang.String pInd)
          typedElement = [ qualifierList ] (dataType|objectRef) parameterName [ array ]
static java.lang.String valuedElement(CIMValuedElement pValuedElement, java.lang.String pInd)
           valuedElement = typedElement [ defaultValue ] ";" defaultValue = "=" initializer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS

public static final java.lang.String CLASS
CLASS

See Also:
Constant Field Values

TRUE

public static final java.lang.String TRUE
CLASS

See Also:
Constant Field Values

FALSE

public static final java.lang.String FALSE
CLASS

See Also:
Constant Field Values

NULL

public static final java.lang.String NULL
CLASS

See Also:
Constant Field Values

ENABLEOVERRIDE

public static final java.lang.String ENABLEOVERRIDE
CLASS

See Also:
Constant Field Values

DISABLEOVERRIDE

public static final java.lang.String DISABLEOVERRIDE
CLASS

See Also:
Constant Field Values

RESTRICTED

public static final java.lang.String RESTRICTED
CLASS

See Also:
Constant Field Values

TOSUBCLASS

public static final java.lang.String TOSUBCLASS
CLASS

See Also:
Constant Field Values

TRANSLATABLE

public static final java.lang.String TRANSLATABLE
CLASS

See Also:
Constant Field Values

DT_BOOL

public static final java.lang.String DT_BOOL
CLASS

See Also:
Constant Field Values

DT_CHAR16

public static final java.lang.String DT_CHAR16
CLASS

See Also:
Constant Field Values

DT_DATETIME

public static final java.lang.String DT_DATETIME
CLASS

See Also:
Constant Field Values

DT_REAL32

public static final java.lang.String DT_REAL32
CLASS

See Also:
Constant Field Values

DT_REAL64

public static final java.lang.String DT_REAL64
CLASS

See Also:
Constant Field Values

DT_SINT16

public static final java.lang.String DT_SINT16
CLASS

See Also:
Constant Field Values

DT_SINT32

public static final java.lang.String DT_SINT32
CLASS

See Also:
Constant Field Values

DT_SINT64

public static final java.lang.String DT_SINT64
CLASS

See Also:
Constant Field Values

DT_SINT8

public static final java.lang.String DT_SINT8
CLASS

See Also:
Constant Field Values

DT_STR

public static final java.lang.String DT_STR
CLASS

See Also:
Constant Field Values

DT_UINT16

public static final java.lang.String DT_UINT16
CLASS

See Also:
Constant Field Values

DT_UINT32

public static final java.lang.String DT_UINT32
CLASS

See Also:
Constant Field Values

DT_UINT64

public static final java.lang.String DT_UINT64
CLASS

See Also:
Constant Field Values

DT_UINT8

public static final java.lang.String DT_UINT8
CLASS

See Also:
Constant Field Values

INVALID

public static final java.lang.String INVALID
CLASS

See Also:
Constant Field Values

REF

public static final java.lang.String REF
CLASS

See Also:
Constant Field Values

INSTOF

public static final java.lang.String INSTOF
CLASS

See Also:
Constant Field Values

QUALIFIER

public static final java.lang.String QUALIFIER
CLASS

See Also:
Constant Field Values

SCOPE

public static final java.lang.String SCOPE
CLASS

See Also:
Constant Field Values

ANY

public static final java.lang.String ANY
CLASS

See Also:
Constant Field Values

ASSOCIATION

public static final java.lang.String ASSOCIATION
CLASS

See Also:
Constant Field Values

INDICATION

public static final java.lang.String INDICATION
CLASS

See Also:
Constant Field Values

METHOD

public static final java.lang.String METHOD
CLASS

See Also:
Constant Field Values

PARAMETER

public static final java.lang.String PARAMETER
CLASS

See Also:
Constant Field Values

PROPERTY

public static final java.lang.String PROPERTY
CLASS

See Also:
Constant Field Values

REFERENCE

public static final java.lang.String REFERENCE
CLASS

See Also:
Constant Field Values

INSTANCE

public static final java.lang.String INSTANCE
CLASS

See Also:
Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE
CLASS

See Also:
Constant Field Values

INDENT

public static final java.lang.String INDENT
CLASS

See Also:
Constant Field Values

EMPTY

public static final java.lang.String EMPTY
CLASS

See Also:
Constant Field Values

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

See Also:
Constant Field Values
Constructor Detail

MOF

public MOF()
Method Detail

classDeclaration

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

Parameters:
pCl -
pInd -
Returns:
the MOF string

instanceDeclaration

public static java.lang.String instanceDeclaration(CIMInstance pInst,
                                                   java.lang.String pInd)
instanceDeclaration = [ qualifierList ] INSTANCE OF className [ alias ] "{" 1*valueInitializer "}" ";"
valueInitializer = [ qualifierList ] ( propertyName | referenceName ) "=" initializer ";"

Parameters:
pInst -
pInd -
Returns:
the MOF string

methodDeclaration

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

Parameters:
pMethod -
pInd -
Returns:
the MOF string

parameter

public static java.lang.String parameter(CIMParameter pParam,
                                         java.lang.String pInd)
parameter

Parameters:
pParam - - CIMParameter
pInd -
Returns:
the MOF string

typedElement

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

Parameters:
pTypedElement -
pInd -
Returns:
the MOF string

valuedElement

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

Parameters:
pValuedElement -
pInd -
Returns:
the MOF string

qualifierList

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

Parameters:
pElement -
pInd -
Returns:
the MOF string +newLine if qualifiers present or empty string

qualifierDeclaration

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

Parameters:
pQType -
Returns:
the MOF string

scope

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

Parameters:
pScopes -
Returns:
the MOF string

flavor

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

Parameters:
flavor -
Returns:
the MOF string

qualifier

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

Parameters:
pQuali -
Returns:
the MOF string

propertyDeclaration

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

Parameters:
pProp -
pInd -
Returns:
the MOF string

dataType

public static java.lang.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 java.lang.String dataType(CIMTypedElement pTypedElement)
Parameters:
pTypedElement -
Returns:
th MOF string
See Also:
dataType(CIMDataType)

objectHandle

public static java.lang.String objectHandle(CIMObjectPath pPath)
objectHandle

Parameters:
pPath -
Returns:
the Untyped MOF String

objectHandle

public static java.lang.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 java.lang.String objectHandleAsRef(CIMObjectPath pPath)
objectHandleAsRef

Parameters:
pPath -
Returns:
the Untyped MOF String

objectHandleAsRef

public static java.lang.String objectHandleAsRef(CIMObjectPath pPath,
                                                 boolean pTyped)
objectHandleAsRef

Parameters:
pPath -
pTyped -
Returns:
the MOF String

constantValue

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

Parameters:
pValuedElement -
pInd -
Returns:
the MOF string

constantValue

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

Parameters:
pObj -
pTyped -
pInd -
Returns:
the MOF string
See Also:
constantValue(CIMValuedElement, String)

constantValue

public static java.lang.String constantValue(java.lang.Object pObj,
                                             java.lang.String pInd)
constantValue

Parameters:
pObj -
pInd -
Returns:
the untyped MOF String


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