Package net.ontopia.topicmaps.nav2.taglibs.TMvalue

Class FilterTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingTag

net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingAndAcceptingTag

net.ontopia.topicmaps.nav2.taglibs.TMvalue.FilterTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable, ValueAcceptingTagIF, ValueProducingTagIF

public class FilterTag
extends BaseValueProducingAndAcceptingTag

INTERNAL: Value Producing Tag for taking an input collection and filtering it, passing only some of the elements on to its parent (could be a set tag or another filter element).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_ASSOC
static final String	CLASS_BASENAME
static final String	CLASS_LOCATOR
static final String	CLASS_OCC
static final String	CLASS_ROLE
static final String	CLASS_TOPIC
static final String	CLASS_TOPICMAP
static final String	CLASS_VARIANT
static final String	UNTYPED

Fields inherited from class net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingAndAcceptingTag

contextTag, inputCollection

Fields inherited from class net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingTag

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
FilterTag()

Method Summary

Modifier and Type	Method	Description
NavigatorDeciderIF	getDeciderInstance(String classname)
Collection	process(Collection tmObjects)	INTERNAL: Process the input collection and return the output collection.
void	setDecider(String classname)
void	setInScopeOf(String inScopeOfValue)
void	setInstanceOf(String instanceOf)	Sets instanceOf string, which will first interpreted as an URI for retrieving a topic by it's subject indicator.
void	setInvert(String invert)
void	setIs(String kind)	Sets the kind of topic map objects that should be passed on.
void	setRandomElement(String randomElement)	Set the behaviour of the filter to choose a random element from the given input collection.

Methods inherited from class net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingAndAcceptingTag

accept, doEndTag, doStartTag, getInputCollection

Methods inherited from class net.ontopia.topicmaps.nav2.taglibs.value.BaseValueProducingTag

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

Field Details

CLASS_TOPICMAP

public static final String CLASS_TOPICMAP

See Also:

• Constant Field Values

CLASS_TOPIC

public static final String CLASS_TOPIC

See Also:

• Constant Field Values

CLASS_ASSOC

public static final String CLASS_ASSOC

See Also:

• Constant Field Values

CLASS_OCC

public static final String CLASS_OCC

See Also:

• Constant Field Values

CLASS_BASENAME

public static final String CLASS_BASENAME

See Also:

• Constant Field Values

CLASS_VARIANT

public static final String CLASS_VARIANT

See Also:

• Constant Field Values

CLASS_ROLE

public static final String CLASS_ROLE

See Also:

• Constant Field Values

CLASS_LOCATOR

public static final String CLASS_LOCATOR

See Also:

• Constant Field Values

UNTYPED

public static final String UNTYPED

See Also:

• Constant Field Values

Constructor Details

FilterTag

public FilterTag()

Method Details

process

public Collection process(Collection tmObjects)
                   throws jakarta.servlet.jsp.JspTagException

Description copied from interface: ValueProducingTagIF

INTERNAL: Process the input collection and return the output collection. This collection will afterwards typically be passed up to the parent tag, which should be a value-accepting tag.

Throws:

jakarta.servlet.jsp.JspTagException

See Also:

• BaseValueProducingTag

setInstanceOf

public void setInstanceOf(String instanceOf)

Sets instanceOf string, which will first interpreted as an URI for retrieving a topic by it's subject indicator. If this is without success instanceOf will interpreted as a variable name.

Special string "{NONE}" will be interpreted to retrieve all untyped instances.

setDecider

public void setDecider(String classname)

setInScopeOf

public void setInScopeOf(String inScopeOfValue)

setInvert

public void setInvert(String invert)

setRandomElement

public void setRandomElement(String randomElement)

Set the behaviour of the filter to choose a random element from the given input collection.

Since:

1.3.2

setIs

public void setIs(String kind)

Sets the kind of topic map objects that should be passed on.

Parameters:

kind - String which should contain one of the following values: topicmap | association | occurrence | topic | basename | variant | role | locator

getDeciderInstance

public NavigatorDeciderIF getDeciderInstance(String classname)
                                      throws NavigatorRuntimeException

Throws:

NavigatorRuntimeException