org.dlese.dpc.vocab

Interface MetadataVocab

All Superinterfaces:

org.xml.sax.ContentHandler

All Known Implementing Classes:

MetadataVocabOPML, MetadataVocabTermsGroups

public interface MetadataVocab
extends org.xml.sax.ContentHandler

Interface for classes that manage audience-based metadata controlled vocabulary UI displays and encoded ID translation to/from metadata field/value names/xpaths. Current implementations:

• MetadataVocabOPML
• MetadataVocabTermsGroups (Deprecated )

Author:

Ryan Deardorff

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.String err) Adds a feature to the Error attribute of the MetadataVocab object
void	addMessage(java.lang.String msg) Adds a feature to the Message attribute of the MetadataVocab object
void	doneLoading() Invoked when XML parsing completes
VocabNode	findVocabNode(java.lang.String system, java.lang.String fieldName, java.lang.String valueName) Deprecated. As of MetadataUI v1.0, replaced by getVocabNode()
java.util.ArrayList	getCacheValuesInOrder(java.lang.String system, java.lang.String group, java.util.Map cache) Given a cache (Map) of vocab values, this method returns a list of those values in the order that they are defined in their groups file.
java.lang.String	getCurrentVersion(java.lang.String metaFormat) Get the most recently loaded metadata format version number
java.util.ArrayList	getErrors() Get the list of any errors that have occured
java.lang.String	getFieldSystemId(java.lang.String field) Deprecated. As of MetadataUI v1.0, replaced by getTranslatedField()
boolean	getFieldValueIdPairExists(java.lang.String fieldId, java.lang.String valueId) Does a vocabulary definition exist for the given encoded field/value Ids?
java.lang.String	getFieldValueSystemId(java.lang.String field, java.lang.String value) Deprecated. As of MetadataUI v1.0, replaced by getTranslatedValue()
java.util.ArrayList	getMessages() Return stored messages
java.lang.String	getMetaFormatOfField(java.lang.String field) Gets the metadata format associated with the given field identifier (either encoded ID or PATH)
java.lang.String	getMetaNameOfId(java.lang.String system, java.lang.String fieldId, java.lang.String valueId) Deprecated. As of MetadataUI v1.0, replaced by getTranslatedValue()
java.lang.String	getOPML(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field) Gets the OPML for a given format/audience/language, using the current or most recently loaded version without the XML declaration tag
java.lang.String	getOPML(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field, boolean includeXmlDeclaration) Gets the OPML for a given format/audience/language, using the current or most recently loaded version
java.lang.String	getOPML(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field) Gets the OPML for a given format/version/audience/language without the XML declaration tag
java.lang.String	getOPML(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field, boolean includeXmlDeclaration) Gets the OPML for a given format/version/audience/language
java.lang.String	getResponseOPML(javax.servlet.jsp.PageContext context) Gets the re-ordered/grouped/labeled tree of metadata values from the cache created by setResponseGroup()
java.lang.String	getTopLevelAbbrevLabelOf(java.lang.String system, java.lang.String metadataField, java.lang.String systemFieldId, java.lang.String systemValueId) Gets the topLevelAbbrevLabelOf attribute of the MetadataVocab object
java.lang.String	getTranslatedField(java.lang.String metaFormat, java.lang.String field) Gets the translated FIELD NAME/ID of the given FIELD NAME/ID
java.lang.String	getTranslatedField(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String field) Gets the translated FIELD NAME/ID of the given FIELD NAME/ID
java.lang.String	getTranslatedFieldPath(java.lang.String metaFormat, java.lang.String field) Gets the translated FIELD XPATH of the given FIELD NAME/ID
java.lang.String	getTranslatedFieldPath(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String field) Gets the translated FIELD XPATH of the given FIELD NAME/ID
java.lang.String	getTranslatedValue(java.lang.String metaFormat, java.lang.String field, java.lang.String value) Gets the translated VALUE NAME/ID of the given FIELD+VALUE NAMEs/IDs
java.lang.String	getTranslatedValue(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String field, java.lang.String value) Gets the translated VALUE NAME/ID of the given FIELD+VALUE NAMEs/IDs
java.lang.String	getUiFieldLabel(java.lang.String audience, java.lang.String language, java.lang.String field, boolean abbrev) Gets the uiFieldLabel attribute of the MetadataVocab object
java.lang.String	getUiFieldLabel(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field, boolean abbrev) Gets the UI label associated with the given FIELD NAME/ID, using the current or most recently loaded metadata format version number
java.lang.String	getUiFieldLabel(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field) Gets the non-abbreviated UI label associated with the given FIELD NAME/ID
java.lang.String	getUiFieldLabel(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field, boolean abbrev) Gets the UI label associated with the given FIELD NAME/ID
java.lang.String	getUiLabelOf(java.lang.String system, java.lang.String metadataField, java.lang.String metadataValue) Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()
java.lang.String	getUiLabelOf(java.lang.String system, java.lang.String metadataField, java.lang.String metadataValue, boolean abbreviated) Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()
java.lang.String	getUiLabelOfFieldId(java.lang.String fieldId) Deprecated. As of MetadataUI v1.0, replaced by getUiFieldLabel()
java.lang.String	getUiLabelOfSystemIds(java.lang.String system, java.lang.String systemFieldId, java.lang.String systemValueId) Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()
java.lang.String	getUiLabelOfSystemIds(java.lang.String system, java.lang.String systemFieldId, java.lang.String systemValueId, boolean abbreviated) Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()
java.lang.String	getUiValueDisplay(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String value) Gets the "display" attribute value for the given field/value vocab using the CURRENT metadata framework version
java.lang.String	getUiValueDisplay(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String value) Gets the "display" attribute value for the given field/value vocab
java.lang.String	getUiValueLabel(java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String value, boolean abbrev) Gets the uiValueLabel attribute of the MetadataVocab object
java.lang.String	getUiValueLabel(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String value, boolean abbrev) Gets the UI label associated with the given FIELD+VALUE NAMES/IDS, using the current or most recently loaded metadata format version number
java.lang.String	getUiValueLabel(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String value) Gets the non-abbreviated UI label associated with the given FIELD+VALUE NAMES/IDS
java.lang.String	getUiValueLabel(java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String value, boolean abbrev) Gets the UI label associated with the given FIELD+VALUE NAMES/IDS
java.lang.String	getVocabCheckbox(java.lang.String groupTop, java.lang.String value, java.lang.String label, MetadataVocabInputState inputState) Returns a SINGLE HTML CHECKBOX input of the specified part of the vocabulary.
java.lang.String	getVocabCheckboxes(java.lang.String system, java.lang.String group, int size, java.lang.String tdWidth, boolean skipTopRow, MetadataVocabInputState inputState) Returns an HTML TABLE of CHECKBOX inputs of the specified part of the vocabulary.
java.util.ArrayList	getVocabFieldIds() Gets the vocabFieldIds attribute of the MetadataVocab object
java.lang.String	getVocabHiddenInputs(java.lang.String system, java.lang.String group, MetadataVocabInputState inputState) Generates HTML HIDDEN inputs of the specified part of the vocabulary.
VocabNode	getVocabNode(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String fieldName, java.lang.String valueName) Gets a VocabNode for the given field/value pair
java.util.ArrayList	getVocabNodes(java.lang.String system, java.lang.String group) Gets the vocabNodes attribute of the MetadataVocab object
java.util.ArrayList	getVocabNodes(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field) Gets the vocabNodes attribute of the MetadataVocab object
java.util.ArrayList	getVocabNodes(java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field, java.lang.String group) Gets the vocabNodes attribute of the MetadataVocab object
java.lang.String	getVocabSelectList(java.lang.String system, java.lang.String group, int size, MetadataVocabInputState inputState) Returns an HTML SELECT list of the specified part of the vocabulary.
java.util.Set	getVocabSystemInterfaces() Gets the set of interfaces defined in this instance of the vocabs
java.lang.String	getVocabTreeMenu(java.lang.String system, java.lang.String language, java.lang.String group, javax.servlet.jsp.PageContext page) Generates an absolutely-positioned JavaScript Tree Menu (collapsable flyout hierarchy) of the specified part of the vocabulary
void	reportError(java.lang.String err) Log an error
void	reportMessage(java.lang.String msg) Log a message
void	setResponseGroup(javax.servlet.jsp.PageContext context, java.lang.String metaFormat, java.lang.String audience, java.lang.String language, java.lang.String field) Initiate the re-ordering/grouping/labeling of a flat list of metadata values in a search response (Services or otherwise) by indicating an audience grouping (OPML tree) sans version
void	setResponseGroup(javax.servlet.jsp.PageContext context, java.lang.String metaFormat, java.lang.String metaVersion, java.lang.String audience, java.lang.String language, java.lang.String field) Initiate the re-ordering/grouping/labeling of a flat list of metadata values in a search response (Services or otherwise) by indicating an audience grouping (OPML tree)
void	setResponseList(java.util.ArrayList values, javax.servlet.jsp.PageContext context) Adds an ArrayList of metadata values to the re-ordering/grouping/labeling cache
void	setResponseList(java.lang.String[] values, javax.servlet.jsp.PageContext context) Adds an ArrayList of metadata values to the re-ordering/grouping/labeling cache
void	setResponseValue(java.lang.String value, javax.servlet.jsp.PageContext context) Adds a single metadata value to the re-ordering/grouping/labeling cache

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Method Detail

getErrors

java.util.ArrayList getErrors()

Get the list of any errors that have occured

Returns:

The errors value

addMessage

void addMessage(java.lang.String msg)

Adds a feature to the Message attribute of the MetadataVocab object

Parameters:

msg - The feature to be added to the Message attribute

addError

void addError(java.lang.String err)

Adds a feature to the Error attribute of the MetadataVocab object

Parameters:

err - The feature to be added to the Error attribute

setResponseGroup

void setResponseGroup(javax.servlet.jsp.PageContext context,
                      java.lang.String metaFormat,
                      java.lang.String metaVersion,
                      java.lang.String audience,
                      java.lang.String language,
                      java.lang.String field)

Initiate the re-ordering/grouping/labeling of a flat list of metadata values in a search response (Services or otherwise) by indicating an audience grouping (OPML tree)

Parameters:

context - JSP page context

metaVersion - metadata version (i.e. "0.6.50")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

See Also:

setResponseValue(String,PageContext), setResponseList(String[],PageContext), setResponseList(ArrayList,PageContext), getResponseOPML(PageContext)

setResponseGroup

void setResponseGroup(javax.servlet.jsp.PageContext context,
                      java.lang.String metaFormat,
                      java.lang.String audience,
                      java.lang.String language,
                      java.lang.String field)

Initiate the re-ordering/grouping/labeling of a flat list of metadata values in a search response (Services or otherwise) by indicating an audience grouping (OPML tree) sans version

Parameters:

context - JSP page context

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

See Also:

setResponseValue(String,PageContext), setResponseList(String[],PageContext), setResponseList(ArrayList,PageContext), getResponseOPML(PageContext)

setResponseValue

void setResponseValue(java.lang.String value,
                      javax.servlet.jsp.PageContext context)

Adds a single metadata value to the re-ordering/grouping/labeling cache

Parameters:

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

context - JSP page context

See Also:

setResponseGroup(PageContext,String,String,String,String,String), setResponseList(String[],PageContext), setResponseList(ArrayList,PageContext), getResponseOPML(PageContext)

setResponseList

void setResponseList(java.util.ArrayList values,
                     javax.servlet.jsp.PageContext context)

Adds an ArrayList of metadata values to the re-ordering/grouping/labeling cache

Parameters:

context - JSP page context

values - List of metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

See Also:

setResponseGroup(PageContext,String,String,String,String,String), setResponseValue(String,PageContext), setResponseList(String[],PageContext), getResponseOPML(PageContext)

setResponseList

void setResponseList(java.lang.String[] values,
                     javax.servlet.jsp.PageContext context)

Adds an ArrayList of metadata values to the re-ordering/grouping/labeling cache

Parameters:

context - JSP page context

values - List of metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

See Also:

setResponseGroup(PageContext,String,String,String,String,String), setResponseValue(String,PageContext), setResponseList(ArrayList,PageContext), getResponseOPML(PageContext)

getResponseOPML

java.lang.String getResponseOPML(javax.servlet.jsp.PageContext context)

Gets the re-ordered/grouped/labeled tree of metadata values from the cache created by setResponseGroup()

Parameters:

context - JSP page context

Returns:

OPML for the group specified with setResponseGroup() and trimmed to the subset indicated by values passed into setResponse()

See Also:

setResponseValue(String,PageContext), setResponseList(String[],PageContext), setResponseList(ArrayList,PageContext), setResponseGroup(PageContext,String,String,String,String,String)

getVocabSystemInterfaces

java.util.Set getVocabSystemInterfaces()

Gets the set of interfaces defined in this instance of the vocabs

Returns:

The vocabSystemInterfaces value

getFieldValueIdPairExists

boolean getFieldValueIdPairExists(java.lang.String fieldId,
                                  java.lang.String valueId)

Does a vocabulary definition exist for the given encoded field/value Ids?

Parameters:

fieldId - Encoded vocabulary field Id

valueId - Encoded vocabulary value Id

Returns:

The fieldValueIdPairExists value

getVocabNodes

java.util.ArrayList getVocabNodes(java.lang.String system,
                                  java.lang.String group)

Gets the vocabNodes attribute of the MetadataVocab object

Parameters:

system -

group -

Returns:

The vocabNodes value

getVocabSelectList

java.lang.String getVocabSelectList(java.lang.String system,
                                    java.lang.String group,
                                    int size,
                                    MetadataVocabInputState inputState)

Returns an HTML SELECT list of the specified part of the vocabulary.

Parameters:

group - colon-seperated specifier of the part of the vocab hierarchy which is to be displayed

size - size (height) of the SELECT list

system -

inputState -

Returns:

The vocabSelectList value

getVocabCheckboxes

java.lang.String getVocabCheckboxes(java.lang.String system,
                                    java.lang.String group,
                                    int size,
                                    java.lang.String tdWidth,
                                    boolean skipTopRow,
                                    MetadataVocabInputState inputState)

Returns an HTML TABLE of CHECKBOX inputs of the specified part of the vocabulary.

Parameters:

group - colon-seperated specifier of the part of the vocab hierarchy which is to be displayed

size - how many inputs to display before starting a new column in the table

tdWidth - value inserted into the width param of the TD tag

skipTopRow - Should the top row of checkboxes (next to All | Clear) be skipped?

system -

inputState -

Returns:

the HTML code

getVocabCheckbox

java.lang.String getVocabCheckbox(java.lang.String groupTop,
                                  java.lang.String value,
                                  java.lang.String label,
                                  MetadataVocabInputState inputState)

Returns a SINGLE HTML CHECKBOX input of the specified part of the vocabulary.

Parameters:

groupTop - Top-level vocab group

value - vocab value

label - UI label

inputState -

Returns:

the HTML code

getVocabTreeMenu

java.lang.String getVocabTreeMenu(java.lang.String system,
                                  java.lang.String language,
                                  java.lang.String group,
                                  javax.servlet.jsp.PageContext page)

Generates an absolutely-positioned JavaScript Tree Menu (collapsable flyout hierarchy) of the specified part of the vocabulary

Parameters:

group - colon-seperated specifier of the part of the vocab hierarchy which is to be displayed

system -

page -

language -

Returns:

the Javascript code defining the menu

getVocabHiddenInputs

java.lang.String getVocabHiddenInputs(java.lang.String system,
                                      java.lang.String group,
                                      MetadataVocabInputState inputState)

Generates HTML HIDDEN inputs of the specified part of the vocabulary.

Parameters:

group - colon-seperated specifier of the part of the vocab hierarchy which is to be displayed

system -

inputState -

Returns:

the HTML code

getCacheValuesInOrder

java.util.ArrayList getCacheValuesInOrder(java.lang.String system,
                                          java.lang.String group,
                                          java.util.Map cache)

Given a cache (Map) of vocab values, this method returns a list of those values in the order that they are defined in their groups file.

Parameters:

cache -

system -

group -

Returns:

The orderedCacheValues value

getVocabFieldIds

java.util.ArrayList getVocabFieldIds()

Gets the vocabFieldIds attribute of the MetadataVocab object

Returns:

The vocabFieldIds value

doneLoading

void doneLoading()

Invoked when XML parsing completes

findVocabNode

VocabNode findVocabNode(java.lang.String system,
                        java.lang.String fieldName,
                        java.lang.String valueName)

Deprecated. As of MetadataUI v1.0, replaced by getVocabNode()

Description of the Method

Parameters:

system -

fieldName -

valueName -

Returns:

getVocabNode

VocabNode getVocabNode(java.lang.String metaFormat,
                       java.lang.String audience,
                       java.lang.String language,
                       java.lang.String fieldName,
                       java.lang.String valueName)

Gets a VocabNode for the given field/value pair

Parameters:

metaFormat - metadata format (i.e. "adn")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

fieldName - vocab field

valueName - vocab value

Returns:

VocabNode for the vocab

getVocabNodes

java.util.ArrayList getVocabNodes(java.lang.String metaFormat,
                                  java.lang.String audience,
                                  java.lang.String language,
                                  java.lang.String field)

Gets the vocabNodes attribute of the MetadataVocab object

Parameters:

metaFormat -

audience -

language -

field -

Returns:

The vocabNodes value

getVocabNodes

java.util.ArrayList getVocabNodes(java.lang.String metaFormat,
                                  java.lang.String audience,
                                  java.lang.String language,
                                  java.lang.String field,
                                  java.lang.String group)

Gets the vocabNodes attribute of the MetadataVocab object

Parameters:

metaFormat -

audience -

language -

field -

group -

Returns:

The vocabNodes value

getCurrentVersion

java.lang.String getCurrentVersion(java.lang.String metaFormat)

Get the most recently loaded metadata format version number

Parameters:

metaFormat - metadata format (i.e. "adn")

Returns:

The current (most recently loaded) version for the given format

getTranslatedField

java.lang.String getTranslatedField(java.lang.String metaFormat,
                                    java.lang.String metaVersion,
                                    java.lang.String field)
                             throws java.lang.Exception

Gets the translated FIELD NAME/ID of the given FIELD NAME/ID

Parameters:

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

Returns:

The FIELD NAME/ID as translated from input FIELD NAME/ID, i.e. "gradeRange"

Throws:

java.lang.Exception

getTranslatedField

java.lang.String getTranslatedField(java.lang.String metaFormat,
                                    java.lang.String field)
                             throws java.lang.Exception

Gets the translated FIELD NAME/ID of the given FIELD NAME/ID

Parameters:

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

Returns:

The FIELD NAME/ID as translated from input FIELD NAME/ID, i.e. "gradeRange"

Throws:

java.lang.Exception

getTranslatedFieldPath

java.lang.String getTranslatedFieldPath(java.lang.String metaFormat,
                                        java.lang.String metaVersion,
                                        java.lang.String field)
                                 throws java.lang.Exception

Gets the translated FIELD XPATH of the given FIELD NAME/ID

Parameters:

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

Returns:

The FIELD XPATH as translated from input FIELD NAME/ID

Throws:

java.lang.Exception

getTranslatedFieldPath

java.lang.String getTranslatedFieldPath(java.lang.String metaFormat,
                                        java.lang.String field)
                                 throws java.lang.Exception

Gets the translated FIELD XPATH of the given FIELD NAME/ID

Parameters:

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

Returns:

The FIELD XPATH as translated from input FIELD NAME/ID

Throws:

java.lang.Exception

getTranslatedValue

java.lang.String getTranslatedValue(java.lang.String metaFormat,
                                    java.lang.String metaVersion,
                                    java.lang.String field,
                                    java.lang.String value)
                             throws java.lang.Exception

Gets the translated VALUE NAME/ID of the given FIELD+VALUE NAMEs/IDs

Parameters:

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

Returns:

The VALUE NAME/ID as translated from input FIELD+VALUE NAMEs/IDs

Throws:

java.lang.Exception

getTranslatedValue

java.lang.String getTranslatedValue(java.lang.String metaFormat,
                                    java.lang.String field,
                                    java.lang.String value)
                             throws java.lang.Exception

Gets the translated VALUE NAME/ID of the given FIELD+VALUE NAMEs/IDs

Parameters:

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

metaFormat - metadata format (i.e. "adn")

Returns:

The VALUE NAME/ID as translated from input FIELD+VALUE NAMEs/IDs

Throws:

java.lang.Exception

getUiValueLabel

java.lang.String getUiValueLabel(java.lang.String metaFormat,
                                 java.lang.String metaVersion,
                                 java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 java.lang.String value,
                                 boolean abbrev)

Gets the UI label associated with the given FIELD+VALUE NAMES/IDS

Parameters:

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

abbrev - get the abbreviated version of the label?

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

Returns:

The user interface label associated with the given format/version/audience/language value

getUiValueLabel

java.lang.String getUiValueLabel(java.lang.String metaFormat,
                                 java.lang.String metaVersion,
                                 java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 java.lang.String value)

Gets the non-abbreviated UI label associated with the given FIELD+VALUE NAMES/IDS

Parameters:

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

Returns:

The user interface label associated with the given format/version/audience/language value

getUiValueLabel

java.lang.String getUiValueLabel(java.lang.String metaFormat,
                                 java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 java.lang.String value,
                                 boolean abbrev)

Gets the UI label associated with the given FIELD+VALUE NAMES/IDS, using the current or most recently loaded metadata format version number

Parameters:

metaFormat - metadata format (i.e. "adn")

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

abbrev - get the abbreviated version of the label?

Returns:

The user interface label associated with the given format/version/audience/language value

getUiValueLabel

java.lang.String getUiValueLabel(java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 java.lang.String value,
                                 boolean abbrev)

Gets the uiValueLabel attribute of the MetadataVocab object

Parameters:

audience -

language -

field -

value -

abbrev -

Returns:

The uiValueLabel value

getUiFieldLabel

java.lang.String getUiFieldLabel(java.lang.String metaFormat,
                                 java.lang.String metaVersion,
                                 java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 boolean abbrev)

Gets the UI label associated with the given FIELD NAME/ID

Parameters:

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

abbrev - get the abbreviated version of the label?

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

Returns:

The user interface label associated with the given format/version/audience/language value

getUiFieldLabel

java.lang.String getUiFieldLabel(java.lang.String metaFormat,
                                 java.lang.String metaVersion,
                                 java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field)

Gets the non-abbreviated UI label associated with the given FIELD NAME/ID

Parameters:

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

Returns:

The user interface label associated with the given format/version/audience/language value

getUiFieldLabel

java.lang.String getUiFieldLabel(java.lang.String metaFormat,
                                 java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 boolean abbrev)

Gets the UI label associated with the given FIELD NAME/ID, using the current or most recently loaded metadata format version number

Parameters:

metaFormat - metadata format (i.e. "adn")

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

abbrev - get the abbreviated version of the label?

Returns:

The user interface label associated with the given format/version/audience/language value

getUiFieldLabel

java.lang.String getUiFieldLabel(java.lang.String audience,
                                 java.lang.String language,
                                 java.lang.String field,
                                 boolean abbrev)

Gets the uiFieldLabel attribute of the MetadataVocab object

Parameters:

audience -

language -

field -

abbrev -

Returns:

The uiFieldLabel value

getUiValueDisplay

java.lang.String getUiValueDisplay(java.lang.String metaFormat,
                                   java.lang.String metaVersion,
                                   java.lang.String audience,
                                   java.lang.String language,
                                   java.lang.String field,
                                   java.lang.String value)

Gets the "display" attribute value for the given field/value vocab

Parameters:

metaFormat - metadata format (i.e. "adn")

metaVersion - metadata version (i.e. "0.6.50")

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

Returns:

The uiValueDisplay value

getUiValueDisplay

java.lang.String getUiValueDisplay(java.lang.String metaFormat,
                                   java.lang.String audience,
                                   java.lang.String language,
                                   java.lang.String field,
                                   java.lang.String value)

Gets the "display" attribute value for the given field/value vocab using the CURRENT metadata framework version

Parameters:

metaFormat - metadata format (i.e. "adn")

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

value - metadata VALUE encoded ID (i.e. "04") or metadata NAME (i.e. "DLESE:Intermediate elementary")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

Returns:

The uiValueDisplay value

getOPML

java.lang.String getOPML(java.lang.String metaFormat,
                         java.lang.String metaVersion,
                         java.lang.String audience,
                         java.lang.String language,
                         java.lang.String field,
                         boolean includeXmlDeclaration)

Gets the OPML for a given format/version/audience/language

Parameters:

metaVersion - metadata version (i.e. "0.6.50")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

includeXmlDeclaration - should the <?xml...?> declaration tag be included with the output?

Returns:

OPML for the given format/audience

getOPML

java.lang.String getOPML(java.lang.String metaFormat,
                         java.lang.String audience,
                         java.lang.String language,
                         java.lang.String field,
                         boolean includeXmlDeclaration)

Gets the OPML for a given format/audience/language, using the current or most recently loaded version

Parameters:

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

includeXmlDeclaration - should the <?xml...?> declaration tag be included with the output?

Returns:

OPML for the given format/audience

getOPML

java.lang.String getOPML(java.lang.String metaFormat,
                         java.lang.String metaVersion,
                         java.lang.String audience,
                         java.lang.String language,
                         java.lang.String field)

Gets the OPML for a given format/version/audience/language without the XML declaration tag

Parameters:

metaVersion - metadata version (i.e. "0.6.50")

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

Returns:

OPML for the given format/audience

getOPML

java.lang.String getOPML(java.lang.String metaFormat,
                         java.lang.String audience,
                         java.lang.String language,
                         java.lang.String field)

Gets the OPML for a given format/audience/language, using the current or most recently loaded version without the XML declaration tag

Parameters:

audience - UI audience, i.e. "community" or "cataloger"

language - UI language, i.e. "en-us"

field - metadata FIELD encoded ID (i.e. "gr") or metadata NAME (i.e. "gradeRange")

metaFormat - metadata format (i.e. "adn")

Returns:

OPML for the given format/audience

getMetaNameOfId

java.lang.String getMetaNameOfId(java.lang.String system,
                                 java.lang.String fieldId,
                                 java.lang.String valueId)

Deprecated. As of MetadataUI v1.0, replaced by getTranslatedValue()

Gets the metadata value or field name of the given encoded field and value Ids. Pass "" (empty string) for valueId to have it return the metadata field name (instead of value).

Parameters:

system - Vocabulary framework/version/audience/language, i.e. "adn/0.6.50/community/en-us" in v2.x (or "dds.descr.en-us" in v1.x)

fieldId - Encoded vocabulary field Id

valueId - Encoded vocabulary value Id

Returns:

The metaNameOfId value

See Also:

MetadataVocab#getTranslatedField(String,String,String,String,String), MetadataVocab#getTranslatedValue(String,String,String,String,String,String)

getFieldValueSystemId

java.lang.String getFieldValueSystemId(java.lang.String field,
                                       java.lang.String value)
                                throws java.lang.Exception

Deprecated. As of MetadataUI v1.0, replaced by getTranslatedValue()

Gets the encoded value Id of the given metadata field/value pair

Parameters:

field - Metadata field name

value - Metadata value name

Returns:

The encoded value Id

Throws:

java.lang.Exception

getFieldSystemId

java.lang.String getFieldSystemId(java.lang.String field)
                           throws java.lang.Exception

Deprecated. As of MetadataUI v1.0, replaced by getTranslatedField()

Gets the encoded field Id of the given metadata field

Parameters:

field - Metadata field name

Returns:

The encoded field Id

Throws:

java.lang.Exception

getUiLabelOf

java.lang.String getUiLabelOf(java.lang.String system,
                              java.lang.String metadataField,
                              java.lang.String metadataValue,
                              boolean abbreviated)

Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()

Gets the UI label of the given metadata field/value pair

Parameters:

system - Vocabulary system/interface/language trio, i.e. "adn/0.6.50/community/en-us"

metadataField - Metadata field name

metadataValue - Metadata value name

abbreviated - Return the abbreviated form of the UI label?

Returns:

The user interface label associated with the given vocabulary value

getUiLabelOf

java.lang.String getUiLabelOf(java.lang.String system,
                              java.lang.String metadataField,
                              java.lang.String metadataValue)

Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()

Gets the full (non-abbreviated) UI label of the given metadata field/value pair

Parameters:

system - Vocabulary system/interface/language trio, i.e. "adn/0.6.50/community/en-us"

metadataField - Metadata field name

metadataValue - Metadata value name

Returns:

The user interface label associated with the given vocabulary value

getUiLabelOfFieldId

java.lang.String getUiLabelOfFieldId(java.lang.String fieldId)

Deprecated. As of MetadataUI v1.0, replaced by getUiFieldLabel()

Gets the uiLabelOfFieldId attribute of the MetadataVocab object

Parameters:

fieldId - Description of the Parameter

Returns:

The uiLabelOfFieldId value

getUiLabelOfSystemIds

java.lang.String getUiLabelOfSystemIds(java.lang.String system,
                                       java.lang.String systemFieldId,
                                       java.lang.String systemValueId,
                                       boolean abbreviated)

Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()

Gets the UI label of the given encoded field/value Id pair

Parameters:

system - Vocabulary system/interface/language trio, i.e. "dds.default.en-us"

systemFieldId - Encoded field Id

systemValueId - Encoded value Id

abbreviated - Return the abbreviated form of the UI label?

Returns:

The user interface label associated with the given vocabulary value

getUiLabelOfSystemIds

java.lang.String getUiLabelOfSystemIds(java.lang.String system,
                                       java.lang.String systemFieldId,
                                       java.lang.String systemValueId)

Deprecated. As of MetadataUI v1.0, replaced by getUiValueLabel()

Gets the full (non-abbreviated) UI label of the given encoded field/value Id pair

Parameters:

system - Vocabulary system/interface/language trio, i.e. "dds.default.en-us"

systemFieldId - Encoded field Id

systemValueId - Encoded value Id

Returns:

The user interface label associated with the given vocabulary value

getMetaFormatOfField

java.lang.String getMetaFormatOfField(java.lang.String field)

Gets the metadata format associated with the given field identifier (either encoded ID or PATH)

Parameters:

field -

Returns:

The metaFormatOfField value

getTopLevelAbbrevLabelOf

java.lang.String getTopLevelAbbrevLabelOf(java.lang.String system,
                                          java.lang.String metadataField,
                                          java.lang.String systemFieldId,
                                          java.lang.String systemValueId)

Gets the topLevelAbbrevLabelOf attribute of the MetadataVocab object

Parameters:

system -

metadataField -

systemFieldId -

systemValueId -

Returns:

The topLevelAbbrevLabelOf value

getMessages

java.util.ArrayList getMessages()

Return stored messages

Returns:

The messages value

reportMessage

void reportMessage(java.lang.String msg)

Log a message

Parameters:

msg -

reportError

void reportError(java.lang.String err)

Log an error

Parameters:

err -