Module net.sf.jsqlparser

Package net.sf.jsqlparser.statement

Class ExplainStatement

java.lang.Object

net.sf.jsqlparser.statement.ExplainStatement

All Implemented Interfaces:

Serializable, Model, Statement

public class ExplainStatement
extends Object
implements Statement

An EXPLAIN statement

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExplainStatement.Option
static class	ExplainStatement.OptionType

Constructor Summary

Constructors

Constructor	Description
ExplainStatement()
ExplainStatement(String keyword)
ExplainStatement(String keyword, Table table)
ExplainStatement(String keyword, Select select, List<ExplainStatement.Option> optionList)
ExplainStatement(Select select)

Method Summary

Modifier and Type	Method	Description
<T,S> T	accept(StatementVisitor<T> statementVisitor, S context)
void	addOption(ExplainStatement.Option option)
String	getKeyword()
ExplainStatement.Option	getOption(ExplainStatement.OptionType optionType)	Returns the first option that matches this optionType
LinkedHashMap<ExplainStatement.OptionType,ExplainStatement.Option>	getOptions()
Select	getStatement()
Table	getTable()
ExplainStatement	setKeyword(String keyword)
void	setStatement(Select select)
ExplainStatement	setTable(Table table)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jsqlparser.statement.Statement

accept

Constructor Detail

ExplainStatement

public ExplainStatement(String keyword)

ExplainStatement

public ExplainStatement()

ExplainStatement

public ExplainStatement(String keyword,
                        Table table)

ExplainStatement

public ExplainStatement(String keyword,
                        Select select,
                        List<ExplainStatement.Option> optionList)

ExplainStatement

public ExplainStatement(Select select)

Method Detail

getTable

public Table getTable()

setTable

public ExplainStatement setTable(Table table)

getStatement

public Select getStatement()

setStatement

public void setStatement(Select select)

getOptions

public LinkedHashMap<ExplainStatement.OptionType,ExplainStatement.Option> getOptions()

addOption

public void addOption(ExplainStatement.Option option)

getOption

public ExplainStatement.Option getOption(ExplainStatement.OptionType optionType)

Returns the first option that matches this optionType

Parameters:

optionType - the option type to retrieve an Option for

Returns:

an option of that type, or null. In case of duplicate options, the first found option will be returned.

getKeyword

public String getKeyword()

setKeyword

public ExplainStatement setKeyword(String keyword)

toString

public String toString()

Overrides:

toString in class Object

accept

public <T,S> T accept(StatementVisitor<T> statementVisitor,
                            S context)

Specified by:

accept in interface Statement