net.ontopia.topicmaps.nav2.impl.basic

Class DefaultUniversalLinkGenerator

java.lang.Object

net.ontopia.topicmaps.nav2.impl.basic.DefaultUniversalLinkGenerator

All Implemented Interfaces:

LinkGeneratorIF

public class DefaultUniversalLinkGenerator
extends Object
implements LinkGeneratorIF

INTERNAL: Default link generator which produces links to any kind of topic map object. Can replace the %id% and %topicmap% variables, but does not recognize any others. Used by the link tag.

See Also:

LinkTag

Field Summary

Fields inherited from interface net.ontopia.topicmaps.nav2.core.LinkGeneratorIF

LINK_ID_KEY, LINK_TOPICMAP_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultUniversalLinkGenerator()

Method Summary

Modifier and Type	Method and Description
String	generate(ContextTag contextTag, TMObjectIF tmObj, String topicmapId, String template) INTERNAL: create a String which contains link information for a Topic Map Object.
String	generate(ContextTag contextTag, TopicMapReferenceIF tmRefObj, String template) INTERNAL: create a String which contains link information to a Topicmap retrieved with the help of an TopicMapReferenceIF object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUniversalLinkGenerator

public DefaultUniversalLinkGenerator()

Method Detail

generate

public String generate(ContextTag contextTag,
                       TMObjectIF tmObj,
                       String topicmapId,
                       String template)

Description copied from interface: LinkGeneratorIF

INTERNAL: create a String which contains link information for a Topic Map Object.

Note: This String gets converted to an URL encoded format by the link tag automatically afterwards.

Specified by:

generate in interface LinkGeneratorIF

Parameters:

contextTag - A ContextTag object providing access to all important information to the application.

tmObj - An Object implementing TMObjectIF to which the link should direct.

topicmapId - The id that the topic map has in the registry.

template - A template string which may contain template variable(s) which are replaced.

generate

public String generate(ContextTag contextTag,
                       TopicMapReferenceIF tmRefObj,
                       String template)

Description copied from interface: LinkGeneratorIF

INTERNAL: create a String which contains link information to a Topicmap retrieved with the help of an TopicMapReferenceIF object.

Note: This String gets converted to an URL encoded format by the link tag automatically afterwards.

Specified by:

generate in interface LinkGeneratorIF

Parameters:

contextTag - A ContextTag object providing access to all important information to the application.

tmRefObj - An Object implementing TopicMapReferenceIF to which beloning Topic Map the link should direct.

template - A template string which may contain template variable(s) which are replaced.