com.bigdata.relation.rule.eval.RuleLog Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bigdata-core Show documentation

Blazegraph(TM) DB Core Platform. It contains all Blazegraph DB dependencies other than Blueprints.

There is a newer version: 2.1.4

/*

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     [email protected]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/
/*
 * Created on Jun 22, 2009
 */

package com.bigdata.relation.rule.eval;

import org.apache.log4j.Logger;

import com.bigdata.bop.IPredicate;
import com.bigdata.relation.rule.IRule;
import com.bigdata.relation.rule.eval.pipeline.JoinStats;

/**
 * Class defines the log on which rule execution statistics are written. This
 * covers both query evaluation and mutation operations such as fixed point
 * closure of a rule set.
 * 
 * @author Bryan Thompson
 * @version $Id$
 */
public class RuleLog {

    protected static final transient Logger log = Logger
            .getLogger(RuleLog.class);

    /**
     * Log rule execution statistics.
     * 
     * @param stats
     *            The rule execution statistics.
     */
    static public void log(final RuleStats stats) {

        if (log.isInfoEnabled()) {

            log.info(stats.toString());

        }

    }

    /**
     * Log distributed join execution statistics using a CSV format.
     * 
     * @param rule
     *            The {@link IRule} whose {@link JoinStats} are being reported.
     * @param ruleState
     *            Contains details about evaluation order for the
     *            {@link IPredicate}s in the tail of the rule, the access
     *            paths that were used, etc.
     * @param joinStats
     *            The statistics for the distributed join tasks for each join
     *            dimension in the rule.
     * 
     * @return The table view.
     */
    public static void log(final IRule rule, final IRuleState ruleState,
            final JoinStats[] joinStats) {

        if (log.isInfoEnabled()) {

            log.info(JoinStats.toString(rule, ruleState, joinStats));

        }

    }

}