|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.sqltools.plan.PlanRequest
public class PlanRequest
Start point to use EPV (SQL Execution Plan View), every time when the consumer needs to display an execution plan on
EPV, it must construct an instance of PlanRequest
first. This class encapsulates all necessary
information:
Field Summary | |
---|---|
static int |
FAILED
Indicates it's failed to generated the execution plan |
static int |
RUNNING
Indicates that the plan is generating, still not finished |
static int |
SUCCESS
Indicates that the plan is successfully generated |
static int |
VIEW_ACTIVATE
Make the SQL Execution Plan view visible and activated |
static int |
VIEW_CREATE
Make the SQL Execution Plan view to be made created but not necessarily be made visible |
static int |
VIEW_VISIBLE
|
Constructor Summary | |
---|---|
PlanRequest(java.lang.String sql,
java.lang.String databaseDefinitionId,
int planType,
int mode)
Constructs a plan request |
|
PlanRequest(java.lang.String sql,
java.lang.String databaseDefinitionId,
int planType,
int mode,
java.util.Map varDecs)
|
Method Summary | |
---|---|
java.lang.Object |
getData()
|
java.lang.String |
getDatabaseDefinitionId()
Returns the database definition id |
java.lang.String |
getDbName()
|
int |
getMode()
Returns the show view mode |
int |
getPlanType()
Returns the plan type |
java.lang.String |
getProfileName()
|
java.lang.String |
getSql()
Returns the sql statement |
java.util.Map |
getVarDecs()
|
boolean |
isNoexec()
|
void |
setData(java.lang.Object data)
|
void |
setDatabaseDefinitionId(java.lang.String databaseDefinitionId)
Sets the database definition id |
void |
setDbName(java.lang.String name)
|
void |
setNoexec(boolean _noexec)
|
void |
setPlanType(int type)
Sets the plan type |
void |
setProfileName(java.lang.String name)
|
void |
setSql(java.lang.String sql)
Sets the sql statement |
void |
setVarDecs(java.util.Map decs)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int VIEW_ACTIVATE
public static final int VIEW_VISIBLE
public static final int VIEW_CREATE
public static final int RUNNING
public static final int SUCCESS
public static final int FAILED
Constructor Detail |
---|
public PlanRequest(java.lang.String sql, java.lang.String databaseDefinitionId, int planType, int mode)
sql
- the SQL statement from which the execution plan is generateddatabaseDefinitionId
- the database definition id, use "product_name"_"version" to uniquely identify a
database productplanType
- the plan type, vendor-specific plan typesmode
- the show view modepublic PlanRequest(java.lang.String sql, java.lang.String databaseDefinitionId, int planType, int mode, java.util.Map varDecs)
Method Detail |
---|
public java.lang.String getDatabaseDefinitionId()
public int getPlanType()
public java.lang.String getSql()
public void setDatabaseDefinitionId(java.lang.String databaseDefinitionId)
databaseDefinitionId
- the database definition idpublic void setPlanType(int type)
type
- the plan typepublic void setSql(java.lang.String sql)
sql
- the sql statementpublic int getMode()
public boolean isNoexec()
public void setNoexec(boolean _noexec)
_noexec
- Sets whether to execute the sql statement when retrieving the execution planpublic java.lang.Object getData()
public void setData(java.lang.Object data)
public java.util.Map getVarDecs()
public void setVarDecs(java.util.Map decs)
public java.lang.String getProfileName()
public void setProfileName(java.lang.String name)
public java.lang.String getDbName()
public void setDbName(java.lang.String name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |