com.raritantechnologies.searchApp
Class AbstractSearchField

java.lang.Object
  com.raritantechnologies.searchApp.AbstractSearchField

public class AbstractSearchField

extends java.lang.Object

Used to hold abstract field data in Raritan QuickStart and Federated Search Applications.

Contains global, high-level description of a field used in a search application. The abstract field descriptions are extended by the User Interface elements (SearchForm and DisplayForm) and by the search elements (SearchSources). The mapping from AbstractSearchField to an individual SearchField element of a SearchSource is controlled by the applications SearchFieldMap.

In XML configured applications, the XMLSearchFieldMapFactory instantiates AbstractSearchField instances using this XML Configuration Schema:

  <FieldSpecs>

   <Field>
     <ID>AU</ID>
     <Name>Author</Name>
     <Type>AlphaNumeric</Type>
   </Field>

   <Field>
      <ID>TI</ID>
      <Name>Article Title</Name>
      <Type>AlphaNumeric</Type>
   </Field>

   <Field>
      <ID>PD</ID>
      <Name>Publication Date</Name>
      <Type>Date</Type>
   </Field>

   <Field>
     <ID>CT</ID>
     <Name>Category</Name>
     <Type>AlphaNumeric</Type>
     <Data>
        <Choice value="BUS" name="Business" />
        <Choice value="MAR" name="Marketing" />
        <Choice value="REF" name="Reference" />
     </Data>
   </Field>

  <Field>
    <ID>FL</ID>
    <Name>Field List</Name>
    <Type>FieldList</Type>
    <Attribute name="ValueField" value="[a Field Name]" />
    <Attribute name="Operator" value="or" />
  </Field>
 </FieldSpecs>

 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

AbstractSearchField(org.w3c.dom.Element searchFileEl)

AbstractSearchField(java.lang.String ID, java.lang.String name, java.lang.String type)

Method Summary

java.lang.String	getAssociatedField()
java.lang.String	getAttribute(java.lang.String name)
OrderedMap	getData() returns the Choice data map for this Abstract Search Field: map of abstractVal to Name.
java.lang.String	getDataName(java.lang.String dataID)
java.lang.String	getFormat()
java.lang.String	getID()
java.lang.String	getName()
java.lang.String	getType()
boolean	hasAssociatedField(java.util.Map inputParameters)
boolean	hasSurroundingFields(java.util.Map inputParameters)
void	setFormat(java.lang.String format)
void	setID(java.lang.String ID)
void	setName(java.lang.String name)
void	setType(java.lang.String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSearchField

public AbstractSearchField(java.lang.String ID,
                           java.lang.String name,
                           java.lang.String type)

AbstractSearchField

public AbstractSearchField(org.w3c.dom.Element searchFileEl)

Method Detail

setID

public void setID(java.lang.String ID)

getID

public java.lang.String getID()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setType

public void setType(java.lang.String type)

getType

public java.lang.String getType()

setFormat

public void setFormat(java.lang.String format)

getFormat

public java.lang.String getFormat()

getData

public OrderedMap getData()

returns the Choice data map for this Abstract Search Field: map of abstractVal to Name. (if any)

getDataName

public java.lang.String getDataName(java.lang.String dataID)

hasAssociatedField

public boolean hasAssociatedField(java.util.Map inputParameters)

hasSurroundingFields

public boolean hasSurroundingFields(java.util.Map inputParameters)

getAssociatedField

public java.lang.String getAssociatedField()

getAttribute

public java.lang.String getAttribute(java.lang.String name)