org.compass.core
Interface CompassDetachedHits

All Superinterfaces:
CompassHitsOperations, Iterable<CompassHit>, Serializable
All Known Implementing Classes:
DefaultCompassDetachedHits

public interface CompassDetachedHits
extends CompassHitsOperations

Holds hits returned from a search performed by compass. Can be used outside of a transaction context. In order to get detached hits, use CompassHits.detach() or CompassHits.detach(int, int).

Author:
kimchy

Method Summary
 Object[] getDatas()
          Returns all the Objects data as an array.
 CompassHit[] getHits()
          Returns all the CompassHits data as an array.
 Resource[] getResources()
          Returns all the Resources as an array.
 int getTotalLength()
          Returns the total number of hits (not just the detached ones).
 int totalLength()
          Returns the total number of hits (not just the detached ones).
 
Methods inherited from interface org.compass.core.CompassHitsOperations
data, getLength, getQuery, getSuggestedQuery, highlightedText, hit, length, resource, score
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

getTotalLength

int getTotalLength()
Returns the total number of hits (not just the detached ones).

Returns:
The total number of hits.

totalLength

int totalLength()
Returns the total number of hits (not just the detached ones).

Returns:
The total number of hits.

getResources

Resource[] getResources()
                        throws CompassException
Returns all the Resources as an array.

Returns:
All the Resources as an array
Throws:
CompassException

getDatas

Object[] getDatas()
                  throws CompassException
Returns all the Objects data as an array.

Returns:
An array of all the hits as objects.
Throws:
CompassException

getHits

CompassHit[] getHits()
                     throws CompassException
Returns all the CompassHits data as an array.

Returns:
An array of all the hits.
Throws:
CompassException
See Also:
CompassHit


Copyright (c) 2004-2008 The Compass Project.