com.raritantechnologies.searchApp
Class FieldComparator

java.lang.Object
  com.raritantechnologies.searchApp.FieldComparator

All Implemented Interfaces:

java.util.Comparator, IComparator, IConfigurable, IResultComparator

public class FieldComparator

extends java.lang.Object

implements java.util.Comparator, IResultComparator, IComparator

Compare two IResult objects by a field in the record. Used for sorting results based on a field value.

XML Configuration Template:

  <ResultComparator class="com.raritantechnologies.searchApp.FieldComparator"
                 fieldID="[result field to sort on]"
                 sortDir="asc|desc"
                 caseSensitive="true|false(default)" >

    <!-- Optional StringFilter that will filter the field values prior to comparison -->
    <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >
    </StringFilter>

    <!-- Optional implementation of IComparator to do the actual field value comparison -->
    <Comparator class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >

    </Comparator>

  </ResultComparator>
 

Developed by Raritan Technologies .

Author:

Kepler Gelotte

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IResultComparator

TEMPLATE

Fields inherited from interface com.raritantechnologies.utils.comparators.IComparator

TEMPLATE

Constructor Summary

FieldComparator()

FieldComparator(java.lang.String field)

FieldComparator(java.lang.String field, boolean ascending)

Method Summary

int	compare(IResult res1, IResult res2)
int	compare(java.lang.Object o1, java.lang.Object o2)
boolean	equals(java.lang.Object o)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setContext(java.util.Map parameterMap)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldComparator

public FieldComparator()

FieldComparator

public FieldComparator(java.lang.String field)

FieldComparator

public FieldComparator(java.lang.String field,
                       boolean ascending)

Method Detail

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

Specified by:

compare in interface java.util.Comparator

compare

public int compare(IResult res1,
                   IResult res2)

Specified by:

compare in interface IResultComparator

setContext

public void setContext(java.util.Map parameterMap)

Specified by:

setContext in interface IResultComparator

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Comparator

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 IResultComparator

toString

public java.lang.String toString()