Rule Execution Server API

ilog.rules.xml.model
Interface IlrXmlModel


public interface IlrXmlModel

This class provides reflection on the XML runtime model of an IlrXmlDataDriver. This reflection is complementary to the XOM model capability in a way that it shows information from the XML Schema point of view.

Reflection information about the generated dynamic XML classes are accessible through meta-type instances named IlrXmlClass and IlrXmlSimpleType.

An instance of this class is built using the ilog.rules.xml.IlrXmlDataDriver#getXmlModel.

See Also:
IlrXmlObject, IlrXmlSchemaDriver.getXmlModel()

Method Summary
 IlrXmlClass getClass(String qualifiedName)
          Returns information about a dynamic class given its fully qualified name.
 IlrXmlClass getClass(String namespace, String xmlName)
          Returns information about a dynamic class given its namespace and its XML name.
 IlrXmlClass[] getClasses()
          Return all the classes known by the model.
 Object getNil()
          Returns an object representing the NIL schema value.
 IlrXmlSimpleType getSimpleType(String qualifiedName)
          Returns information about a user schema simple type given its qualified name.
 IlrXmlSimpleType getSimpleType(String namespace, String xmlName)
          Returns information about a user schema simple type given its namespace and its XML name.
 IlrXmlSimpleType[] getSimpleTypes()
          Return all simple types known by the model.
 

Method Detail

getClasses

IlrXmlClass[] getClasses()
Return all the classes known by the model.


getSimpleTypes

IlrXmlSimpleType[] getSimpleTypes()
Return all simple types known by the model.


getClass

IlrXmlClass getClass(String qualifiedName)
Returns information about a dynamic class given its fully qualified name.

Parameters:
qualifiedName - The fully qualified name of the dynamic class.
Returns:
An instance representing the dynamic class.

getClass

IlrXmlClass getClass(String namespace,
                     String xmlName)
Returns information about a dynamic class given its namespace and its XML name.

Parameters:
namespace - The class namespace (null if no namespace).
xmlName - The class XML name.
Returns:
An instance representing the dynamic class.

getSimpleType

IlrXmlSimpleType getSimpleType(String qualifiedName)
Returns information about a user schema simple type given its qualified name.

Parameters:
qualifiedName - The fully qualified name of the dynamic type.
Returns:
An instance representing the dynamic type.

getSimpleType

IlrXmlSimpleType getSimpleType(String namespace,
                               String xmlName)
Returns information about a user schema simple type given its namespace and its XML name.

Parameters:
namespace - The class namespace (null if no namespace).
xmlName - The class XML name.
Returns:
An instance representing the dynamic type.

getNil

Object getNil()
Returns an object representing the NIL schema value. This value is used to set the dynamic field of an IlrXmlObject instance when the Nil is specified in the related XML document.

Returns:
The Nil object.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013