ilog.rules.xml.model

Interface IlrXmlClass

All Superinterfaces:

IlrXmlType

public interface IlrXmlClass
extends IlrXmlType

This class represents a dynamic XML class generated by an IlrXmlDataDriver. It provides the structural information about a dynamic class, such as its attribute types.

There is no runtime method to handle an IlrXmlObject instance. Runtime methods are provided in the ilog.rules.factory.IlrReflect class.

See Also:

IlrXmlModel.getClass(java.lang.String), IlrXmlType

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNBOUNDED Constant representing the maxOccurs value of an unbounded collection attribute.

Method Summary

Methods

Modifier and Type	Method and Description
IlrXmlType	getAttributeComponentType(java.lang.String name) Get the component type of an attribute given its XOM name.
int	getAttributeMaxOccurs(java.lang.String name) Get the maximum occurence of an attribute.
int	getAttributeMinOccurs(java.lang.String name) Get the minimum occurrence of an attribute.
java.lang.String[]	getAttributes() Get the attribute name list of the class.
java.lang.String	getAttributeXmlName(java.lang.String name) Get the attribute XML name if it exists.
IlrXmlClass	getSuperclass() Get the superclass of the class.
boolean	hasExtensionDerivation() To know if the derivation is a extension kind.
boolean	hasRestrictionDerivation() To know if the derivation is a restriction kind.
boolean	isUnaryAttribute(java.lang.String name) To know if an attribute identified by its XOM name is unary.

Methods inherited from interface ilog.rules.xml.model.IlrXmlType

getJavaClass, getName, getXmlName, getXmlNamespace, isAssignableFrom, isLocal

Field Detail

UNBOUNDED

static final int UNBOUNDED

Constant representing the maxOccurs value of an unbounded collection attribute.

See Also:

getAttributeMaxOccurs(java.lang.String), Constant Field Values

Method Detail

getAttributes

java.lang.String[] getAttributes()

Get the attribute name list of the class.

Returns:

The attribute names.

isUnaryAttribute

boolean isUnaryAttribute(java.lang.String name)
                         throws IlrXmlException

To know if an attribute identified by its XOM name is unary.

Throws:

IlrXmlException - raised when the attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

true If the attribute is unary.

getAttributeMinOccurs

int getAttributeMinOccurs(java.lang.String name)
                          throws IlrXmlException

Get the minimum occurrence of an attribute.

Throws:

IlrXmlException - raised when the attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

The minOccurs information of an attribute.

getAttributeMaxOccurs

int getAttributeMaxOccurs(java.lang.String name)
                          throws IlrXmlException

Get the maximum occurence of an attribute. If the collection is unbounded, the UNBOUNDED value is returned.

Throws:

IlrXmlException - raised when the attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

The maxOccurs information of an attribute.

See Also:

UNBOUNDED

getAttributeComponentType

IlrXmlType getAttributeComponentType(java.lang.String name)
                                     throws IlrXmlException

Get the component type of an attribute given its XOM name. In case of a collection attribute, its component type is returned (not its collection type).

Throws:

IlrXmlException - raised when the attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

The minOccurs information of an attribute.

getAttributeXmlName

java.lang.String getAttributeXmlName(java.lang.String name)
                                     throws IlrXmlException

Get the attribute XML name if it exists.

Throws:

IlrXmlException - raised when the attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

The XML name of an attribute.

getSuperclass

IlrXmlClass getSuperclass()

Get the superclass of the class.

Returns:

The super class.

hasRestrictionDerivation

boolean hasRestrictionDerivation()

To know if the derivation is a restriction kind.

hasExtensionDerivation

boolean hasExtensionDerivation()

To know if the derivation is a extension kind.