QueryStats.java

package lux;

import lux.xquery.XQuery;

/**
 * Holds statistics about a single query execution
 */
public class QueryStats {
    /**
     * the number of documents that matched the lucene query. If XPath was executed (there wasn't
     * a short-circuited eval of some sort), this number of XML documents will have been retrieved
     * from the database and processed.
     */
    public int docCount;
    
    /**
     * time spent collecting results (parsing and computing xpath, mostly), in nanoseconds
     */
    public long collectionTime;
    
    /*
     * total time to evaluate the query and produce results, in nanoseconds
     */
    public long totalTime;
    
    /**
     * A description of the work done prior to collection; usu. the Lucene Query generated from the XPath and used to retrieve a set of candidate
     * documents for evaluation.
     */
    public String query;
    
    /**
     * A record of the query's facts.  If multiple queries were evaluated, the facts are combined
     * using bitwise AND.
     */
    public long queryFacts;
    
    /**
     * time spent retrieving and parsing documents
     */
    public long retrievalTime;

    public String optimizedQuery;

    public XQuery optimizedXQuery;
    
    @Override
    public String toString () {
        return String.format("%s: %dms %d docs, %dms docread", 
                query == null ? "" : query.substring(0, Math.min(20,query.length())),
                totalTime/1000000, docCount, retrievalTime/1000000
                );
    }

}

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */