DocNameExtractor (Lucene 2.4.1 API)
Keywords: org.apache.lucene.benchmark.quality.utils.DocNameExtractor class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.lucene.benchmark.quality.utils
Class DocNameExtractor

    java.lang.Object
      org.apache.lucene.benchmark.quality.utils.DocNameExtractor

    public class DocNameExtractor

extends Object

Utility: extract doc names from an index

Constructor Summary
`DocNameExtractor(String docNameField)` Constructor for DocNameExtractor.

Method Summary
`String` | `docName(Searcher searcher, int docid)` Extract the name of the input doc from the index.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### DocNameExtractor

    public DocNameExtractor(String docNameField)

  Constructor for DocNameExtractor.

  Parameters:
    `docNameField` - name of the stored field containing the doc name.

Method Detail

### docName

    public String docName(Searcher searcher,
                          int docid)
                   throws IOException

  Extract the name of the input doc from the index.

  Parameters:
    `searcher` - access to the index.
    `docid` - ID of doc whose name is needed.
  Returns:
    the name of the input doc as extracted from the index.
  Throws:
    `IOException` - if cannot extract the doc name from the index.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.