ilog.tgo.model

Class IltObjectInfo

java.lang.Object

ilog.cpl.model.IlpAbstractClass

ilog.cpl.model.IlpDefaultClass

ilog.tgo.model.IltObjectInfo

All Implemented Interfaces:

IlpAttributeGroup, IlpClass, IlpMutableAttributeGroup, IlpMutableClass

public class IltObjectInfo
extends IlpDefaultClass

Each IltObjectInfo instance describes a subclass of IltObject.

See Also:

IltObject

Constructor Summary

Constructors

Constructor and Description
IltObjectInfo(Class clazz, String description) Creates the descriptor of an IltObject subclass.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(IlpAttribute a, Object defaultValue) Add a new attribute to the model with a given default value.
static Enumeration	AllObjectInfos() Returns an enumeration of all existing IltObjectInfo instances.
static IltObjectInfo	FromClass(Class clazz, boolean forceLoadInit) Returns the class information for an object class.
ilog.tgo.attacher.IltAttacherInfo	getAttacherInfo(ilog.tgo.graphic.internal.IltGraphicRepresentationStyle rep) Returns the instance of IltAttacherInfo which represents the given graphical representation.
ilog.tgo.attacher.IltAttacherInfoController	getAttacherInfoController() Returns the instance responsible for controlling the attacher information for the different types of graphical representation.
Object	getDefaultValue(IlpAttribute a) Return the default value for the attribute, if there is one.
Class	getDefiningClass() Returns the object class, a subclass of IltObject.
String	getDescription() Returns a description of the object class.
ilog.tgo.graphic.internal.IltClassLegend	getLegend() Deprecated. Please use IlpStyleManager.getStyle(IlpClass) instead.
ilog.tgo.mapper.attribute.IltMapAttributeStrategy	getMapAttributeStrategy() Retrieves the strategy to map the attributes of the class being represented by this info.
ilog.tgo.mapper.IltObjectMapper	getObjectMapper() Returns the most specific object mapper.
ilog.tgo.mapper.attribute.IltObjectSystemMapper	getObjectSystemMapper() Returns the object that stores the attribute mappers for this class.
IltObjectInfo	getParent() Returns the parent class descriptor.
void	initializeDefaultValues(IlpObject bo) Initialize the default values set in this business class, by adding these attributes with their default values to the given business object.
IlpObject	newInstance(IlpClass ilpClass, Object identifier, boolean initializeAttributeValues) Creates an instance of the class or of one of its subclass.
IlpObject	newInstance(Object identifier, boolean initializeAttributeValues) Creates an instance of the class.
void	removeAttributeGroup(IlpAttributeGroup model) Removes the given model from the list of models.
void	setAttacherInfo(ilog.tgo.graphic.internal.IltGraphicRepresentationStyle rep, ilog.tgo.attacher.IltAttacherInfo info) Sets the instance of IltAttacherInfo which represents the given graphical representation.
void	setMapAttributeStrategy(ilog.tgo.mapper.attribute.IltMapAttributeStrategy strategy) Defines a strategy to map the attributes of the class being represented by this info.
void	setObjectMapper(ilog.tgo.mapper.IltObjectMapper mapper) Sets the object to graphic mapper for this class of objects.
void	setSuperClass(IlpClass superClass) Sets the superclass.

Methods inherited from class ilog.cpl.model.IlpDefaultClass

addAttribute, addAttributeGroup, addAttributeGroupListener, fireEvent, getAttribute, getAttributeGroups, getAttributes, getDeclaredAttributes, hasAttribute, removeAttribute, removeAttributeGroupListener, toString

Methods inherited from class ilog.cpl.model.IlpAbstractClass

addSubClass, getName, getSubClasses, getSuperClass, isAssignableFrom, isSubClassOf, removeSubClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.cpl.model.IlpMutableClass

addSubClass, removeSubClass

Methods inherited from interface ilog.cpl.model.IlpClass

getSubClasses, getSuperClass, isAssignableFrom, isSubClassOf

Methods inherited from interface ilog.cpl.model.IlpAttributeGroup

getName

Constructor Detail

IltObjectInfo

public IltObjectInfo(Class clazz,
                     String description)

Creates the descriptor of an IltObject subclass. By convention, this descriptor is stored in a static class variable called metainfo.

Method Detail

AllObjectInfos

public static Enumeration AllObjectInfos()

Returns an enumeration of all existing IltObjectInfo instances.

Returns:

an enumeration of IltObjectInfo

Internal: do not use!

FromClass

public static IltObjectInfo FromClass(Class clazz,
                                      boolean forceLoadInit)

Returns the class information for an object class.

Parameters:

forceLoadInit - if true, force the loading and initialization of the class, and don't return null

Internal: do not use!

getDefiningClass

public Class getDefiningClass()

Returns the object class, a subclass of IltObject.

Internal: do not use!

getDescription

public String getDescription()

Returns a description of the object class.

Internal: do not use!

getParent

public IltObjectInfo getParent()

Returns the parent class descriptor.

Internal: do not use!

newInstance

public IlpObject newInstance(Object identifier,
                             boolean initializeAttributeValues)

Creates an instance of the class. The instance is an instance of the IlpObject interface.

Specified by:

newInstance in interface IlpClass

Overrides:

newInstance in class IlpDefaultClass

Parameters:

identifier - Object identifier.

initializeAttributeValues - Whether or not the default attribute values should be initialized.

Returns:

An object of this dynamic class.

Since:

JTGO 3.0

See Also:

IlpObject, IlpAttribute.getDefaultValue()

newInstance

public IlpObject newInstance(IlpClass ilpClass,
                             Object identifier,
                             boolean initializeAttributeValues)

Creates an instance of the class or of one of its subclass. The instance is an instance of the IlpObject interface.

Specified by:

newInstance in interface IlpClass

Overrides:

newInstance in class IlpDefaultClass

Parameters:

ilpClass - Business class.

identifier - Object identifier.

initializeAttributeValues - Whether or not the default attribute values should be initialized.

Returns:

An object of this dynamic class.

Since:

JTGO 3.0

See Also:

IlpObject, IlpAttribute.getDefaultValue()

setSuperClass

public void setSuperClass(IlpClass superClass)

Sets the superclass.

This method is called automatically at construction time.

Specified by:

setSuperClass in interface IlpMutableClass

Overrides:

setSuperClass in class IlpDefaultClass

Parameters:

superClass - Super class

Throws:

IllegalArgumentException - if the given class does not correspond to the super class specified at construction time.

See Also:

IlpAbstractClass.addSubClass(ilog.cpl.model.IlpClass)

removeAttributeGroup

public void removeAttributeGroup(IlpAttributeGroup model)

Removes the given model from the list of models.

Specified by:

removeAttributeGroup in interface IlpMutableClass

Overrides:

removeAttributeGroup in class IlpDefaultClass

Throws:

IllegalArgumentException - if the attribute group being removed corresponds to the super class.

addAttribute

public void addAttribute(IlpAttribute a,
                         Object defaultValue)

Add a new attribute to the model with a given default value.

Since:

JTGO 3.0

getDefaultValue

public Object getDefaultValue(IlpAttribute a)

Return the default value for the attribute, if there is one.

Internal: do not use!

initializeDefaultValues

public void initializeDefaultValues(IlpObject bo)

Initialize the default values set in this business class, by adding these attributes with their default values to the given business object.

See Also:

IltObject.initializeDefaultValues()

Internal: do not use!

setObjectMapper

public void setObjectMapper(ilog.tgo.mapper.IltObjectMapper mapper)

Sets the object to graphic mapper for this class of objects.

Internal: do not use!

getObjectMapper

public ilog.tgo.mapper.IltObjectMapper getObjectMapper()

Returns the most specific object mapper.

Internal: do not use!

getObjectSystemMapper

public ilog.tgo.mapper.attribute.IltObjectSystemMapper getObjectSystemMapper()

Returns the object that stores the attribute mappers for this class.

Internal: do not use!

getAttacherInfoController

public ilog.tgo.attacher.IltAttacherInfoController getAttacherInfoController()

Returns the instance responsible for controlling the attacher information for the different types of graphical representation. The attribute _attacherInfoController should never be used directly, instead this method must be called.

Internal: do not use!

getAttacherInfo

public ilog.tgo.attacher.IltAttacherInfo getAttacherInfo(ilog.tgo.graphic.internal.IltGraphicRepresentationStyle rep)

Returns the instance of IltAttacherInfo which represents the given graphical representation.

Internal: do not use!

setAttacherInfo

public void setAttacherInfo(ilog.tgo.graphic.internal.IltGraphicRepresentationStyle rep,
                            ilog.tgo.attacher.IltAttacherInfo info)

Sets the instance of IltAttacherInfo which represents the given graphical representation.

Internal: do not use!

setMapAttributeStrategy

public void setMapAttributeStrategy(ilog.tgo.mapper.attribute.IltMapAttributeStrategy strategy)

Defines a strategy to map the attributes of the class being represented by this info.

Internal: do not use!

getMapAttributeStrategy

public ilog.tgo.mapper.attribute.IltMapAttributeStrategy getMapAttributeStrategy()

Retrieves the strategy to map the attributes of the class being represented by this info.

Internal: do not use!

getLegend

@Deprecated
public ilog.tgo.graphic.internal.IltClassLegend getLegend()

Deprecated. Please use IlpStyleManager.getStyle(IlpClass) instead.

Returns the class legend

Internal: do not use!

Deprecated Since:

JTGO 3.0