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

java.lang.Object
  extended byfr.gouv.culture.sdx.utils.SdxObjectImpl
      extended byfr.gouv.culture.sdx.search.lucene.query.Results
All Implemented Interfaces:
org.apache.avalon.framework.logger.LogEnabled, Results, SdxObject, org.apache.cocoon.xml.XMLizable

public class Results
extends SdxObjectImpl
implements Results

The results of a search. This object also contains information on the search acceptRequest used to obtain them.


Field Summary
static int HITS_PER_PAGE
          The default number of results per page
 
Fields inherited from class fr.gouv.culture.sdx.utils.SdxObjectImpl
encoding, logger
 
Constructor Summary
Results()
          Creates a Results object A logger must be set and then this object must be setUp.
 
Method Summary
 int count()
          Returns the number of results.
 int countPages()
          Counts and returns the number of pages for these results.
 void enableLogging(org.apache.avalon.framework.logger.Logger logger)
          Sets the logger.
 java.lang.String[] getDocIds()
          Returns the document id for each document of the result set.
 TermHighlighter getHighliter()
           
 org.apache.lucene.search.Hits getHits()
           
 int getHitsPerPage()
          Get the number of hits per page.
 float getMaxScore()
          Returns the score of the first document, which is always the highest score.
 void getNavigationAsSAX(org.xml.sax.ContentHandler hdl, int docNo)
          Returns a representation XML of information on the preceding and following documents.
 void getNavigationAsSAX(org.xml.sax.ContentHandler hdl, java.lang.String id)
          Returns a representation XML of information on the preceding and following documents.
 Query getQuery()
          Returns the search acceptRequest which created these results.
 void getQueryAsSAX(org.xml.sax.ContentHandler hdl)
          Returns an XML representation of the Query.
 SearchLocations getSearchLocations()
          Retourne tous les r�sultats sous la forme d'un �l�ment DOM.
 void reSort(SortSpecification sorts)
          Resorts the results with a sort specification.
 void setAllHits()
          Indicates that all the results should be returned .
 void setHighliter(TermHighlighter hliter)
           
 void setHitsPerPage(int nb)
          Set the number of hits per page.
 void setId(java.lang.String id)
          Sets the identification number of this acceptRequest for a given session.
 void setUp(SearchLocations sLocs, org.apache.lucene.search.Hits searchHits, Query query)
          Builds the results of a acceptRequest from the Lucene results.
 void setUp(SearchLocations sLocs, org.apache.lucene.search.Hits searchHits, SortSpecification sorts, Query query)
          Builds the results of a acceptRequest from the Lucene results and a sort specification.
 void toSAX(org.xml.sax.ContentHandler hdl)
          Returns an XML representation of the results.
 void toSAX(org.xml.sax.ContentHandler hdl, boolean getDocuments)
          Returns an XML representation of the results.
 void toSAX(org.xml.sax.ContentHandler hdl, int pageNo)
          Returns an XML representation of the results.
 void toSAX(org.xml.sax.ContentHandler hdl, int pageNo, boolean getDocuments)
          Returns an XML representation of the results.
 
Methods inherited from class fr.gouv.culture.sdx.utils.SdxObjectImpl
getChildLogger, setEncoding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface fr.gouv.culture.sdx.utils.SdxObject
setEncoding
 

Field Detail

HITS_PER_PAGE

public static final int HITS_PER_PAGE
The default number of results per page

See Also:
Constant Field Values
Constructor Detail

Results

public Results()
Creates a Results object

A logger must be set and then this object must be setUp.

See Also:
enableLogging(org.apache.avalon.framework.logger.Logger), setUp(fr.gouv.culture.sdx.search.lucene.query.SearchLocations, org.apache.lucene.search.Hits, fr.gouv.culture.sdx.search.lucene.query.SortSpecification, fr.gouv.culture.sdx.search.lucene.query.Query)
Method Detail

setUp

public void setUp(SearchLocations sLocs,
                  org.apache.lucene.search.Hits searchHits,
                  SortSpecification sorts,
                  Query query)
           throws SDXException,
                  java.io.IOException
Builds the results of a acceptRequest from the Lucene results and a sort specification.

Parameters:
sLocs - The SearchLocations object (indices searched).
searchHits - Les r�sultats Lucene.
sorts - Les sp�cifications de tri.
query - La requ�te qui a permis d'obtenir ces r�sultats.
Throws:
SDXException
java.io.IOException

setUp

public void setUp(SearchLocations sLocs,
                  org.apache.lucene.search.Hits searchHits,
                  Query query)
           throws SDXException
Builds the results of a acceptRequest from the Lucene results.

Parameters:
sLocs - The SearchLocations object (indices searched).
searchHits - Les résultats Lucene.
query - La requ�te qui a permis d'obtenir ces r�sultats.
Throws:
SDXException

getSearchLocations

public SearchLocations getSearchLocations()
Retourne tous les r�sultats sous la forme d'un �l�ment DOM.


getHits

public org.apache.lucene.search.Hits getHits()

toSAX

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

Specified by:
toSAX in interface org.apache.cocoon.xml.XMLizable
Parameters:
hdl - The ContentHandler to feed with events.
Throws:
org.xml.sax.SAXException
org.apache.cocoon.ProcessingException

toSAX

public void toSAX(org.xml.sax.ContentHandler hdl,
                  boolean getDocuments)
           throws SDXException,
                  java.lang.Exception
Returns an XML representation of the results.

Parameters:
hdl - The ContentHandler to feed with events.
getDocuments - Indicates if the actual complete documents should be returned
Throws:
SDXException
java.lang.Exception

toSAX

public void toSAX(org.xml.sax.ContentHandler hdl,
                  int pageNo)
           throws SDXException,
                  java.lang.Exception
Returns an XML representation of the results.

Parameters:
hdl - The ContentHandler to feed with events.
pageNo - The page number of the desired results.
Throws:
SDXException
java.lang.Exception

toSAX

public void toSAX(org.xml.sax.ContentHandler hdl,
                  int pageNo,
                  boolean getDocuments)
           throws SDXException,
                  org.xml.sax.SAXException,
                  org.apache.cocoon.ProcessingException
Returns an XML representation of the results.

Parameters:
hdl - The ContentHandler to feed with events.
pageNo - The requested page number of the desired results. Reaffected when number of results doesn't fit.
getDocuments - Indicates if the actual complete documents should be returned
Throws:
SDXException
org.xml.sax.SAXException
org.apache.cocoon.ProcessingException

countPages

public int countPages()
Counts and returns the number of pages for these results.


setAllHits

public void setAllHits()
Indicates that all the results should be returned .


setHitsPerPage

public void setHitsPerPage(int nb)
Set the number of hits per page.

Parameters:
nb - The number of hits.

getHitsPerPage

public int getHitsPerPage()
Get the number of hits per page.


setId

public void setId(java.lang.String id)
Sets the identification number of this acceptRequest for a given session.

Parameters:
id - The id.

getQueryAsSAX

public void getQueryAsSAX(org.xml.sax.ContentHandler hdl)
                   throws SDXException,
                          org.xml.sax.SAXException,
                          org.apache.cocoon.ProcessingException
Returns an XML representation of the Query.

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

getDocIds

public java.lang.String[] getDocIds()
                             throws SDXException,
                                    java.io.IOException
Returns the document id for each document of the result set.

Throws:
SDXException
java.io.IOException

getQuery

public Query getQuery()
Returns the search acceptRequest which created these results.


getNavigationAsSAX

public void getNavigationAsSAX(org.xml.sax.ContentHandler hdl,
                               int docNo)
                        throws SDXException,
                               org.xml.sax.SAXException,
                               org.apache.cocoon.ProcessingException,
                               java.io.IOException
Returns a representation XML of information on the preceding and following documents. This representation includes the identifier as well as the page number of the preceding and the following documents as compared to the document whose number is provided

Parameters:
docNo - The 1-based index of the document in the sorted results
hdl - The ContentHandler which will receive the events
Throws:
SDXException
org.xml.sax.SAXException
org.apache.cocoon.ProcessingException
java.io.IOException

getNavigationAsSAX

public void getNavigationAsSAX(org.xml.sax.ContentHandler hdl,
                               java.lang.String id)
                        throws SDXException,
                               org.xml.sax.SAXException,
                               org.apache.cocoon.ProcessingException,
                               java.io.IOException
Returns a representation XML of information on the preceding and following documents. This representation includes the identifier as well as the page number of the preceding and the following documents as compared to the document whose number is provided

Parameters:
hdl - The ContentHandler which will receive the events
id - The id of the document
Throws:
SDXException
org.xml.sax.SAXException
org.apache.cocoon.ProcessingException
java.io.IOException

reSort

public void reSort(SortSpecification sorts)
            throws java.io.IOException,
                   SDXException
Resorts the results with a sort specification.

Parameters:
sorts - The sort specification.
Throws:
java.io.IOException
SDXException

count

public int count()
Returns the number of results.


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
Overrides:
enableLogging in class SdxObjectImpl
Parameters:
logger - The logger.

getMaxScore

public float getMaxScore()
Returns the score of the first document, which is always the highest score.


getHighliter

public TermHighlighter getHighliter()

setHighliter

public void setHighliter(TermHighlighter hliter)


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