fr.gouv.culture.sdx.search.lucene.query
Class SortSpecification

java.lang.Object
  extended byfr.gouv.culture.sdx.search.lucene.query.SortSpecification
All Implemented Interfaces:
java.util.Comparator, org.apache.avalon.framework.logger.LogEnabled

public class SortSpecification
extends java.lang.Object
implements java.util.Comparator, org.apache.avalon.framework.logger.LogEnabled

Indications for sorting of search results. The specifications of sorting are an ordered list of sort keys (SortKey class).


Field Summary
static int SORT_ORDER_ASCENDANT
          int to specifiy and an ascending sort.
static int SORT_ORDER_DESCENDANT
          int to specifiy and an descending sort.
static java.lang.String SORT_RANKING
          The field for the sorting by relevance.
 
Constructor Summary
SortSpecification()
          Build a specification for sorting.
 
Method Summary
 void addSortKey(Field field)
          Adds an ascending sort key to the specification by a field.
 void addSortKey(Field field, int order)
          Adds a sort key to the specification by a field and an order.
 void addSortKey(java.lang.String fieldName, int order, SearchLocations locations)
          Adds a sort key to the specification, a searchLocation is needed to obtains information about locale and analysers
 void addSortKey(java.lang.String fieldName, SearchLocations locations)
          Adds a sort key to the specification, a searchLocation is needed to obtains information about locale and analysers
 int compare(java.lang.Object doc1, java.lang.Object doc2)
          Carries out the comparison of two documents with the aim of sorting them .
 void enableLogging(org.apache.avalon.framework.logger.Logger logger)
          Sets the logger.
 ResultDocuments sortResults(org.apache.lucene.search.Hits hits)
          Sorts the search results.
 ResultDocuments sortResults(ResultDocuments res)
          Sorts the search results.
 void toSAX(org.xml.sax.ContentHandler hdl)
          Returns an XML representation of this sort specification.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Field Detail

SORT_ORDER_ASCENDANT

public static final int SORT_ORDER_ASCENDANT
int to specifiy and an ascending sort.

See Also:
Constant Field Values

SORT_ORDER_DESCENDANT

public static final int SORT_ORDER_DESCENDANT
int to specifiy and an descending sort.

See Also:
Constant Field Values

SORT_RANKING

public static final java.lang.String SORT_RANKING
The field for the sorting by relevance.

See Also:
Constant Field Values
Constructor Detail

SortSpecification

public SortSpecification()
                  throws SDXException
Build a specification for sorting.

Method Detail

addSortKey

public void addSortKey(Field field,
                       int order)
                throws SDXException
Adds a sort key to the specification by a field and an order.

Parameters:
field - The field.
order - The order.
Throws:
SDXException

addSortKey

public void addSortKey(Field field)
                throws SDXException
Adds an ascending sort key to the specification by a field.

Parameters:
field - The field.
Throws:
SDXException

addSortKey

public void addSortKey(java.lang.String fieldName,
                       int order,
                       SearchLocations locations)
                throws SDXException
Adds a sort key to the specification, a searchLocation is needed to obtains information about locale and analysers

Parameters:
fieldName - The field.
order - order
locations -
Throws:
SDXException

addSortKey

public void addSortKey(java.lang.String fieldName,
                       SearchLocations locations)
                throws SDXException
Adds a sort key to the specification, a searchLocation is needed to obtains information about locale and analysers

Parameters:
fieldName - The field.
locations -
Throws:
SDXException

sortResults

public ResultDocuments sortResults(org.apache.lucene.search.Hits hits)
                            throws SDXException
Sorts the search results.

Parameters:
hits - The search hits
Throws:
SDXException

sortResults

public ResultDocuments sortResults(ResultDocuments res)
                            throws SDXException,
                                   java.io.IOException
Sorts the search results.

Parameters:
res - The result documents
Throws:
SDXException
java.io.IOException

compare

public int compare(java.lang.Object doc1,
                   java.lang.Object doc2)
Carries out the comparison of two documents with the aim of sorting them .

Specified by:
compare in interface java.util.Comparator
Parameters:
doc1 - The first document.
doc2 - The second document.

toSAX

public void toSAX(org.xml.sax.ContentHandler hdl)
           throws org.xml.sax.SAXException,
                  org.apache.cocoon.ProcessingException
Returns an XML representation of this sort specification.

Parameters:
hdl - The ContentHandler to feed with events.
Throws:
org.xml.sax.SAXException
org.apache.cocoon.ProcessingException

enableLogging

public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
Sets the logger.

Specified by:
enableLogging in interface org.apache.avalon.framework.logger.LogEnabled
Parameters:
logger - The logger to use.


Copyright © 2000-2004 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.