com.raritantechnologies.searchApp
Class XMLSearchFieldMapFactory

java.lang.Object
  com.raritantechnologies.searchApp.XMLSearchFieldMapFactory

All Implemented Interfaces:

ISearchFieldMapFactory

public class XMLSearchFieldMapFactory

extends java.lang.Object

implements ISearchFieldMapFactory

Constructs a SearchFieldMap from an XML source.

The configuration XML consists of several main sections:

• FieldSpecs - consists of a set of <Field> tags that describe a single search or result display meta field. The fields are described in a global or abstract sense in that all objects in the framework application can use these fieldIDs to refer to the same metadata field independent of any local naming conventions.
• SearchType - describe the "Search Sources" used in a framework application. Each source (e.g. a database, web site, Verity collection or parametric index) is represented by an object of type "SearchSource" that is instantiated with the information contained in a <SearchType> tag.
• SearchForms - descibes one or more Search Forms that can be rendered into an appropriate HTML form by "ISearchFormRenderer" implementation classes.
• DisplayForms - describes one or more result Display forms or pages that can be rendered into HTML display pages by IDisplayFormRenderer" implementation classes.
• SystemObjects - used to describe any configurable object does not fall into one of the classifications above. Examples include Page Link Renderers, QueryResultBean factory objects (used to format objects used to save and analyze query and result patterns).

General XML Schema for a Raritan Technologies Framework Application:

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

XMLSearchFieldMapFactory(org.w3c.dom.Document configDoc)

XMLSearchFieldMapFactory(java.lang.String searchAppConfig)

Method Summary

void	addAbstractSearchField(AbstractSearchField asf)
void	addSearchForms(SearchFieldMap sfMap, org.w3c.dom.Element rootElem)
void	addSearchSource(org.w3c.dom.Element sourceNode, ISearchFieldMap sfMap)
void	addSearchSource(org.w3c.dom.Element sourceNode, ISearchFieldMap sfMap, boolean checkForDuplicates)
boolean	addSearchSource(java.lang.String sourceName, ISearchFieldMap sfMap)
boolean	addSearchSources(ISearchFieldMap sfMap, org.w3c.dom.Element rootElem)
boolean	addSearchSources(ISearchFieldMap sfMap, org.w3c.dom.Element rootElem, boolean checkForDuplicates)
ISearchFieldMap	createSearchFieldMap()
AbstractSearchField	getAbstractSearchField(java.lang.String ID)
org.w3c.dom.Document	getConfigDoc()

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSearchFieldMapFactory

public XMLSearchFieldMapFactory(java.lang.String searchAppConfig)

XMLSearchFieldMapFactory

public XMLSearchFieldMapFactory(org.w3c.dom.Document configDoc)

Method Detail

createSearchFieldMap

public ISearchFieldMap createSearchFieldMap()

Specified by:

createSearchFieldMap in interface ISearchFieldMapFactory

addSearchSources

public boolean addSearchSources(ISearchFieldMap sfMap,
                                org.w3c.dom.Element rootElem)

addSearchSources

public boolean addSearchSources(ISearchFieldMap sfMap,
                                org.w3c.dom.Element rootElem,
                                boolean checkForDuplicates)

addSearchSource

public void addSearchSource(org.w3c.dom.Element sourceNode,
                            ISearchFieldMap sfMap)

addSearchSource

public void addSearchSource(org.w3c.dom.Element sourceNode,
                            ISearchFieldMap sfMap,
                            boolean checkForDuplicates)

addSearchSource

public boolean addSearchSource(java.lang.String sourceName,
                               ISearchFieldMap sfMap)

Specified by:

addSearchSource in interface ISearchFieldMapFactory

addSearchForms

public void addSearchForms(SearchFieldMap sfMap,
                           org.w3c.dom.Element rootElem)

getAbstractSearchField

public AbstractSearchField getAbstractSearchField(java.lang.String ID)

Specified by:

getAbstractSearchField in interface ISearchFieldMapFactory

addAbstractSearchField

public void addAbstractSearchField(AbstractSearchField asf)

Specified by:

addAbstractSearchField in interface ISearchFieldMapFactory

getConfigDoc

public org.w3c.dom.Document getConfigDoc()