com.raritantechnologies.searchApp
Class AbstractSortMap

java.lang.Object
  com.raritantechnologies.searchApp.AbstractSortMap

All Implemented Interfaces:

IConfigurable

public class AbstractSortMap

extends java.lang.Object

implements IConfigurable

Provides a default sort map for a SearchSource.

XML Configuration Template:

    <SortMap defaultField="[fieldID]" defaultDir="desc" >

      <!-- One or more BackgroundField tags: determines the next level of sorting following the primary field -->
      <!-- Multiple levels of sorting can be defined by connecting secondaryField and primaryField IDs.       -->
      <BackgroundField primaryField="[primary field]" secondaryField="[secondary field]" secondaryDir="[direction]" />

      <!-- etc. . . -->

    </SortMap>
  

Note: tertiary and higher sorts can be determined recursively.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

AbstractSortMap()

Method Summary

AbstractSortSpec	getSecondarySortSpec(java.lang.String primaryField)
AbstractSortSpec	getSortSpec()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSortMap

public AbstractSortMap()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

getSortSpec

public AbstractSortSpec getSortSpec()

getSecondarySortSpec

public AbstractSortSpec getSecondarySortSpec(java.lang.String primaryField)