org.dmd.dmw

Class DmwNamedObjectIndexer

java.lang.Object

org.dmd.dmw.DmwNamedObjectIndexer

public class DmwNamedObjectIndexer
extends Object

The DmwNamedObjectIndexer will maintain indices for named objects based on object class. This is a useful utility mechanism for things like caches that may want to allow for the retrieval of objects of a particular class.

The indexer allows for the creation of indices for both concrete and abstract classes.

If indices have been added for a base class and for classes derived from it, adding an object to the indexer will result in its inclusion in multiple indices. So be careful about which indices you add and how you use them.

Update operations against the indexer are thread safe.

Constructor Summary

Constructors

Constructor and Description
DmwNamedObjectIndexer() Constructs a new indexer.

Method Summary

Modifier and Type	Method and Description
void	addToIndices(DmwNamedObjectWrapper obj) This method will add the specified object to the appropriate indices based on its DmcClassInfo.
void	deleteFromIndices(DmwNamedObjectWrapper obj) This method will remove the specified object from all indices to which it had been previously added.
Collection<DmwNamedObjectWrapper>	getIndex(DmcClassInfo ci)
int	getIndexSize(DmcClassInfo ci)
boolean	hasIndex(DmcClassInfo dci)
void	maintainIndex(DmcClassInfo ci) Indicates that an index should be maintained for the specified class of object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DmwNamedObjectIndexer

public DmwNamedObjectIndexer()

Constructs a new indexer.

Method Detail

hasIndex

public boolean hasIndex(DmcClassInfo dci)

Parameters:

dci - The class for which you're checking.

Returns:

true if there's an index for the class and false otherwise.

getIndexSize

public int getIndexSize(DmcClassInfo ci)

Parameters:

ci - The class for which you want the index size.

Returns:

The size of the index or 0 if no objects of that type exist.

getIndex

public Collection<DmwNamedObjectWrapper> getIndex(DmcClassInfo ci)

Parameters:

ci - The class for which you want the index.

Returns:

An iterator over the set of objects in the index. It will be an empty iterator if there are no objects of the specified type.

maintainIndex

public void maintainIndex(DmcClassInfo ci)

Indicates that an index should be maintained for the specified class of object. All objects of the specified class or classes derived from it will be added to the index.

Parameters:

ci - The class information.

addToIndices

public void addToIndices(DmwNamedObjectWrapper obj)

This method will add the specified object to the appropriate indices based on its DmcClassInfo. This applies not just for its construction class but also for any classes from which it is derived.

Parameters:

obj - The object to be added.

deleteFromIndices

public void deleteFromIndices(DmwNamedObjectWrapper obj)

This method will remove the specified object from all indices to which it had been previously added.

Parameters:

obj -