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

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by net.ontopia.topicmaps.nav2.taglibs.output.BaseOutputProducingTag
          extended by net.ontopia.topicmaps.nav2.taglibs.output.LocatorTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, OutputProducingTagIF, StringifierIF

public class LocatorTag
extends BaseOutputProducingTag
implements StringifierIF

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 javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
LocatorTag()
           
 
Method Summary
 void generateOutput(javax.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.
 void setStringifier(String strifyCN)
          Tag attribute for setting the stringifier to be used when producing the string from the selected object.
 String toString(Object object)
          Returns a stringified version of the object, i.e.
 
Methods inherited from class net.ontopia.topicmaps.nav2.taglibs.output.BaseOutputProducingTag
doEndTag, doStartTag, getCollectionSize, print2Writer, release, setEscapeEntities, setOf, setSuppressEmptyCollection
 
Methods inherited from class javax.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
 

Constructor Detail

LocatorTag

public LocatorTag()
Method Detail

generateOutput

public final void generateOutput(javax.servlet.jsp.JspWriter out,
                                 Iterator iter)
                          throws javax.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:
javax.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

toString

public String toString(Object object)
Description copied from interface: StringifierIF
Returns a stringified version of the object, i.e. a string representation of that object.

Specified by:
toString in interface StringifierIF
Parameters:
object - the object that is to be made a string representation of.
Returns:
a string representation of the object argument.


Copyright © 2000-2012 Ontopia.