ilog.views.sdm.modeltools

Class IlvContentController

java.lang.Object

ilog.views.sdm.modeltools.IlvContentController

public class IlvContentController
extends Object

An independent class that manages content loading and unloading.

Since:

JViews 8.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUGMENT Constant value used by lockArea(IlvRect, int) to indicate that previously locked objects remain locked.
static int	LOAD Constant value used by processObjects(Enumeration, int) to indicate the unlock action.
static int	LOCK Constant value used by processObjects(Enumeration, int) to indicate the lock action.
static int	OVERRIDE Constant value used by lockArea(IlvRect, int) to indicate that previously locked objects must be unlocked.
static int	UNLOAD Constant value used by processObjects(Enumeration, int) to indicate the unload action.

Constructor Summary

Constructors

Constructor and Description
IlvContentController() Basic constructor.

Method Summary

Modifier and Type	Method and Description
int	getCacheSize() Returns the cache size.
IlvContentHandler	getContentHandler() Returns the handler.
int	getLoadedCount() Returns the current number of objects in the "load" state, that is, objects in the cache.
int	getLockedCount() Returns the current number of locked objects.
int	getObjectStatus(Object obj) Returns the current state of the given object.
IlvSDMEngine	getSDMEngine() Returns the SDM engine.
boolean	isNotificationEnabled() Returns the notificationEnabled state.
int	lockArea(IlvRect area, int mode) Locks the objects that intersect with the given rectangle.
int	processAllObjects(int action) Changes the state of all objects at once.
int	processObjects(Enumeration objs, int action) Similar to processObjects(Object[], int), with the objs parameter specified as an Enumeration.
int	processObjects(Iterator objs, int action) Similar to processObjects(Object[], int), with the objs parameter specified as an Iterator.
int	processObjects(Object[] objs, int action) Locks, loads, or unloads the given objects, according to the action value which can be one of LOCK, LOAD, or UNLOAD.
void	setCacheSize(int cacheSize) Sets the cache size.
void	setContentHandler(IlvContentHandler handler) Sets the handler.
void	setNotificationEnabled(boolean notificationEnabled) Sets the notificationEnabled state.
void	setSDMEngine(IlvSDMEngine engine) Sets the SDM engine to work on.

Methods inherited from class java.lang.Object

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

Field Detail

OVERRIDE

public static final int OVERRIDE

Constant value used by lockArea(IlvRect, int) to indicate that previously locked objects must be unlocked.

See Also:

Constant Field Values

AUGMENT

public static final int AUGMENT

Constant value used by lockArea(IlvRect, int) to indicate that previously locked objects remain locked.

See Also:

Constant Field Values

LOCK

public static final int LOCK

Constant value used by processObjects(Enumeration, int) to indicate the lock action.

See Also:

Constant Field Values

LOAD

public static final int LOAD

Constant value used by processObjects(Enumeration, int) to indicate the unlock action. Once unlocked, objects can be unloaded at any time.

See Also:

Constant Field Values

UNLOAD

public static final int UNLOAD

Constant value used by processObjects(Enumeration, int) to indicate the unload action.

See Also:

Constant Field Values

Constructor Detail

IlvContentController

public IlvContentController()

Basic constructor.

Method Detail

lockArea

public int lockArea(IlvRect area,
                    int mode)

Locks the objects that intersect with the given rectangle.

Parameters:

area - The rectangle.

mode - Indicates what happens to previously locked objects. The value is either OVERRIDE or AUGMENT.

Returns:

The number of newly locked objects.

processObjects

public int processObjects(Object[] objs,
                          int action)

Locks, loads, or unloads the given objects, according to the action value which can be one of LOCK, LOAD, or UNLOAD.

Parameters:

objs - The array of objects to process.

action - The action to perform.

Returns:

The number of processed objects.

processObjects

public int processObjects(Enumeration objs,
                          int action)

Similar to processObjects(Object[], int), with the objs parameter specified as an Enumeration.

Parameters:

objs - The objects to process.

action - The action to perform, one of LOCK, LOAD, or UNLOAD.

Returns:

The number of processed objects

See Also:

processObjects(Object[], int)

processObjects

public int processObjects(Iterator objs,
                          int action)

Similar to processObjects(Object[], int), with the objs parameter specified as an Iterator.

Parameters:

objs - The objects to process.

action - The action to perform, one of LOCK, LOAD, or UNLOAD.

Returns:

The number of processed objects.

See Also:

processObjects(Object[], int)

processAllObjects

public int processAllObjects(int action)

Changes the state of all objects at once.

Parameters:

action - LOCK, LOAD, or UNLOAD

Returns:

The real number of objects that changed states.

getLockedCount

public int getLockedCount()

Returns the current number of locked objects.

Returns:

The number of objects in the "lock" state.

getLoadedCount

public int getLoadedCount()

Returns the current number of objects in the "load" state, that is, objects in the cache.

Returns:

The number of objects in the "load" state.

getObjectStatus

public int getObjectStatus(Object obj)

Returns the current state of the given object.

Parameters:

obj - The SDM model object.

Returns:

The current state of the object.

getSDMEngine

public IlvSDMEngine getSDMEngine()

Returns the SDM engine.

Returns:

The engine.

setSDMEngine

public void setSDMEngine(IlvSDMEngine engine)

Sets the SDM engine to work on.

Parameters:

engine - The engine to set.

getContentHandler

public IlvContentHandler getContentHandler()

Returns the handler.

Returns:

The handler.

setContentHandler

public void setContentHandler(IlvContentHandler handler)

Sets the handler.

Parameters:

handler - The handler to set.

getCacheSize

public int getCacheSize()

Returns the cache size.

Returns:

The cache size.

setCacheSize

public void setCacheSize(int cacheSize)

Sets the cache size.

Parameters:

cacheSize - The cache size to set.

isNotificationEnabled

public boolean isNotificationEnabled()

Returns the notificationEnabled state.

Returns:

The notificationEnabled state.

setNotificationEnabled

public void setNotificationEnabled(boolean notificationEnabled)

Sets the notificationEnabled state.

Parameters:

notificationEnabled - The notificationEnabled to set.