com.bigdata.rdf.sparql.ast.explainhints

Class ExplainHint

java.lang.Object

com.bigdata.rdf.sparql.ast.explainhints.ExplainHint

All Implemented Interfaces:

IExplainHint

Direct Known Subclasses:

BottomUpSemanticsExplainHint, JoinOrderExplainHint, UnsatisfiableMinusExplainHint

public abstract class ExplainHint
extends Object
implements IExplainHint

Abstract base class for explain hints, providing a common base implementations, to be reused in concrete subclasses.

Version:

$Id$

Author:

Michael Schmidt

Nested Class Summary

Nested classes/interfaces inherited from interface com.bigdata.rdf.sparql.ast.explainhints.IExplainHint

IExplainHint.ExplainHintCategory, IExplainHint.ExplainHintSeverity

Constructor Summary

Constructors

Constructor and Description
ExplainHint(String explainHintDescription, String explainHintType, IExplainHint.ExplainHintCategory explainHintCategory, IExplainHint.ExplainHintSeverity explainHintSeverity, BOp explainHintNode) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
IExplainHint.ExplainHintCategory	getExplainHintCategory()
String	getExplainHintDescription()
BOp	getExplainHintNode()
IExplainHint.ExplainHintSeverity	getExplainHintSeverity()
String	getExplainHintType()
String	getHelpLink()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExplainHint

public ExplainHint(String explainHintDescription,
           String explainHintType,
           IExplainHint.ExplainHintCategory explainHintCategory,
           IExplainHint.ExplainHintSeverity explainHintSeverity,
           BOp explainHintNode)

Constructor

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getExplainHintType

public String getExplainHintType()

Specified by:

getExplainHintType in interface IExplainHint

Returns:

textual representation of the explain hint type

getExplainHintCategory

public IExplainHint.ExplainHintCategory getExplainHintCategory()

Specified by:

getExplainHintCategory in interface IExplainHint

Returns:

category of an explain hint

getExplainHintSeverity

public IExplainHint.ExplainHintSeverity getExplainHintSeverity()

Specified by:

getExplainHintSeverity in interface IExplainHint

Returns:

severity of an explain hint

getExplainHintDescription

public String getExplainHintDescription()

Specified by:

getExplainHintDescription in interface IExplainHint

Returns:

a detailed description, representing the content of the hint

getExplainHintNode

public BOp getExplainHintNode()

Specified by:

getExplainHintNode in interface IExplainHint

Returns:

the node affected by the explain node; note that we attach this node explicitly, since the node to which the hint is attached is not always the affected node, for instance if the affected node has been optimized away

getHelpLink

public String getHelpLink()

Specified by:

getHelpLink in interface IExplainHint

Returns:

a link to an external help page.