org.tm4j.vtl
Class TM4JXMLVelocityConfiguration

java.lang.Object
  org.tm4j.vtl.TM4JVelocityConfigurationBase
      org.tm4j.vtl.TM4JXMLVelocityConfiguration

All Implemented Interfaces:

TM4JVelocityConfiguration

public class TM4JXMLVelocityConfiguration

extends TM4JVelocityConfigurationBase

implements TM4JVelocityConfiguration

Nested Class Summary

Nested classes inherited from class org.tm4j.vtl.TM4JVelocityConfiguration

TM4JVelocityConfiguration.ConfigurationScope

Field Summary

Fields inherited from interface org.tm4j.vtl.TM4JVelocityConfiguration

SCOPE_INSTANCES, SCOPE_SELF, SCOPE_SUBCLASSES

Constructor Summary

TM4JXMLVelocityConfiguration(org.apache.avalon.framework.configuration.Configuration configuration, java.io.File baseDir)

Method Summary

java.util.Properties	getHelpers()
LoadableTM	getLoadable(java.lang.String topicMapName) Returns the LoadableTM implementation that represents the interface to load or unload the specified topic map
java.lang.String[]	getLoadables()
java.lang.String[]	getPageInfoClassNames(java.lang.String tmName)
java.lang.Class	getProviderClass(java.lang.String providerName)
protected org.apache.avalon.framework.configuration.Configuration	getProviderConfiguration(java.lang.String providerName)
java.util.Properties	getProviderProps(java.lang.String providerName)
java.lang.String[]	getProviders()
RenderInfo	getRenderInfo(org.tm4j.topicmap.Topic t, TM4JVelocityConfiguration.ConfigurationScope scope)
TopicMapConfig[]	getTopicMaps(java.lang.String providerName, java.io.File baseDir)
void	topicmapLoaded(org.tm4j.topicmap.TopicMapProvider provider, java.lang.String tmName, org.tm4j.topicmap.TopicMap tm) Invoked when the application loads a new topic map.
void	topicmapUnloaded(org.tm4j.topicmap.TopicMapProvider provider, java.lang.String tmName, org.tm4j.topicmap.TopicMap tm) Invoked when the application unloads a topic map.

Methods inherited from class org.tm4j.vtl.TM4JVelocityConfigurationBase

getPageInfo, getRenderInfo, getTemplateAndPageInfo, registerHelpers, registerLoadedTopicMaps, registerProviders, setUpContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tm4j.vtl.TM4JVelocityConfiguration

getPageInfo, getRenderInfo, getTemplateAndPageInfo, setUpContext

Constructor Detail

TM4JXMLVelocityConfiguration

public TM4JXMLVelocityConfiguration(org.apache.avalon.framework.configuration.Configuration configuration,
                                    java.io.File baseDir)
                             throws TM4JVelocityConfigurationException

Method Detail

topicmapLoaded

public void topicmapLoaded(org.tm4j.topicmap.TopicMapProvider provider,
                           java.lang.String tmName,
                           org.tm4j.topicmap.TopicMap tm)

Description copied from interface: TM4JVelocityConfiguration

Invoked when the application loads a new topic map. The implementation of this method can be used to ensure that PageInfo objects are created for the topic map in question.

Specified by:

topicmapLoaded in interface TM4JVelocityConfiguration

Overrides:

topicmapLoaded in class TM4JVelocityConfigurationBase

topicmapUnloaded

public void topicmapUnloaded(org.tm4j.topicmap.TopicMapProvider provider,
                             java.lang.String tmName,
                             org.tm4j.topicmap.TopicMap tm)

Description copied from interface: TM4JVelocityConfiguration

Invoked when the application unloads a topic map. The implementation of this method can be used to free up the PageInfo objects created when the topic map was loaded.

Specified by:

topicmapUnloaded in interface TM4JVelocityConfiguration

Overrides:

topicmapUnloaded in class TM4JVelocityConfigurationBase

getProviders

public java.lang.String[] getProviders()

Specified by:

getProviders in class TM4JVelocityConfigurationBase

getProviderConfiguration

protected org.apache.avalon.framework.configuration.Configuration getProviderConfiguration(java.lang.String providerName)

getProviderClass

public java.lang.Class getProviderClass(java.lang.String providerName)

Specified by:

getProviderClass in class TM4JVelocityConfigurationBase

getProviderProps

public java.util.Properties getProviderProps(java.lang.String providerName)

Specified by:

getProviderProps in class TM4JVelocityConfigurationBase

getTopicMaps

public TopicMapConfig[] getTopicMaps(java.lang.String providerName,
                                     java.io.File baseDir)

Specified by:

getTopicMaps in class TM4JVelocityConfigurationBase

getHelpers

public java.util.Properties getHelpers()

Specified by:

getHelpers in class TM4JVelocityConfigurationBase

getRenderInfo

public RenderInfo getRenderInfo(org.tm4j.topicmap.Topic t,
                                TM4JVelocityConfiguration.ConfigurationScope scope)

Specified by:

getRenderInfo in class TM4JVelocityConfigurationBase

getPageInfoClassNames

public java.lang.String[] getPageInfoClassNames(java.lang.String tmName)

Specified by:

getPageInfoClassNames in class TM4JVelocityConfigurationBase

getLoadable

public LoadableTM getLoadable(java.lang.String topicMapName)

Description copied from interface: TM4JVelocityConfiguration

Returns the LoadableTM implementation that represents the interface to load or unload the specified topic map

Specified by:

getLoadable in interface TM4JVelocityConfiguration

Parameters:

topicMapName - the symbolic name assigned to the topic map in the configuration file.

Returns:

the LoadableTM implementation that represents the topic map identified by topicMapName

getLoadables

public java.lang.String[] getLoadables()

Specified by:

getLoadables in interface TM4JVelocityConfiguration