Package net.ontopia.topicmaps.nav2.taglibs.output

Class LocatorTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

net.ontopia.topicmaps.nav2.taglibs.output.BaseOutputProducingTag

net.ontopia.topicmaps.nav2.taglibs.output.LocatorTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable, Function<LocatorIF,String>, OutputProducingTagIF

public class LocatorTag
extends BaseOutputProducingTag
implements Function<LocatorIF,String>

INTERNAL: Output Producing Tag for writing out the URI of the resource that is an occurrence, a variant name, or a locator.

Note: Only puts out first entry retrieved by iterator.

See Also:

• Serialized Form

Field Summary

Fields inherited from class net.ontopia.topicmaps.nav2.taglibs.output.BaseOutputProducingTag

contextTag, escapeEntities, numberOfElements, suppressEmptyCollection, variableName

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
LocatorTag()

Method Summary

Modifier and Type	Method	Description
String	apply(LocatorIF locator)
final void	generateOutput(jakarta.servlet.jsp.JspWriter out, Iterator iter)	INTERNAL: Generate information extracted from the input collection provided access by specified iterator.
void	setRelative(String relativeToTopicmap)	INTERNAL: Set the behaviour of the output, whether or not the base address of the topicmap should be not be in generated string.
final void	setStringifier(String strifyCN)	Tag attribute for setting the stringifier to be used when producing the string from the selected object.

Methods inherited from class net.ontopia.topicmaps.nav2.taglibs.output.BaseOutputProducingTag

doEndTag, doStartTag, getCollectionSize, print2Writer, release, setOf

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

LocatorTag

public LocatorTag()

Method Details

generateOutput

public final void generateOutput(jakarta.servlet.jsp.JspWriter out,
 Iterator iter)
                          throws jakarta.servlet.jsp.JspTagException,
IOException

Description copied from interface: OutputProducingTagIF

INTERNAL: Generate information extracted from the input collection provided access by specified iterator. This is expected to be written to the JspWriter object.

Specified by:

generateOutput in interface OutputProducingTagIF

Specified by:

generateOutput in class BaseOutputProducingTag

Throws:

jakarta.servlet.jsp.JspTagException

IOException

setRelative

public void setRelative(String relativeToTopicmap)

INTERNAL: Set the behaviour of the output, whether or not the base address of the topicmap should be not be in generated string. Default is to generate full locator address. Allowed values are: "yes|true|no|false". (FIXME: not implemented yet)

setStringifier

public final void setStringifier(String strifyCN)

Tag attribute for setting the stringifier to be used when producing the string from the selected object.

Since:

2.0

apply

public String apply(LocatorIF locator)

Specified by:

apply in interface Function<LocatorIF,String>