net.sf.saxon.trans.RuleSearchState Maven / Gradle / Ivy

Go to download
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2015 Saxonica Limited.
// 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/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.trans;

import net.sf.saxon.trace.ExpressionPresenter;

/**
 * A simple class for holding stateful details of a rule search operation
 * Can record call statistics and time.
 * Subclasses can be used to hold information such as precondition sets etc.
 * A new RuleSearchState (or subclass) should be created at the start of each check through a rule set.
 * This can be achieved through {@link SimpleMode#makeRuleSearchState()}.
 */
public class RuleSearchState {
    protected int calls;
    public long startTime;
    public SimpleMode mode;

    public RuleSearchState(SimpleMode mode) {
        this.mode = mode;
        resetBasic();
    }

    public void resetBasic() {
        calls = 0;
        startTime = System.nanoTime();
    }

    public int getCalls() {
        return calls;
    }

    public void count() {
        calls++;
    }


    /**
     * Add any other required properties to an output
     *
     * @param out
     */
    public void otherProperties(ExpressionPresenter out) {
    }
}