Package com.ibm.di.connector.maximo.parsing

Class Schema

java.lang.Object

com.ibm.di.connector.maximo.parsing.Schema

public final class Schema
extends java.lang.Object

This class provides access to descriptive information about Maximo Objects Structures (MOS) based on its XML Schema Descriptor (XSD), which is generated by the Maximo Object Structure Application. Every element is exposed through schema element objects, organized in a hierarchical way.

Since:

7.1

See Also:

SchemaConfiguration, SchemaElement

Method Summary

Modifier and Type	Method	Description
static void	clearSchemaCache()	Clears every schema object cached.
static Schema	getInstance(SchemaConfiguration cfg, Log log)	Builds a schema object based on the Maximo Object Structure and its XML Schema Descriptor's URL (XSD).
SchemaElement	getMboByName(java.lang.String mboName)	Returns the schema element that represents the specified MBO.
java.util.Set<java.lang.String>	getMboNameList()	Returns a list of all valid MBO names.
SchemaElement	getMos()	Returns a schema element that describes the Maximo Object Structure (MOS).
SchemaElement	getRootMbo()	Returns the definition of the root or top-level MBO.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static Schema getInstance(SchemaConfiguration cfg,
                                 Log log)
                          throws MxConnConfigException,
                                 MxConnIOException,
                                 MxConnXmlParsingException

Builds a schema object based on the Maximo Object Structure and its XML Schema Descriptor's URL (XSD).

Parameters:

cfg - configuration parameter required to build the schema object

Returns:

Schema based on the Maximo Object Structure and its XML Schema Descriptor's URL (XSD)

Throws:

MxConnConfigException - if the configuration provided is not valid

MxConnIOException - if any sort of communication problem occurs when trying to retrieve the XSD

MxConnXmlParsingException - if the XSD content can not be parsed

See Also:

clearSchemaCache()

clearSchemaCache

public static void clearSchemaCache()

Clears every schema object cached.

getMboByName

public SchemaElement getMboByName(java.lang.String mboName)
                           throws MxConnConfigException

Returns the schema element that represents the specified MBO.

Parameters:

mboName - name of the MBO to be returned

Returns:

schema element that represents the specified MBO

Throws:

MxConnConfigException - if mboName does not exist

getMboNameList

public java.util.Set<java.lang.String> getMboNameList()

Returns a list of all valid MBO names.

Returns:

list of all valid MBO names

getMos

public SchemaElement getMos()

Returns a schema element that describes the Maximo Object Structure (MOS).

Returns:

schema element that describes the Maximo Object Structure

getRootMbo

public SchemaElement getRootMbo()

Returns the definition of the root or top-level MBO.

Returns:

the definition of the root or top-level MBO

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object