Apache Derby Tools 10.17.1.0 · org.apache.derby.impl.tools.planexporter.AccessDatabase

Field Summary

Modifier and Type	Field and Description
private final Connection	conn
private TreeNode[]	data
private int	depth
private static final int	ID
private static final int	INPUT_ROWS
private static final int	NEXT_QUALIFIERS
private static final int	NO_OF_OPENS
private static final int	NO_OF_OUTPUT_ROWS_BY_SORTER
private static final int	NODE_TYPE
private static final int	P_ID
private final String	query
private static final int	RETURNED_ROWS
private static final int	SCAN_QUALIFIERS
private static final int	SCAN_TYPE
private static final int	SCANNED_OBJECT
private final String	schema
private final boolean	schemaExists
private static final int	SORT_TYPE
private static final int	VISITED_PAGES
private String	xmlDetails

Constructor Summary

Access	Constructor and Description
public	AccessDatabase(String dburl, String aSchema, String aQuery)
public	AccessDatabase(Connection aConn, String aSchema, String aQuery)

Method Summary

Modifier and Type	Method and Description
public void	closeConnection() closing the connection to the database
private static Connection	createConnection(String dbURL)
private void	createXMLData(String query to be executed qry, int x) Create XML data based on the query that's passed in. The query should have exactly one parameter, which will be initialized to the statement id before the query is executed.
public void	createXMLFragment() This method creates the queries such that after execution of the query it will return XML data fragments.
private static String	Returns: the text with special characters escaped escapeForXML(String the text to escape text) Escape characters that have a special meaning in XML.
private String	Returns: modified string escapeInAttribute(String attribute string to be checked text) This method is needed since in the case of XML attributes we have to filter the quotation (") marks that is compulsory.
private void	findChildren(int current element's index idx, int current examining depth dep)
private void	getChildren(int level of the XML tree (0 based) of current node currentLevel, String current node's stmt_id id)
public TreeNode[]	Returns: data array of TreeNode Objects getData()
public int	getDepth()
public String	Returns: the stmt_id getQuery()
public String	Returns: all xml elements as a String getXmlString() Generating the XML tree
public String	Returns: indent as a string indent(int indent needed j)
public boolean	Returns: whether the initialization is successful or not initializeDataArray()
public void	markTheDepth() marking the depth of each element
private int	Returns: total # of nodes noOfNodes()
private boolean	schemaExists() Check if there is a schema in the database that matches the schema name that was passed in to this instance.
private void	setSchema() Set the schema of the current connection to the XPLAIN schema in which the statistics can be found.
public String	Returns: the <statement> element statement()
public String	Returns: stmt_id as a XML element stmtID()
public String	Returns: XPLAIN_TIME of SYSXPLAIN_STATEMENTS time()
public boolean	verifySchemaExistance()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

conn	back to summary
private final Connection conn

data	back to summary
private TreeNode[] data

depth	back to summary
private int depth

ID	back to summary
private static final int ID

INPUT_ROWS	back to summary
private static final int INPUT_ROWS

NEXT_QUALIFIERS	back to summary
private static final int NEXT_QUALIFIERS

NO_OF_OPENS	back to summary
private static final int NO_OF_OPENS

NO_OF_OUTPUT_ROWS_BY_SORTER	back to summary
private static final int NO_OF_OUTPUT_ROWS_BY_SORTER

NODE_TYPE	back to summary
private static final int NODE_TYPE

P_ID	back to summary
private static final int P_ID

query	back to summary
private final String query

RETURNED_ROWS	back to summary
private static final int RETURNED_ROWS

SCAN_QUALIFIERS	back to summary
private static final int SCAN_QUALIFIERS

SCAN_TYPE	back to summary
private static final int SCAN_TYPE

SCANNED_OBJECT	back to summary
private static final int SCANNED_OBJECT

schema	back to summary
private final String schema

schemaExists	back to summary
private final boolean schemaExists

SORT_TYPE	back to summary
private static final int SORT_TYPE

VISITED_PAGES	back to summary
private static final int VISITED_PAGES

xmlDetails	back to summary
private String xmlDetails

Constructor Detail

AccessDatabase	back to summary
public AccessDatabase(String dburl, String aSchema, String aQuery) throws InstantiationException, IllegalAccessException, ClassNotFoundException, SQLException, NoSuchMethodException, InvocationTargetException

AccessDatabase	back to summary
public AccessDatabase(Connection aConn, String aSchema, String aQuery) throws SQLException

Method Detail

closeConnection	back to summary
public void closeConnection() closing the connection to the database

createConnection	back to summary
private static Connection createConnection(String dbURL) throws InstantiationException, IllegalAccessException, ClassNotFoundException, SQLException, NoSuchMethodException, InvocationTargetException

createXMLData	back to summary
private void createXMLData(String qry, int x) throws SQLException Create XML data based on the query that's passed in. The query should have exactly one parameter, which will be initialized to the statement id before the query is executed. Parameters qry:String query to be executed

createXMLData

back to summary

private void createXMLData(String qry, int x) throws SQLException

Create XML data based on the query that's passed in. The query should have exactly one parameter, which will be initialized to the statement id before the query is executed.

Parameters

qry:String: query to be executed

createXMLFragment	back to summary
public void createXMLFragment() throws SQLException This method creates the queries such that after execution of the query it will return XML data fragments.

escapeForXML	back to summary
private static String escapeForXML(String text) Escape characters that have a special meaning in XML. Parameters text:String the text to escape Returns:String the text with special characters escaped

escapeForXML

back to summary

private static String escapeForXML(String text)

Escape characters that have a special meaning in XML.

Parameters

text:String: the text to escape

Returns:String

the text with special characters escaped

escapeInAttribute	back to summary
private String escapeInAttribute(String text) This method is needed since in the case of XML attributes we have to filter the quotation (") marks that is compulsory. eg: scanned_object="A "quoted" table name"; Parameters text:String attribute string to be checked Returns:String modified string

escapeInAttribute

back to summary

private String escapeInAttribute(String text)

This method is needed since in the case of XML attributes we have to filter the quotation (") marks that is compulsory. eg: scanned_object="A "quoted" table name";

Parameters

text:String: attribute string to be checked

Returns:String

modified string

findChildren	back to summary
private void findChildren(int idx, int dep) Parameters idx:int current element's index dep:int current examining depth

getChildren	back to summary
private void getChildren(int currentLevel, String id) Parameters currentLevel:int level of the XML tree (0 based) of current node id:String current node's stmt_id

getData	back to summary
public TreeNode[] getData() Returns:TreeNode[] data array of TreeNode Objects

getDepth	back to summary
public int getDepth()

getQuery	back to summary
public String getQuery() Returns:String the stmt_id

getXmlString	back to summary
public String getXmlString() Generating the XML tree Returns:String all xml elements as a String

getXmlString

back to summary

public String getXmlString()

Generating the XML tree

Returns:String: all xml elements as a String

indent	back to summary
public String indent(int j) Parameters j:int indent needed Returns:String indent as a string

initializeDataArray	back to summary
public boolean initializeDataArray() throws SQLException Returns:boolean whether the initialization is successful or not

markTheDepth	back to summary
public void markTheDepth() marking the depth of each element

noOfNodes	back to summary
private int noOfNodes() throws SQLException Returns:int total # of nodes

schemaExists	back to summary
private boolean schemaExists() throws SQLException Check if there is a schema in the database that matches the schema name that was passed in to this instance.

setSchema	back to summary
private void setSchema() throws SQLException Set the schema of the current connection to the XPLAIN schema in which the statistics can be found. Exceptions SQLException: if an error happens while accessing the database

setSchema

back to summary

private void setSchema() throws SQLException

Set the schema of the current connection to the XPLAIN schema in which the statistics can be found.

Exceptions

SQLException:: if an error happens while accessing the database

statement	back to summary
public String statement() throws SQLException Returns:String the <statement> element

stmtID	back to summary
public String stmtID() Returns:String stmt_id as a XML element

time	back to summary
public String time() throws SQLException Returns:String XPLAIN_TIME of SYSXPLAIN_STATEMENTS

verifySchemaExistance	back to summary
public boolean verifySchemaExistance()

public Class AccessDatabase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail