ilog.cpl.equipment
Class IlpEquipmentHandlerWithDataSource

java.lang.Object
  ilog.cpl.graph.IlpAbstractGraphHandler
      ilog.cpl.graph.IlpGraphHandlerWithDataSource
          ilog.cpl.equipment.IlpEquipmentHandlerWithDataSource

All Implemented Interfaces:

IlpEquipmentHandler, IlpExpansionHandler, IlpGraphHandler, IlpLoadHandler, IlpNodeHandler, IlpPositionHandler

public class IlpEquipmentHandlerWithDataSource
extends IlpGraphHandlerWithDataSource
implements IlpEquipmentHandler

This class is the preferred handler for the Equipment component. It should be set when an IlpMutableDataSource and an IlpEquipmentAdapter are in use.

The handler performs editing operations by accessing the data source. Any changes in the data source are then propagated to the equipment model through the adapter.

The handler also communicates directly with the adapter.

The methods createObjectId, createObject and others can be overridden in subclasses.

Since:

JTGO 3.0

See Also:

IlpEquipmentController.setHandler(ilog.cpl.equipment.IlpEquipmentHandler), IlpEquipmentAdapter, IlpDataSource

Field Summary

Fields inherited from interface ilog.cpl.graph.IlpNodeHandler

LINK_FROM_NODE, LINK_FROM_PORT, LINK_TO_NODE, LINK_TO_PORT

Constructor Summary

IlpEquipmentHandlerWithDataSource(IlpEquipment equipment, IlpAbstractNodeAdapter adapter, IlpMutableDataSource datasource)
Creates the handler.

IlpEquipmentHandlerWithDataSource(IlpMutableEquipmentModel model, IlpEquipmentView view, IlpEquipmentController controller, IlpAbstractNodeAdapter adapter, IlpMutableDataSource datasource)
Creates the handler.

Method Summary

protected IlpDefaultClass	createDefaultClass() Returns the graph handler default position attribute class.
protected Object	createObjectId(Class clazz, IlpAttributeGroup attributes, Map properties) Returns an object id for the creation of a new object.
protected IlpGraphHandlerWithoutDataSource	createSimpleHandler() Instantiates the non-datasource handler (an instance of IlpEquipmentHandlerWithoutDataSource).
protected String	getClassName(IlpAttributeGroup attributes) Returns the class name for objects created by this handler.
IlpEquipmentController	getEquipmentController() Returns the controller with which this handler is associated and from which it gets its requests.
IlpMutableEquipmentModel	getEquipmentModel() Returns the model with which this handler is associated.
IlpEquipmentView	getEquipmentView() Returns the view with which this handler is associated.
protected Logger	getHandlerLogger() Returns the logger used to log messages by this handler.

Methods inherited from class ilog.cpl.graph.IlpGraphHandlerWithDataSource

findIlpClass, getAdapter, getDataSource, getGraphModel, getGraphView, handleChangeRelationship, handleCloneObject, handleCollapseObject, handleCreateObject, handleExpandObject, handleLoad, handleMoveObject, handleRemoveObject, handleUpdateObject, propagatePositionToDataSource, setDataSource, setGraphController, setGraphModel, setGraphView, setPropagatePositionToDataSource

Methods inherited from class ilog.cpl.graph.IlpAbstractGraphHandler

createObject, endBatch, getDefaultClass, getGraphController, startBatch

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.cpl.graph.IlpNodeHandler

handleChangeRelationship, handleCloneObject, handleCreateObject, handleRemoveObject, handleUpdateObject

Methods inherited from interface ilog.cpl.graph.IlpPositionHandler

handleMoveObject

Methods inherited from interface ilog.cpl.graph.IlpExpansionHandler

handleCollapseObject, handleExpandObject

Methods inherited from interface ilog.cpl.graph.IlpLoadHandler

handleLoad

Constructor Detail

IlpEquipmentHandlerWithDataSource

public IlpEquipmentHandlerWithDataSource(IlpEquipment equipment,
                                         IlpAbstractNodeAdapter adapter,
                                         IlpMutableDataSource datasource)

Creates the handler.

Parameters:

equipment - The Equipment component.

adapter - The adapter between the data source and the equipment's model, usually an IlpEquipmentAdapter.

datasource - The data source.

IlpEquipmentHandlerWithDataSource

public IlpEquipmentHandlerWithDataSource(IlpMutableEquipmentModel model,
                                         IlpEquipmentView view,
                                         IlpEquipmentController controller,
                                         IlpAbstractNodeAdapter adapter,
                                         IlpMutableDataSource datasource)

Creates the handler.

Parameters:

model - The Equipment component's model.

view - The Equipment component's view.

controller - The Equipment component's controller.

adapter - The adapter between the data source and the equipment's model, usually an IlpEquipmentAdapter.

datasource - The data source.

Method Detail

getHandlerLogger

protected Logger getHandlerLogger()

Description copied from class: IlpAbstractGraphHandler

Returns the logger used to log messages by this handler.

Specified by:

getHandlerLogger in class IlpAbstractGraphHandler

createSimpleHandler

protected IlpGraphHandlerWithoutDataSource createSimpleHandler()

Instantiates the non-datasource handler (an instance of IlpEquipmentHandlerWithoutDataSource).

Specified by:

createSimpleHandler in class IlpGraphHandlerWithDataSource

Internal method or field: do not use!

getClassName

protected String getClassName(IlpAttributeGroup attributes)

Description copied from class: IlpAbstractGraphHandler

Returns the class name for objects created by this handler.

Specified by:

getClassName in class IlpAbstractGraphHandler

Parameters:

attributes - The attribute group set in the created representation objects.

See Also:

IlpAbstractGraphHandler.findIlpClass(Class, IlpAttributeGroup)

Internal method or field: do not use!

createObjectId

protected Object createObjectId(Class clazz,
                                IlpAttributeGroup attributes,
                                Map properties)

Description copied from class: IlpAbstractGraphHandler

Returns an object id for the creation of a new object.

This method should be overridden in subclasses. The default implementation returns a String.

Note that object identifiers are subject to some constraints; for details, see IlpObject.getIdentifier().

Specified by:

createObjectId in class IlpAbstractGraphHandler

Parameters:

clazz - An implementation of IlpRepresentationNode.

attributes - A set of attributes for the object to be created, or null.

properties - A set of hints for the object to be created, or null.

Returns:

An object id for object creation.

createDefaultClass

protected IlpDefaultClass createDefaultClass()

Description copied from class: IlpAbstractGraphHandler

Returns the graph handler default position attribute class.

Specified by:

createDefaultClass in class IlpAbstractGraphHandler

See Also:

IlpAbstractGraphHandler.getDefaultClass(), IlpAbstractGraphHandler.createObject(Class, IlpAttributeGroup, Map, Object)

getEquipmentModel

public IlpMutableEquipmentModel getEquipmentModel()

Returns the model with which this handler is associated.

getEquipmentView

public IlpEquipmentView getEquipmentView()

Returns the view with which this handler is associated.

getEquipmentController

public IlpEquipmentController getEquipmentController()

Returns the controller with which this handler is associated and from which it gets its requests.