Top Description Fields Constructors Methods
org.apache.derby.impl.sql.execute.xplain

public Class XPLAINUtil

extends Object
Class Inheritance
Imports
java.util.Properties, org.apache.derby.shared.common.reference.SQLState, org.apache.derby.shared.common.i18n.MessageService, org.apache.derby.impl.sql.catalog.XPLAINScanPropsDescriptor, .XPLAINSortPropsDescriptor

This class contains helper methods, which support the System Table Visitor.

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
ISOLATION_READ_UNCOMMITED

isolation level codes

public static final String
public static final String
public static final String
public static final String
LOCK_GRANULARITY_TABLE

lock granularity

public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
OP_TABLESCAN

the rs operator codes

public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
SCAN_HEAP

the scan info codes

public static final String
public static final String
public static final String
SELECT_STMT_TYPE

the different statement type constants

public static final String
SORT_EXTERNAL

sort info properties

public static final String
public static final String
public static final String
public static final String
XPLAIN_ONLY

the explain type constants

public static final String
YES_CODE

yes no codes

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static XPLAINScanPropsDescriptor

Returns:

the filled descriptor
extractScanProps
(XPLAINScanPropsDescriptor
the descriptor to fill with properties
descriptor
,
Properties
the provided scan props
scanProps
)

helper method which extracts the right (non-internationalzed) scan properties of the scan info properties

public static XPLAINSortPropsDescriptor

Returns:

the filled descriptor
extractSortProps
(XPLAINSortPropsDescriptor
the descriptor to fill with properties
descriptor
,
Properties
the provided sort props
sortProps
)

helper method which extracts the right (non-internationalzed) sort properties of the sort info properties object

public static Long

Returns:

the quotient or null
getAVGNextTime
(long
the long value for the dividend (the whole next time)
dividend
,
long
the long value for the divisor (the sum of all rows seen)
divisor
)

Compute average, avoiding divide-by-zero problems.

public static String
getHashKeyColumnNumberString(int[] hashKeyColumns)

public static String
getIsolationLevelCode(String isolationLevel)

util function, to resolve the isolation level and return a isolation level code

public static String
getLockGranularityCode(String lockString)

util function, to resolve the lock granularity and return a lock granularity code

public static String
getLockModeCode(String lockString)

util function, to resolve the lock mode, and return a lock mode code

public static String
getStatementType(String SQLText)

This method helps to figure out the statement type and returns an appropriate return code, characterizing the stmt type.

public static String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CALL_STMT_TYPEback to summary
public static final String CALL_STMT_TYPE
DDL_STMT_TYPEback to summary
public static final String DDL_STMT_TYPE
DELETE_STMT_TYPEback to summary
public static final String DELETE_STMT_TYPE
INSERT_STMT_TYPEback to summary
public static final String INSERT_STMT_TYPE
ISOLATION_READ_COMMITback to summary
public static final String ISOLATION_READ_COMMIT
ISOLATION_READ_UNCOMMITEDback to summary
public static final String ISOLATION_READ_UNCOMMITED

isolation level codes

ISOLATION_REPEAT_READback to summary
public static final String ISOLATION_REPEAT_READ
ISOLATION_SERIALIZABLEback to summary
public static final String ISOLATION_SERIALIZABLE
LOCK_GRANULARITY_ROWback to summary
public static final String LOCK_GRANULARITY_ROW
LOCK_GRANULARITY_TABLEback to summary
public static final String LOCK_GRANULARITY_TABLE

lock granularity

LOCK_MODE_EXCLUSIVEback to summary
public static final String LOCK_MODE_EXCLUSIVE

lock modes

LOCK_MODE_INSTANTENOUS_EXCLUSIVEback to summary
public static final String LOCK_MODE_INSTANTENOUS_EXCLUSIVE
LOCK_MODE_INSTANTENOUS_SHAREback to summary
public static final String LOCK_MODE_INSTANTENOUS_SHARE
LOCK_MODE_SHAREback to summary
public static final String LOCK_MODE_SHARE
NO_CODEback to summary
public static final String NO_CODE
OP_AGGREGATEback to summary
public static final String OP_AGGREGATE
OP_ANYback to summary
public static final String OP_ANY
OP_BULKback to summary
public static final String OP_BULK
OP_CASCADEback to summary
public static final String OP_CASCADE
OP_CONSTRAINTSCANback to summary
public static final String OP_CONSTRAINTSCAN
OP_CURRENT_OFback to summary
public static final String OP_CURRENT_OF
OP_DELETEback to summary
public static final String OP_DELETE
OP_DISTINCTback to summary
public static final String OP_DISTINCT
OP_DISTINCTSCANback to summary
public static final String OP_DISTINCTSCAN
OP_FILTERback to summary
public static final String OP_FILTER
OP_GROUPback to summary
public static final String OP_GROUP
OP_HASHSCANback to summary
public static final String OP_HASHSCAN
OP_HASHTABLEback to summary
public static final String OP_HASHTABLE
OP_INDEXSCANback to summary
public static final String OP_INDEXSCAN
OP_INSERTback to summary
public static final String OP_INSERT
OP_JOIN_HASHback to summary
public static final String OP_JOIN_HASH
OP_JOIN_HASH_LOback to summary
public static final String OP_JOIN_HASH_LO
OP_JOIN_NLback to summary
public static final String OP_JOIN_NL
OP_JOIN_NL_LOback to summary
public static final String OP_JOIN_NL_LO
OP_LASTINDEXKEYSCANback to summary
public static final String OP_LASTINDEXKEYSCAN
OP_MATERIALIZEback to summary
public static final String OP_MATERIALIZE
OP_NORMALIZEback to summary
public static final String OP_NORMALIZE
OP_ONCEback to summary
public static final String OP_ONCE
OP_PROJ_RESTRICTback to summary
public static final String OP_PROJ_RESTRICT
OP_PROJECTback to summary
public static final String OP_PROJECT
OP_ROWback to summary
public static final String OP_ROW
OP_ROW_COUNTback to summary
public static final String OP_ROW_COUNT
OP_ROWIDSCANback to summary
public static final String OP_ROWIDSCAN
OP_SCROLLback to summary
public static final String OP_SCROLL
OP_SETback to summary
public static final String OP_SET
OP_SET_EXCEPTback to summary
public static final String OP_SET_EXCEPT
OP_SET_INTERSECTback to summary
public static final String OP_SET_INTERSECT
OP_SORTback to summary
public static final String OP_SORT
OP_TABLESCANback to summary
public static final String OP_TABLESCAN

the rs operator codes

OP_UNIONback to summary
public static final String OP_UNION
OP_UPDATEback to summary
public static final String OP_UPDATE
OP_VTIback to summary
public static final String OP_VTI
OP_VTI_RSback to summary
public static final String OP_VTI_RS
OP_WINDOWback to summary
public static final String OP_WINDOW
SCAN_BITSET_ALLback to summary
public static final String SCAN_BITSET_ALL
SCAN_BTREEback to summary
public static final String SCAN_BTREE
SCAN_HEAPback to summary
public static final String SCAN_HEAP

the scan info codes

SCAN_SORTback to summary
public static final String SCAN_SORT
SELECT_APPROXIMATE_STMT_TYPEback to summary
public static final String SELECT_APPROXIMATE_STMT_TYPE
SELECT_STMT_TYPEback to summary
public static final String SELECT_STMT_TYPE

the different statement type constants

SORT_EXTERNALback to summary
public static final String SORT_EXTERNAL

sort info properties

SORT_INTERNALback to summary
public static final String SORT_INTERNAL
UPDATE_STMT_TYPEback to summary
public static final String UPDATE_STMT_TYPE
XPLAIN_FULLback to summary
public static final String XPLAIN_FULL
XPLAIN_ONLYback to summary
public static final String XPLAIN_ONLY

the explain type constants

YES_CODEback to summary
public static final String YES_CODE

yes no codes

Constructor Detail

XPLAINUtilback to summary
public XPLAINUtil()

Method Detail

extractScanPropsback to summary
public static XPLAINScanPropsDescriptor extractScanProps(XPLAINScanPropsDescriptor descriptor, Properties scanProps)

helper method which extracts the right (non-internationalzed) scan properties of the scan info properties

Parameters
descriptor:XPLAINScanPropsDescriptor

the descriptor to fill with properties

scanProps:Properties

the provided scan props

Returns:XPLAINScanPropsDescriptor

the filled descriptor

extractSortPropsback to summary
public static XPLAINSortPropsDescriptor extractSortProps(XPLAINSortPropsDescriptor descriptor, Properties sortProps)

helper method which extracts the right (non-internationalzed) sort properties of the sort info properties object

Parameters
descriptor:XPLAINSortPropsDescriptor

the descriptor to fill with properties

sortProps:Properties

the provided sort props

Returns:XPLAINSortPropsDescriptor

the filled descriptor

getAVGNextTimeback to summary
public static Long getAVGNextTime(long dividend, long divisor)

Compute average, avoiding divide-by-zero problems.

Parameters
dividend:long

the long value for the dividend (the whole next time)

divisor:long

the long value for the divisor (the sum of all rows seen)

Returns:Long

the quotient or null

getHashKeyColumnNumberStringback to summary
public static String getHashKeyColumnNumberString(int[] hashKeyColumns)
getIsolationLevelCodeback to summary
public static String getIsolationLevelCode(String isolationLevel)

util function, to resolve the isolation level and return a isolation level code

getLockGranularityCodeback to summary
public static String getLockGranularityCode(String lockString)

util function, to resolve the lock granularity and return a lock granularity code

getLockModeCodeback to summary
public static String getLockModeCode(String lockString)

util function, to resolve the lock mode, and return a lock mode code

getStatementTypeback to summary
public static String getStatementType(String SQLText)

This method helps to figure out the statement type and returns an appropriate return code, characterizing the stmt type.

getYesNoCharFromBooleanback to summary
public static String getYesNoCharFromBoolean(boolean test)