Module org.apache.jena.arq

Package org.apache.jena.sparql.mgt

Class Explain

java.lang.Object

org.apache.jena.sparql.mgt.Explain

public class Explain
extends Object

Execution logging for query processing on a per query basis. This class provides an overlay on top of the system logging to provide control of log message down to a per query basis. The associated logging channel must also be enabled. An execution can detail the query, the algebra and every point at which the dataset is touched. Caution: logging can be a significant cost for small queries and for memory-backed datasets because of formatting the output and disk or console output overhead.

See Also:

• ARQ.logExec
• ARQ.setExecutionLogging(org.apache.jena.sparql.mgt.Explain.InfoLevel)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Explain.InfoLevel	Information level for query execution.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	logExec
static final org.slf4j.Logger	logInfo
static boolean	MultiLineMode	Control whether messages include multiple line output.

Constructor Summary

Constructors

Constructor	Description
Explain()

Method Summary

Modifier and Type	Method	Description
static void	explain(String message, Node s, Path path, Node o, Context context)
static void	explain(String message, Query query, Context context)
static void	explain(String message, Op op, Context context)
static void	explain(String message, BasicPattern bgp, Context context)
static void	explain(String message, QuadPattern quads, Context context)
static void	explain(Node s, Path path, Node o, Context context)
static void	explain(Query query, Context context)
static void	explain(Op op, Context context)
static void	explain(BasicPattern bgp, Context context)
static void	explain(Context context, String message)
static void	explain(Context context, String format, Object... args)
static boolean	explaining(Explain.InfoLevel level, org.slf4j.Logger logger, Context context)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MultiLineMode

public static boolean MultiLineMode

Control whether messages include multiple line output. In multiple line output, subsequent lines start with a space to help log file parsing.

logExec

public static final org.slf4j.Logger logExec

logInfo

public static final org.slf4j.Logger logInfo

Constructor Details

Explain

public Explain()

Method Details

explain

public static void explain(Query query,
 Context context)

explain

public static void explain(String message,
 Query query,
 Context context)

explain

public static void explain(Op op,
 Context context)

explain

public static void explain(String message,
 Op op,
 Context context)

explain

public static void explain(BasicPattern bgp,
 Context context)

explain

public static void explain(String message,
 BasicPattern bgp,
 Context context)

explain

public static void explain(String message,
 QuadPattern quads,
 Context context)

explain

public static void explain(Context context,
 String message)

explain

public static void explain(Context context,
 String format,
 Object... args)

explaining

public static boolean explaining(Explain.InfoLevel level,
 org.slf4j.Logger logger,
 Context context)

explain

public static void explain(Node s,
 Path path,
 Node o,
 Context context)

explain

public static void explain(String message,
 Node s,
 Path path,
 Node o,
 Context context)