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

Class RolesTag

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.value.BaseScopedTag

net.ontopia.topicmaps.nav2.taglibs.TMvalue.RolesTag

All Implemented Interfaces:

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

public class RolesTag
extends BaseScopedTag

INTERNAL: Value Producing Tag for finding all the association roles of all the topics and associations in a collection.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINARY
static final String	NARY

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

useUserContextFilter

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 net.ontopia.topicmaps.nav2.core.ScopeSupportIF

DEC_APPLICABLE_IN, DEC_INTERSECTION, DEC_SUBSET, DEC_SUPERSET, DEC_WITHIN, SCOPE_ASSOCIATIONS, SCOPE_BASENAMES, SCOPE_OCCURRENCES, SCOPE_VARIANTS

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
RolesTag()

Method Summary

Modifier and Type	Method	Description
Collection	process(Collection tmObjects)	INTERNAL: Process the input collection and return the output collection.
void	setCardinality(String cardinality)	Specify in which cardinality you are interested.
void	setRemove(String varRemoveTopicColl)	Sets the variable name of an input collection consisting of one or more topics that will removed from the retrieved list of association role players.

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

getScopeDecider, getScopeFilter, setContextFilter

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

BINARY

public static final String BINARY

See Also:

• Constant Field Values

NARY

public static final String NARY

See Also:

• Constant Field Values

Constructor Details

RolesTag

public RolesTag()

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

setRemove

public void setRemove(String varRemoveTopicColl)

Sets the variable name of an input collection consisting of one or more topics that will removed from the retrieved list of association role players.

setCardinality

public void setCardinality(String cardinality)

Specify in which cardinality you are interested. This filters out the association roles retrieved for the input collection (consisting of TopicIF and AssociationIF objects). If not specified any kind of cardinality is returned. Allowed values are "binary", "nary" (means at least trenary).