Package 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:
Serializable
Direct Known Subclasses:
DCSServicesForm, DDSAdminQueryForm, DDSManageCollectionsForm, DDSServicesForm, RepositoryForm
public class VocabForm extends org.apache.struts.action.ActionForm implements Serializable
A Struts Form bean for handling controlled vocabulary displays.
Author:
Ryan Deardorff
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    audience
    NOT YET DOCUMENTED
    protected String
    field
    NOT YET DOCUMENTED
    protected String
    language
    NOT YET DOCUMENTED
    protected String
    metaFormat
    NOT YET DOCUMENTED
    protected 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
    Description
    VocabForm()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAudience()
    Gets the UI audience attribute of the VocabForm object
    String
    getField()
    gets the vocabulary field attribute of the VocabActionForm object
    String
    getFieldId()
    Gets the field encoded ID of the current vocabulary
    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.
    String
    getLanguage()
    Gets the UI language attribute of the VocabForm object
    final MetadataVocab
    getVocab()
    Gets the vocab attribute of the VocabActionForm object
    ArrayList
    getVocabList()
    Gets the vocabList attribute of the VocabActionForm object
    ArrayList
    getVocabList(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(String field)
    Sets the field attribute of the VocabForm object
    void
    setField(String metaFormat, String field)
    Sets the vocabulary field attribute of the VocabActionForm object
    void
    setMetaFormat(String metaFormat)
    Sets the metaFormat attribute of the VocabForm object
    void
    setValue(String value)
    Sets the vocabulary value (last half of field/value pair)
    void
    setVocab(MetadataVocab vocab)
    Constructor for the VocabForm object
    void
    setVocabInterface(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 Details

    • vocab

      protected MetadataVocab vocab
      NOT YET DOCUMENTED

    • field

      protected String field
      NOT YET DOCUMENTED

    • value

      protected String value
      NOT YET DOCUMENTED

    • metaFormat

      protected String metaFormat
      NOT YET DOCUMENTED

    • audience

      protected String audience
      NOT YET DOCUMENTED

    • language

      protected String language
      NOT YET DOCUMENTED

  • Constructor Details

    • VocabForm

      public VocabForm()

  • Method Details

    • setVocab

      public void setVocab(MetadataVocab vocab)
      Constructor for the VocabForm object
      Parameters:
      vocab - The new vocab value

    • setVocabInterface

      public void setVocabInterface(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 String getAudience()
      Gets the UI audience attribute of the VocabForm object
      Returns:
      The audience value

    • getLanguage

      public String getLanguage()
      Gets the UI language attribute of the VocabForm object
      Returns:
      The language value

    • setField

      public void setField(String metaFormat, String field)
      Sets the vocabulary field attribute of the VocabActionForm object
      Parameters:
      metaFormat - The new field value
      field - The new field value

    • setField

      public void setField(String field)
      Sets the field attribute of the VocabForm object
      Parameters:
      field - The new field value

    • setMetaFormat

      public void setMetaFormat(String metaFormat)
      Sets the metaFormat attribute of the VocabForm object
      Parameters:
      metaFormat - The new metaFormat value

    • getField

      public String getField()
      gets the vocabulary field attribute of the VocabActionForm object
      Returns:
      field The new field value

    • getFieldLabel

      public String getFieldLabel()
      Gets the UI label of the current vocabulary
      Returns:
      The fieldLabel value

    • getFieldId

      public String getFieldId()
      Gets the field encoded ID of the current vocabulary
      Returns:
      The fieldId value

    • setValue

      public void setValue(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

      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:

    • getVocab

      public final MetadataVocab getVocab()
      Gets the vocab attribute of the VocabActionForm object
      Returns:
      The vocab value

    • getVocabList

      public ArrayList getVocabList(String field)
      Gets the vocabList attribute of the VocabActionForm object
      Parameters:
      field -
      Returns:
      The vocabList value

    • getVocabList

      public ArrayList getVocabList()
      Gets the vocabList attribute of the VocabActionForm object
      Returns:
      The vocabList value