Changeset: 1296dbcc4958 for monetdb-java
URL: https://dev.monetdb.org/hg/monetdb-java?cmd=changeset;node=1296dbcc4958
Modified Files:
src/main/java/nl/cwi/monetdb/client/JdbcClient.java
src/main/java/nl/cwi/monetdb/jdbc/MonetConnection.java
src/main/java/nl/cwi/monetdb/jdbc/MonetDatabaseMetaData.java
src/main/java/nl/cwi/monetdb/jdbc/MonetDriver.java.in
src/main/java/nl/cwi/monetdb/jdbc/MonetPreparedStatement.java
src/main/java/nl/cwi/monetdb/jdbc/MonetResultSet.java
src/main/java/nl/cwi/monetdb/jdbc/MonetStatement.java
src/main/java/nl/cwi/monetdb/jdbc/types/INET.java
src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java
src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java
src/main/java/nl/cwi/monetdb/mcl/net/MapiSocket.java
src/main/java/nl/cwi/monetdb/mcl/parser/HeaderLineParser.java
src/main/java/nl/cwi/monetdb/mcl/parser/StartOfHeaderParser.java
src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java
src/main/java/nl/cwi/monetdb/merovingian/Control.java
src/main/java/nl/cwi/monetdb/merovingian/SabaothDB.java
src/main/java/nl/cwi/monetdb/util/Extract.java
src/main/java/nl/cwi/monetdb/util/SQLExporter.java
src/main/java/nl/cwi/monetdb/util/SQLRestore.java
Branch: default
Log Message:
Resolved javadoc many errors and warnings, such as:
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/HeaderLineParser.java:17:
error: malformed HTML
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/HeaderLineParser.java:17:
error: bad use of '>'
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/StartOfHeaderParser.java:23:
error: malformed HTML
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/StartOfHeaderParser.java:23:
error: bad use of '>'
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java:37:
error: reference not found
[javadoc] * @throws ParseException if an error occurs during parsing
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java:16:
error: malformed HTML
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/parser/TupleLineParser.java:16:
error: bad use of '>'
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java:40:
error: malformed HTML
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java:40:
error: bad use of '>'
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLReader.java:84:
warning: no @throws for java.io.UnsupportedEncodingException
[javadoc] public BufferedMCLReader(InputStream in, String enc)
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java:35:
error: malformed HTML
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java:35:
error: bad use of '>'
[javadoc] * @author Fabian Groffen <Fabian.Groffen>
[javadoc] ^
[javadoc]
/export/scratch1/dinther/javadev/monetdb-java/src/main/java/nl/cwi/monetdb/mcl/io/BufferedMCLWriter.java:59:
warning: no @throws for java.io.UnsupportedEncodingException
[javadoc] public BufferedMCLWriter(OutputStream in, String enc)
[javadoc] ^
diffs (truncated from 1371 to 300 lines):
diff --git a/src/main/java/nl/cwi/monetdb/client/JdbcClient.java
b/src/main/java/nl/cwi/monetdb/client/JdbcClient.java
--- a/src/main/java/nl/cwi/monetdb/client/JdbcClient.java
+++ b/src/main/java/nl/cwi/monetdb/client/JdbcClient.java
@@ -534,6 +534,7 @@ public final class JdbcClient {
*
* @param hasFile a boolean indicating whether a file is used as input
* @param doEcho a boolean indicating whether to echo the given input
+ * @param scolonterm whether a ';' makes this query part complete
* @param user a String representing the username of the current user
* @throws IOException if an IO exception occurs
* @throws SQLException if a database related error occurs
diff --git a/src/main/java/nl/cwi/monetdb/jdbc/MonetConnection.java
b/src/main/java/nl/cwi/monetdb/jdbc/MonetConnection.java
--- a/src/main/java/nl/cwi/monetdb/jdbc/MonetConnection.java
+++ b/src/main/java/nl/cwi/monetdb/jdbc/MonetConnection.java
@@ -17,6 +17,7 @@ import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
+import java.sql.SQLClientInfoException;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.sql.SQLNonTransientConnectionException;
@@ -521,7 +522,7 @@ public class MonetConnection
* @return the holdability, one of
* ResultSet.HOLD_CURSORS_OVER_COMMIT or
* ResultSet.CLOSE_CURSORS_AT_COMMIT
- * @see #setHoldability()
+ * @see #setHoldability(int)
*/
@Override
public int getHoldability() {
@@ -1429,7 +1430,7 @@ public class MonetConnection
* @since 1.6
*/
@Override
- public void setClientInfo(String name, String value) throws
java.sql.SQLClientInfoException {
+ public void setClientInfo(String name, String value) throws
SQLClientInfoException {
if (name == null || name.isEmpty()) {
addWarning("setClientInfo: missing property name",
"01M07");
return;
@@ -1484,7 +1485,7 @@ public class MonetConnection
* @since 1.6
*/
@Override
- public void setClientInfo(Properties props) throws
java.sql.SQLClientInfoException {
+ public void setClientInfo(Properties props) throws
SQLClientInfoException {
if (props != null) {
for (Entry<Object, Object> entry : props.entrySet()) {
setClientInfo(entry.getKey().toString(),
@@ -1641,7 +1642,7 @@ public class MonetConnection
/**
- * Returns the MonetDB JDBC Connection URL (without user name and
password).
+ * @return the MonetDB JDBC Connection URL (without user name and
password).
* Defined as public because it is called from:
MonetDatabaseMetaData.java getURL()
*/
public String getJDBCURL() {
@@ -1652,20 +1653,20 @@ public class MonetConnection
}
/**
- * Returns whether the JDBC BLOB type should be mapped to VARBINARY
type.
+ * @return whether the JDBC BLOB type should be mapped to VARBINARY
type.
* This allows generic JDBC programs to fetch Blob data via getBytes()
* instead of getBlob() and Blob.getBinaryStream() to reduce overhead.
*/
- boolean mapBlobAsVarBinary() {
+ public boolean mapBlobAsVarBinary() {
return treatBlobAsVarBinary;
}
/**
- * Returns whether the JDBC CLOB type should be mapped to VARCHAR type.
+ * @return whether the JDBC CLOB type should be mapped to VARCHAR type.
* This allows generic JDBC programs to fetch Clob data via getString()
* instead of getClob() and Clob.getCharacterStream() to reduce
overhead.
*/
- boolean mapClobAsVarChar() {
+ public boolean mapClobAsVarChar() {
return treatClobAsVarChar;
}
diff --git a/src/main/java/nl/cwi/monetdb/jdbc/MonetDatabaseMetaData.java
b/src/main/java/nl/cwi/monetdb/jdbc/MonetDatabaseMetaData.java
--- a/src/main/java/nl/cwi/monetdb/jdbc/MonetDatabaseMetaData.java
+++ b/src/main/java/nl/cwi/monetdb/jdbc/MonetDatabaseMetaData.java
@@ -540,12 +540,12 @@ public class MonetDatabaseMetaData exten
/**
* Get all the "extra" characters that can be used in unquoted
* identifier names (those beyond a-zA-Z0-9 and _)
- * MonetDB has no extra characters (verified it for chars:
!@#$%^&*()~{}[]?
*
* @return a string containing the extra characters
*/
@Override
public String getExtraNameCharacters() {
+ // MonetDB has no extra characters. Verified it for chars:
!@#$%^&*()~{}[]?
return "";
}
@@ -1633,7 +1633,7 @@ public class MonetDatabaseMetaData exten
* Does a data definition statement within a transaction force
* the transaction to commit? I think this means something like:
*
- * <p><pre>
+ * <pre>
* CREATE TABLE T (A INT);
* INSERT INTO T (A) VALUES (2);
* BEGIN;
@@ -1641,7 +1641,7 @@ public class MonetDatabaseMetaData exten
* CREATE TABLE X (A INT);
* SELECT A FROM T INTO X;
* COMMIT;
- * </pre></p>
+ * </pre>
*
* does the CREATE TABLE call cause a commit? The answer is no.
*
@@ -1671,21 +1671,21 @@ public class MonetDatabaseMetaData exten
*
* <p>Each procedure description has the following columns:
* <ol>
- * <li><b>PROCEDURE_CAT</b> String => procedure catalog (may be null)
- * <li><b>PROCEDURE_SCHEM</b> String => procedure schema (may be null)
- * <li><b>PROCEDURE_NAME</b> String => procedure name
+ * <li><b>PROCEDURE_CAT</b> String => procedure catalog (may be null)
+ * <li><b>PROCEDURE_SCHEM</b> String => procedure schema (may be
null)
+ * <li><b>PROCEDURE_NAME</b> String => procedure name
* <li><b>Field4</b> reserved (make it null)
* <li><b>Field5</b> reserved (make it null)
* <li><b>Field6</b> reserved (make it null)
- * <li><b>REMARKS</b> String => explanatory comment on the procedure
- * <li><b>PROCEDURE_TYPE</b> short => kind of procedure
+ * <li><b>REMARKS</b> String => explanatory comment on the procedure
+ * <li><b>PROCEDURE_TYPE</b> short => kind of procedure
* <ul>
* <li> procedureResultUnknown - May return a result
* <li> procedureNoResult - Does not return a result
* <li> procedureReturnsResult - Returns a result
* </ul>
+ * <li><b>SPECIFIC_NAME</b> String => The name which uniquely
identifies this procedure within its schema.
* </ol>
- * <li><b>SPECIFIC_NAME</b> String => The name which uniquely
identifies this procedure within its schema.
*
* @param catalog - a catalog name; must match the catalog name as it
is stored in the database;
* "" retrieves those without a catalog;
@@ -1750,11 +1750,11 @@ public class MonetDatabaseMetaData exten
* <p>Each row in the ResultSet is a parameter description or column
* description with the following fields:
* <ol>
- * <li><b>PROCEDURE_CAT</b> String => procedure catalog (may be null)
- * <li><b>PROCEDURE_SCHEM</b> String => procedure schema (may be null)
- * <li><b>PROCEDURE_NAME</b> String => procedure name
- * <li><b>COLUMN_NAME</b> String => column/parameter name
- * <li><b>COLUMN_TYPE</b> Short => kind of column/parameter:
+ * <li><b>PROCEDURE_CAT</b> String => procedure catalog (may be null)
+ * <li><b>PROCEDURE_SCHEM</b> String => procedure schema (may be
null)
+ * <li><b>PROCEDURE_NAME</b> String => procedure name
+ * <li><b>COLUMN_NAME</b> String => column/parameter name
+ * <li><b>COLUMN_TYPE</b> Short => kind of column/parameter:
* <ul><li>procedureColumnUnknown - nobody knows
* <li>procedureColumnIn - IN parameter
* <li>procedureColumnInOut - INOUT parameter
@@ -1762,34 +1762,34 @@ public class MonetDatabaseMetaData exten
* <li>procedureColumnReturn - procedure return value
* <li>procedureColumnResult - result column in ResultSet
* </ul>
- * <li><b>DATA_TYPE</b> int => SQL type from java.sql.Types
- * <li><b>TYPE_NAME</b> String => SQL type name, for a UDT type the
type name is fully qualified
- * <li><b>PRECISION</b> int => precision
- * <li><b>LENGTH</b> int => length in bytes of data
- * <li><b>SCALE</b> short => scale - null is returned for data types
where SCALE is not applicable.
- * <li><b>RADIX</b> short => radix
- * <li><b>NULLABLE</b> short => can it contain NULL?
+ * <li><b>DATA_TYPE</b> int => SQL type from java.sql.Types
+ * <li><b>TYPE_NAME</b> String => SQL type name, for a UDT type the
type name is fully qualified
+ * <li><b>PRECISION</b> int => precision
+ * <li><b>LENGTH</b> int => length in bytes of data
+ * <li><b>SCALE</b> short => scale - null is returned for data types
where SCALE is not applicable.
+ * <li><b>RADIX</b> short => radix
+ * <li><b>NULLABLE</b> short => can it contain NULL?
* <ul><li>procedureNoNulls - does not allow NULL values
* <li>procedureNullable - allows NULL values
* <li>procedureNullableUnknown - nullability unknown
* </ul>
- * <li><b>REMARKS</b> String => comment describing parameter/column
- * <li><b>COLUMN_DEF</b> String => default value for the column, which
should be interpreted as a string when the value is enclosed in single quotes
(may be null)
+ * <li><b>REMARKS</b> String => comment describing parameter/column
+ * <li><b>COLUMN_DEF</b> String => default value for the column,
which should be interpreted as a string when the value is enclosed in single
quotes (may be null)
* The string NULL (not enclosed in quotes) - if NULL was
specified as the default value
* TRUNCATE (not enclosed in quotes) - if the specified default
value cannot be represented without truncation
* NULL - if a default value was not specified
- * <li><b>SQL_DATA_TYPE</b> int => reserved for future use
- * <li><b>SQL_DATETIME_SUB</b> int => reserved for future use
- * <li><b>CHAR_OCTET_LENGTH</b> int => the maximum length of binary and
character based columns. For any other datatype the returned value is a NULL
- * <li><b>ORDINAL_POSITION</b> int => the ordinal position, starting
from 1, for the input and output parameters for a procedure.
+ * <li><b>SQL_DATA_TYPE</b> int => reserved for future use
+ * <li><b>SQL_DATETIME_SUB</b> int => reserved for future use
+ * <li><b>CHAR_OCTET_LENGTH</b> int => the maximum length of binary
and character based columns. For any other datatype the returned value is a NULL
+ * <li><b>ORDINAL_POSITION</b> int => the ordinal position, starting
from 1, for the input and output parameters for a procedure.
* A value of 0 is returned if this row describes the procedure's
return value. For result set columns, it is the ordinal position of the
* column in the result set starting from 1. If there are multiple
result sets, the column ordinal positions are implementation defined.
- * <li><b>IS_NULLABLE</b> String => ISO rules are used to determine the
nullability for a column.
+ * <li><b>IS_NULLABLE</b> String => ISO rules are used to determine
the nullability for a column.
* <ul><li>YES --- if the parameter can include NULLs
* <li>NO --- if the parameter cannot include NULLs
* <li>empty string --- if the nullability for the parameter is unknown
* </ul>
- * <li><b>SPECIFIC_NAME</b> String => the name which uniquely
identifies this procedure within its schema.
+ * <li><b>SPECIFIC_NAME</b> String => the name which uniquely
identifies this procedure within its schema.
* </ol>
* @param catalog - a catalog name; must match the catalog name as it
is stored in the database;
* "" retrieves those without a catalog;
@@ -1909,17 +1909,17 @@ public class MonetDatabaseMetaData exten
* <p>Each table description has the following columns:
*
* <ol>
- * <li><b>TABLE_CAT</b> String => table catalog (may be null)
- * <li><b>TABLE_SCHEM</b> String => table schema (may be null)
- * <li><b>TABLE_NAME</b> String => table name
- * <li><b>TABLE_TYPE</b> String => table type. Typical types are
"TABLE",
+ * <li><b>TABLE_CAT</b> String => table catalog (may be null)
+ * <li><b>TABLE_SCHEM</b> String => table schema (may be null)
+ * <li><b>TABLE_NAME</b> String => table name
+ * <li><b>TABLE_TYPE</b> String => table type. Typical types are
"TABLE",
* "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY",
"ALIAS", "SYNONYM".
- * <li><b>REMARKS</b> String => explanatory comment on the table
- * <li><b>TYPE_CAT</b> String => the types catalog (may be null)
- * <li><b>TYPE_SCHEM</b> String => the types schema (may be null)
- * <li><b>TYPE_NAME</b> String => type name (may be null)
- * <li><b>SELF_REFERENCING_COL_NAME</b> String => name of the
designated "identifier" column of a typed table (may be null)
- * <li><b>REF_GENERATION</b> String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED".
(may be null)
+ * <li><b>REMARKS</b> String => explanatory comment on the table
+ * <li><b>TYPE_CAT</b> String => the types catalog (may be null)
+ * <li><b>TYPE_SCHEM</b> String => the types schema (may be null)
+ * <li><b>TYPE_NAME</b> String => type name (may be null)
+ * <li><b>SELF_REFERENCING_COL_NAME</b> String => name of the
designated "identifier" column of a typed table (may be null)
+ * <li><b>REF_GENERATION</b> String => specifies how values in
SELF_REFERENCING_COL_NAME are created. Values are "SYSTEM", "USER", "DERIVED".
(may be null)
* </ol>
*
* @param catalog - a catalog name; must match the catalog name as it
is stored in the database;
@@ -2023,8 +2023,8 @@ public class MonetDatabaseMetaData exten
*
* <P>The schema column is:
* <OL>
- * <LI><B>TABLE_SCHEM</B> String => schema name
- * <LI><B>TABLE_CATALOG</B> String => catalog name (may be null)
+ * <LI><B>TABLE_SCHEM</B> String => schema name
+ * <LI><B>TABLE_CATALOG</B> String => catalog name (may be null)
* </OL>
*
* @param catalog a catalog name; must match the catalog name as it
@@ -2067,7 +2067,7 @@ public class MonetDatabaseMetaData exten
*
* <P>The catalog column is:
* <OL>
- * <LI><B>TABLE_CAT</B> String => catalog name
+ * <LI><B>TABLE_CAT</B> String => catalog name
* </OL>
*
*
@@ -2088,7 +2088,7 @@ public class MonetDatabaseMetaData exten
*
* <P>The table type is:
* <OL>
- * <LI><B>TABLE_TYPE</B> String => table type. Typical types are
"TABLE",
+ * <LI><B>TABLE_TYPE</B> String => table type. Typical types
are "TABLE",
* "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY",
* "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
* </OL>
@@ -2126,46 +2126,46 @@ public class MonetDatabaseMetaData exten
*
* <P>Each column description has the following columns:
* <OL>
- * <LI><B>TABLE_CAT</B> String => table catalog (may be null)
- * <LI><B>TABLE_SCHEM</B> String => table schema (may be null)
- * <LI><B>TABLE_NAME</B> String => table name
- * <LI><B>COLUMN_NAME</B> String => column name
- * <LI><B>DATA_TYPE</B> int => SQL type from java.sql.Types
- * <LI><B>TYPE_NAME</B> String => Data source dependent type name
- * <LI><B>COLUMN_SIZE</B> int => column size. For char or date
+ * <LI><B>TABLE_CAT</B> String => table catalog (may be null)
+ * <LI><B>TABLE_SCHEM</B> String => table schema (may be null)
+ * <LI><B>TABLE_NAME</B> String => table name
+ * <LI><B>COLUMN_NAME</B> String => column name
+ * <LI><B>DATA_TYPE</B> int => SQL type from java.sql.Types
+ * <LI><B>TYPE_NAME</B> String => Data source dependent type
name
+ * <LI><B>COLUMN_SIZE</B> int => column size. For char or date
* types this is the maximum number of characters, for
numeric or
* decimal types this is precision.
* <LI><B>BUFFER_LENGTH</B> is not used.
- * <LI><B>DECIMAL_DIGITS</B> int => the number of fractional digits
- * <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10 or
2)
- * <LI><B>NULLABLE</B> int => is NULL allowed?
+ * <LI><B>DECIMAL_DIGITS</B> int => the number of fractional
digits
+ * <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10
or 2)
+ * <LI><B>NULLABLE</B> int => is NULL allowed?
* <UL>
* <LI> columnNoNulls - might not allow NULL values
* <LI> columnNullable - definitely allows NULL values
_______________________________________________
checkin-list mailing list
checkin-list@monetdb.org
https://www.monetdb.org/mailman/listinfo/checkin-list
