Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class TrecTopicsReader

    Read TREC topics.

    Inheritance
    object
    TrecTopicsReader
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Benchmarks.Quality.Trec
    Assembly: Lucene.Net.Benchmark.dll
    Syntax
    public class TrecTopicsReader
    Remarks

    Expects this topic format -

    <top>
    <num> Number: nnn
    
    <title> title of the topic
    
    <desc> Description:
    description of the topic
    
    <narr> Narrative:
    "story" composed by assessors.
    
    </top>

    Comment lines starting with '#' are ignored.

    Constructors

    TrecTopicsReader()

    Constructor for Trec's TopicsReader

    Declaration
    public TrecTopicsReader()
    Remarks

    Expects this topic format -

    <top>
    <num> Number: nnn
    
    <title> title of the topic
    
    <desc> Description:
    description of the topic
    
    <narr> Narrative:
    "story" composed by assessors.
    
    </top>

    Comment lines starting with '#' are ignored.

    Methods

    ReadQueries(TextReader)

    Read quality queries from trec format topics file.

    Declaration
    public virtual QualityQuery[] ReadQueries(TextReader reader)
    Parameters
    Type Name Description
    TextReader reader

    where queries are read from.

    Returns
    Type Description
    QualityQuery[]

    the result quality queries.

    Remarks

    Expects this topic format -

    <top>
    <num> Number: nnn
    
    <title> title of the topic
    
    <desc> Description:
    description of the topic
    
    <narr> Narrative:
    "story" composed by assessors.
    
    </top>

    Comment lines starting with '#' are ignored.

    Exceptions
    Type Condition
    IOException

    if cannot read the queries.

    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.