com.raritantechnologies.searchApp
Class SearchFormField

java.lang.Object
  com.raritantechnologies.searchApp.SearchFormField

public class SearchFormField

extends java.lang.Object

Defines a field within an HTML search form.

XML Configuration Template:

  <SearchForms>
   <SearchForm name="Advanced" category="healthCare" >

    <Field ID="AU" type="text" width="50" name="Author" />
    <Field ID="TI" type="text" width="50" name="Title" />
    <!-- requestParam maps request data to the field -->
    <Field ID="AB" type="text" width="50" name="Abstract" requestParam="AB" />

    <Field ID="PageSize" type="radio" name="Page Size" >
      <Choice value="10" name="10" default="on" />
      <Choice value="20" name="20" />
      <Choice value="50" name="50" />
    </Field>

    <Field ID="[ the field ID ]" type="custom" name="[ the field name ]" >
      &SearchElementRenderer class="[ class of com.raritantechnologies.taglibrary.ISearchElementRenderer ]" >

      </SearchElementRenderer>
    </Field>
   </SearchForm>
  </SearchForms>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan, Glenn Robitaille

Constructor Summary

SearchFormField(org.w3c.dom.Element searchFormEl)

SearchFormField(java.lang.String fieldID, java.lang.String fieldName, java.lang.String fieldType)

SearchFormField(java.lang.String fieldID, java.lang.String fieldName, java.lang.String fieldType, OrderedMap fieldData)

Method Summary

void	addDataValue(java.lang.String dataFieldValue, java.lang.String dataFieldDisplay) SearchFormField maps the dataFieldValue to the display Name see SearchField which is used for search, it maps the displayFieldName to the SearchSource value.
void	addFieldOperator(java.lang.String fieldOpID, java.lang.String type)
java.lang.String	getDataSelected()
java.lang.String	getDisplayName(java.lang.String dataFieldName)
java.lang.String	getExtraAttributes()
java.lang.String	getFieldClass()
OrderedMap	getFieldData()
java.lang.String	getFieldHeight()
java.lang.String	getFieldID()
java.lang.String	getFieldLevel()
java.lang.String	getFieldName()
OrderedMap	getFieldOperators()
java.lang.String	getFieldText()
java.lang.String	getFieldType()
java.lang.String	getFieldValue()
java.lang.String	getFieldWidth()
java.lang.String	getInitFrom()
java.lang.String	getMaxCols()
java.lang.String	getRequestParam()
java.lang.String	getRequired()
ISearchElementRenderer	getSearchElementRenderer()
java.lang.String	getTdClass()
java.lang.String	getThClass()
void	setDataSelected(java.lang.String selectedValue)
void	setExtraAttributes(java.lang.String extraAttribs)
void	setFieldClass(java.lang.String fieldClass)
void	setFieldData(OrderedMap fieldData)
void	setFieldHeight(java.lang.String fieldHeight)
void	setFieldID(java.lang.String fieldID)
void	setFieldLevel(java.lang.String fieldLevel)
void	setFieldName(java.lang.String fieldName)
void	setFieldText(java.lang.String text)
void	setFieldType(java.lang.String fieldType)
void	setFieldValue(java.lang.String fieldValue)
void	setFieldWidth(java.lang.String fieldWidth)
void	setInitFrom(java.lang.String initFrom)
void	setMaxCols(java.lang.String maxCols)
void	setRequestParam(java.lang.String requestParam)
void	setRequired(java.lang.String required)
void	setSearchElementRenderer(ISearchElementRenderer sElementRenderer)
void	setTdClass(java.lang.String tdClass)
void	setThClass(java.lang.String thClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFormField

public SearchFormField(java.lang.String fieldID,
                       java.lang.String fieldName,
                       java.lang.String fieldType)

SearchFormField

public SearchFormField(java.lang.String fieldID,
                       java.lang.String fieldName,
                       java.lang.String fieldType,
                       OrderedMap fieldData)

SearchFormField

public SearchFormField(org.w3c.dom.Element searchFormEl)

Method Detail

setFieldID

public void setFieldID(java.lang.String fieldID)

getFieldID

public java.lang.String getFieldID()

setFieldName

public void setFieldName(java.lang.String fieldName)

getFieldName

public java.lang.String getFieldName()

setFieldType

public void setFieldType(java.lang.String fieldType)

getFieldType

public java.lang.String getFieldType()

setFieldValue

public void setFieldValue(java.lang.String fieldValue)

getFieldValue

public java.lang.String getFieldValue()

setFieldWidth

public void setFieldWidth(java.lang.String fieldWidth)

getFieldWidth

public java.lang.String getFieldWidth()

setFieldHeight

public void setFieldHeight(java.lang.String fieldHeight)

getFieldHeight

public java.lang.String getFieldHeight()

setExtraAttributes

public void setExtraAttributes(java.lang.String extraAttribs)

getExtraAttributes

public java.lang.String getExtraAttributes()

setRequired

public void setRequired(java.lang.String required)

getRequired

public java.lang.String getRequired()

setFieldData

public void setFieldData(OrderedMap fieldData)

getFieldData

public OrderedMap getFieldData()

setFieldClass

public void setFieldClass(java.lang.String fieldClass)

getFieldClass

public java.lang.String getFieldClass()

setThClass

public void setThClass(java.lang.String thClass)

getThClass

public java.lang.String getThClass()

setTdClass

public void setTdClass(java.lang.String tdClass)

getTdClass

public java.lang.String getTdClass()

setMaxCols

public void setMaxCols(java.lang.String maxCols)

getMaxCols

public java.lang.String getMaxCols()

setFieldText

public void setFieldText(java.lang.String text)

getFieldText

public java.lang.String getFieldText()

setFieldLevel

public void setFieldLevel(java.lang.String fieldLevel)

getFieldLevel

public java.lang.String getFieldLevel()

setInitFrom

public void setInitFrom(java.lang.String initFrom)

getInitFrom

public java.lang.String getInitFrom()

setRequestParam

public void setRequestParam(java.lang.String requestParam)

getRequestParam

public java.lang.String getRequestParam()

setSearchElementRenderer

public void setSearchElementRenderer(ISearchElementRenderer sElementRenderer)

getSearchElementRenderer

public ISearchElementRenderer getSearchElementRenderer()

addDataValue

public void addDataValue(java.lang.String dataFieldValue,
                         java.lang.String dataFieldDisplay)

SearchFormField maps the dataFieldValue to the display Name see SearchField which is used for search, it maps the displayFieldName to the SearchSource value.

getDisplayName

public java.lang.String getDisplayName(java.lang.String dataFieldName)

setDataSelected

public void setDataSelected(java.lang.String selectedValue)

getDataSelected

public java.lang.String getDataSelected()

addFieldOperator

public void addFieldOperator(java.lang.String fieldOpID,
                             java.lang.String type)

getFieldOperators

public OrderedMap getFieldOperators()