org.apache.derbyTesting.junit

Class XML

java.lang.Object

org.apache.derbyTesting.junit.XML

public class XML
extends java.lang.Object

XML utility methods for the JUnit tests.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	HAVE_JAXP Determine whether or not the classpath with which we're running has the JAXP API classes required for use of the Derby XML operators.
private static boolean	HAVE_JAXP_IMPL Determine whether or not the classpath with which we're running has a JAXP implementation.
private static boolean	HAVE_XPATH Determine if we have support evaluating XPath queries.
private static java.lang.String	HELPER_FILE_LOCATION The filepath for the directory that holds the XML "helper" files (i.e. the files to insert and their schema documents).

Constructor Summary

Constructors

Constructor and Description
XML()

Method Summary

Modifier and Type	Method and Description
private static boolean	checkJAXPImplementation()
private static boolean	checkXPathSupport() Determine whether or not the classpath with which we're running contains a JAXP implementation that supports evaluating XPath queries.
static boolean	classpathHasJAXP() Return true if the classpath contains JAXP and an implementation of the JAXP interfaces, for example the Xalan classes (this method doesn't care about support for XPath queries).
static boolean	classpathMeetsXMLReqs() Return true if the classpath meets all of the requirements for use of the SQL/XML operators.
protected static java.lang.String	getJAXPParserLocation() Return the string form of the URL for the jar file that contains whichever JAXP parser implementation is picked up from the user's classpath.
static void	insertDocWithDTD(java.sql.Connection conn, java.lang.String tableName, java.lang.String colName, java.lang.String fName, java.lang.String dtdName, int numRows) Insert an XML document into the received column of the received test table using setString.
static void	insertFile(java.sql.Connection conn, java.lang.String tableName, java.lang.String colName, java.lang.String fName, int numRows) Insert the contents of a file into the received column of the received table using "setCharacterStream".

Methods inherited from class java.lang.Object

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

Field Detail

HAVE_JAXP

private static final boolean HAVE_JAXP

Determine whether or not the classpath with which we're running has the JAXP API classes required for use of the Derby XML operators.

HAVE_JAXP_IMPL

private static final boolean HAVE_JAXP_IMPL

Determine whether or not the classpath with which we're running has a JAXP implementation.

HAVE_XPATH

private static final boolean HAVE_XPATH

Determine if we have support evaluating XPath queries.

HELPER_FILE_LOCATION

private static final java.lang.String HELPER_FILE_LOCATION

The filepath for the directory that holds the XML "helper" files (i.e. the files to insert and their schema documents).

See Also:

Constant Field Values

Constructor Detail

XML

public XML()

Method Detail

classpathHasJAXP

public static boolean classpathHasJAXP()

Return true if the classpath contains JAXP and an implementation of the JAXP interfaces, for example the Xalan classes (this method doesn't care about support for XPath queries).

classpathMeetsXMLReqs

public static boolean classpathMeetsXMLReqs()

Return true if the classpath meets all of the requirements for use of the SQL/XML operators.

insertFile

public static void insertFile(java.sql.Connection conn,
                              java.lang.String tableName,
                              java.lang.String colName,
                              java.lang.String fName,
                              int numRows)
                       throws java.io.IOException,
                              java.sql.SQLException,
                              java.security.PrivilegedActionException

Insert the contents of a file into the received column of the received table using "setCharacterStream". Expectation is that the file is in the directory indicated by HELPER_FILE_LOCATION.

Parameters:

conn - Connection on which to perform the insert.

tableName - Table into which we want to insert.

colName - Column in tableName into which we want to insert.

fName - Name of the file whose content we want to insert.

numRows - Number of times we should insert the received file's content.

Throws:

java.io.IOException

java.sql.SQLException

java.security.PrivilegedActionException

insertDocWithDTD

public static void insertDocWithDTD(java.sql.Connection conn,
                                    java.lang.String tableName,
                                    java.lang.String colName,
                                    java.lang.String fName,
                                    java.lang.String dtdName,
                                    int numRows)
                             throws java.io.IOException,
                                    java.sql.SQLException,
                                    java.security.PrivilegedActionException

Insert an XML document into the received column of the received test table using setString. This method parallels "insertFiles" above, except that it should be used for documents that require a Document Type Definition (DTD). In that case the location of the DTD has to be modified _within_ the document so that it can be found in the running user directory. Expectation is that the file to be inserted is in the directory indicated by HELPER_FILE_LOCATION and that the DTD file has been copied to the user's running directory (via use of the util methods in SupportFilesSetup).

Parameters:

conn - Connection on which to perform the insert.

tableName - Table into which we want to insert.

colName - Column in tableName into which we want to insert.

fName - Name of the file whose content we want to insert.

dtdName - Name of the DTD file that the received file uses.

numRows - Number of times we should insert the received file's content.

Throws:

java.io.IOException

java.sql.SQLException

java.security.PrivilegedActionException

checkXPathSupport

private static boolean checkXPathSupport()

Determine whether or not the classpath with which we're running contains a JAXP implementation that supports evaluating XPath queries.

Assumption is that we only get to this method if we already know that there *is* an implementation of JAXP in the classpath.

checkJAXPImplementation

private static boolean checkJAXPImplementation()

getJAXPParserLocation

protected static java.lang.String getJAXPParserLocation()

Return the string form of the URL for the jar file that contains whichever JAXP parser implementation is picked up from the user's classpath. If the JAXP parser is not in the user's classpath, then it must be embedded within the JVM (either implicitly or else through use of "endorsed standards" jars), in which case we return null.