org.hibernate.search.query.engine.spi
Interface DocumentExtractor
- All Known Implementing Classes:
- DocumentExtractorImpl
public interface DocumentExtractor
DocumentExtractor is a traverser over the full-text results (EntityInfo)
This operation is as lazy as possible:
- the query is executed eagerly
- results are not retrieved until actually requested
getFirstIndex()
and getMaxIndex()
define the boundaries available to extract(int)
.
DocumentExtractor objects *must* be closed when the results are no longer traversed. See close()
- Author:
- Emmanuel Bernard
extract
EntityInfo extract(int index)
throws IOException
- Throws:
IOException
getFirstIndex
int getFirstIndex()
getMaxIndex
int getMaxIndex()
close
void close()
getTopDocs
org.apache.lucene.search.TopDocs getTopDocs()
- Experimental
- We are thinking at ways to encapsulate needs for exposing TopDocs (and whether or not it makes sense)
Try to avoid it if you can
Copyright © 2006-2012 Red Hat Middleware, LLC. All Rights Reserved