org.dlese.dpc.vocab.tags.opml
Class MetadataVocabTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.dlese.dpc.vocab.tags.opml.MetadataVocabTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

Direct Known Subclasses:

MetadataVocabCheckboxesTag, MetadataVocabGetOPMLTag, MetadataVocabGetResponseOPMLTag, MetadataVocabHiddenInputsTag, MetadataVocabSelectListTag, MetadataVocabSetResponseGroupTag, MetadataVocabSetResponseValueTag, MetadataVocabTopLevelAbbrevLabelTag, MetadataVocabTranslateValueTag, MetadataVocabTreeMenuTag, MetadataVocabUiDisplayTag, MetadataVocabUiLabelTag

public class MetadataVocabTag
extends TagSupport

Default tag handler for rendering controlled vocabularies. All other vocab tags should extend this! This is the predecessor to the terms/groups system, using OPML (and "format/version/audience/language" groupings instead of "system.interface.language"), and providing a cleaner and more thorough set of methods for accessing mappings between metadata vocabulary encoded IDs and their term names.

Author:

Ryan Deardorff

See Also:

Serialized Form

Field Summary

protected String	audience
protected String	field
protected String	language
protected String	metaFormat
protected String	metaVersion
protected StringUtil	stringUtil
protected String	subGroup
protected String	system
protected MetadataVocab	vocab

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

MetadataVocabTag()

Method Summary

void	release() Release from memory
void	setAudience(String audience) Audience is a user group, i.e.
void	setField(String field) Sets the field attribute of the MetadataVocabTag object
void	setLanguage(String language) Language will allow for support of internationalization.
void	setMetaFormat(String metaFormat) MetaFormat is the metadata format, i.e.
void	setSubGroup(String subGroup) SubGroup is used to reference a particular spot WITHIN the vocabulary hierarchy, for example, setting "Visual" for a call to the resource types vocab would return only those values within the "Visual" sub-grouping as defined in the OPML.
void	setupTag(PageContext pageContext) Get the vocab object from the page context and expand system to be a concatenation of system, interface, and language

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

doAfterBody, doEndTag, doStartTag, 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 Detail

audience

protected String audience

metaFormat

protected String metaFormat

metaVersion

protected String metaVersion

language

protected String language

system

protected String system

field

protected String field

subGroup

protected String subGroup

vocab

protected MetadataVocab vocab

stringUtil

protected StringUtil stringUtil

Constructor Detail

MetadataVocabTag

public MetadataVocabTag()

Method Detail

setAudience

public void setAudience(String audience)

Audience is a user group, i.e. "default", "community", or "cataloger"

Parameters:

audience - The new audience value

setMetaFormat

public void setMetaFormat(String metaFormat)

MetaFormat is the metadata format, i.e. "adn", "news_opps", or "dlese_collect"

Parameters:

metaFormat - The new metaFormat value

setLanguage

public void setLanguage(String language)

Language will allow for support of internationalization. "en-us" indicates the United States version of English.

Parameters:

language - The new language value

setField

public void setField(String field)

Sets the field attribute of the MetadataVocabTag object

Parameters:

field - The new field value

setSubGroup

public void setSubGroup(String subGroup)

SubGroup is used to reference a particular spot WITHIN the vocabulary hierarchy, for example, setting "Visual" for a call to the resource types vocab would return only those values within the "Visual" sub-grouping as defined in the OPML.

Parameters:

subGroup - The new subGroup value

setupTag

public void setupTag(PageContext pageContext)
              throws JspException

Get the vocab object from the page context and expand system to be a concatenation of system, interface, and language

Parameters:

pageContext -

Throws:

JspException

release

public void release()

Release from memory

Specified by:

release in interface Tag

Overrides:

release in class TagSupport