org.dlese.dpc.dds.action.form

Class VocabForm

java.lang.Object

org.apache.struts.action.ActionForm

org.dlese.dpc.dds.action.form.VocabForm

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DCSServicesForm, DDSAdminQueryForm, DDSManageCollectionsForm, DDSServicesForm, RepositoryForm

public class VocabForm
extends org.apache.struts.action.ActionForm
implements java.io.Serializable

A Struts Form bean for handling controlled vocabulary displays.

Author:

Ryan Deardorff

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	audience NOT YET DOCUMENTED
protected java.lang.String	field NOT YET DOCUMENTED
protected java.lang.String	language NOT YET DOCUMENTED
protected java.lang.String	metaFormat NOT YET DOCUMENTED
protected java.lang.String	value NOT YET DOCUMENTED
protected MetadataVocab	vocab NOT YET DOCUMENTED

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
VocabForm()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAudience() Gets the UI audience attribute of the VocabForm object
java.lang.String	getField() gets the vocabulary field attribute of the VocabActionForm object
java.lang.String	getFieldId() Gets the field encoded ID of the current vocabulary
java.lang.String	getFieldLabel() Gets the UI label of the current vocabulary
boolean	getIsVocabTermAvailable() True if there is a vocab entry for this field/value, false if not.
java.lang.String	getLanguage() Gets the UI language attribute of the VocabForm object
MetadataVocab	getVocab() Gets the vocab attribute of the VocabActionForm object
java.util.ArrayList	getVocabList() Gets the vocabList attribute of the VocabActionForm object
java.util.ArrayList	getVocabList(java.lang.String field) Gets the vocabList attribute of the VocabActionForm object
VocabNode	getVocabTerm() Gets the current vocabulary term as a VocabNode, or if unavailable, an untranslated vocabulary term as a VocabNode, which simply echos the vocab ID in the id, name, label and labelabbrev fields.
void	setField(java.lang.String field) Sets the field attribute of the VocabForm object
void	setField(java.lang.String metaFormat, java.lang.String field) Sets the vocabulary field attribute of the VocabActionForm object
void	setMetaFormat(java.lang.String metaFormat) Sets the metaFormat attribute of the VocabForm object
void	setValue(java.lang.String value) Sets the vocabulary value (last half of field/value pair)
void	setVocab(MetadataVocab vocab) Constructor for the VocabForm object
void	setVocabInterface(java.lang.String system) Deprecated. As of MetadataUI v1.0, replaced by new constructor

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

vocab

protected MetadataVocab vocab

NOT YET DOCUMENTED

field

protected java.lang.String field

NOT YET DOCUMENTED

value

protected java.lang.String value

NOT YET DOCUMENTED

metaFormat

protected java.lang.String metaFormat

NOT YET DOCUMENTED

audience

protected java.lang.String audience

NOT YET DOCUMENTED

language

protected java.lang.String language

NOT YET DOCUMENTED

Constructor Detail

VocabForm

public VocabForm()

Method Detail

setVocab

public void setVocab(MetadataVocab vocab)

Constructor for the VocabForm object

Parameters:

vocab - The new vocab value

setVocabInterface

public void setVocabInterface(java.lang.String system)

Deprecated. As of MetadataUI v1.0, replaced by new constructor

Sets the vocabInterface attribute of the VocabForm object

Parameters:

system - The new vocabInterface value

getAudience

public java.lang.String getAudience()

Gets the UI audience attribute of the VocabForm object

Returns:

The audience value

getLanguage

public java.lang.String getLanguage()

Gets the UI language attribute of the VocabForm object

Returns:

The language value

setField

public void setField(java.lang.String metaFormat,
                     java.lang.String field)

Sets the vocabulary field attribute of the VocabActionForm object

Parameters:

field - The new field value

metaFormat - The new field value

setField

public void setField(java.lang.String field)

Sets the field attribute of the VocabForm object

Parameters:

field - The new field value

setMetaFormat

public void setMetaFormat(java.lang.String metaFormat)

Sets the metaFormat attribute of the VocabForm object

Parameters:

metaFormat - The new metaFormat value

getField

public java.lang.String getField()

gets the vocabulary field attribute of the VocabActionForm object

Returns:

field The new field value

getFieldLabel

public java.lang.String getFieldLabel()

Gets the UI label of the current vocabulary

Returns:

The fieldLabel value

getFieldId

public java.lang.String getFieldId()

Gets the field encoded ID of the current vocabulary

Returns:

The fieldId value

setValue

public void setValue(java.lang.String value)

Sets the vocabulary value (last half of field/value pair)

Parameters:

value - The new value value

getVocabTerm

public VocabNode getVocabTerm()

Gets the current vocabulary term as a VocabNode, or if unavailable, an untranslated vocabulary term as a VocabNode, which simply echos the vocab ID in the id, name, label and labelabbrev fields.

Returns:

The vocabTerm value

See Also:

getIsVocabTermAvailable()

getIsVocabTermAvailable

public boolean getIsVocabTermAvailable()

True if there is a vocab entry for this field/value, false if not. If true, getVocabTerm() will return the translated vocabs, if false it will return the untranslated values.

Returns:

The isVocabTermAvailable value

See Also:

getVocabTerm()

getVocab

public final MetadataVocab getVocab()

Gets the vocab attribute of the VocabActionForm object

Returns:

The vocab value

getVocabList

public java.util.ArrayList getVocabList(java.lang.String field)

Gets the vocabList attribute of the VocabActionForm object

Parameters:

field -

Returns:

The vocabList value

getVocabList

public java.util.ArrayList getVocabList()

Gets the vocabList attribute of the VocabActionForm object

Returns:

The vocabList value