org.tmapi.core
Interface TopicMapSystem.ConfigurableHelperObject

All Known Subinterfaces:

AssociationRolesIndex, AssociationsIndex, Index, OccurrencesIndex, ScopedObjectsIndex, TopicMapObjectsIndex, TopicNamesIndex, TopicsIndex, VariantsIndex

Enclosing interface:

TopicMapSystem

public static interface TopicMapSystem.ConfigurableHelperObject

An interface for a helper object implementation which requires notification of the TopicMap instance it acts upon.

Method Summary

void	configure(TopicMap tm) Configuration method of the helper object.

Method Detail

configure

public void configure(TopicMap tm)
               throws HelperObjectConfigurationException

Configuration method of the helper object. The object instance must be guaranteed that this method will always be invoked prior to calls to any other public class method other than constructors.

Parameters:

tm - the TopicMap instance that this helper object acts upon.

Throws:

HelperObjectConfigurationException - if the configuration could not be completed for some reason.