## helma.Search.HitCollection

    Object
       |
       +--helma.Search.HitCollection

This class provides Helma-like methods for accessing a collection of search hits.
Defined in Search.js

SUMMARY: Constructor | Properties | Methods | DETAIL: Constructor | Properties | Methods

Constructor Summary
`helma.Search.HitCollection(<org.lucene.search.Hits> hits)` Creates a new instance of helma.Search.HitCollection

Methods Summary
`helma.Search.Document` | `get(<Number> idx)` Silently converts the hit at the given index position into an instance of helma.Search.Document.
`Number` | `length()` Returns the number of hits in this collection.
`Number` | `size()` Returns the number of hits in this collection.

Constructor Detail

### helma.Search.HitCollection

    helma.Search.HitCollection(<org.lucene.search.Hits> hits)

Creates a new instance of helma.Search.HitCollection

Parameters:

`hits` - The hit collection returned by lucene.

Method Detail

### get

    helma.Search.Document get(<Number> idx)

Silently converts the hit at the given index position into an instance of helma.Search.Document.

Parameters:

`idx` - The index position of the hit

Returns:

The document object at the given index position

### length

    Number length()

Returns the number of hits in this collection. This method is deprecated, use size() instead.

Returns:

The number of hits.

Deprecated
See:

- size()

### size

    Number size()

Returns the number of hits in this collection.

Returns:

The number of hits.

SUMMARY: Constructor | Properties | Methods | DETAIL: Constructor | Properties | Methods

Documentation generated by JSDoc on Thu Apr 5 01:59:00 2007