Java Doc for Library.java in  » Database-DBMS » hsql » org » hsqldb » Java Source Code / Java DocumentationJava Source Code and Java Documentation

All methods here that have a Connection parameter are dummies and should not be called from user supplied Java procedure or trigger code. Use real SQL functions should be called instead in these instances. Extensively rewritten and extended in successive versions of HSQLDB.
author:
   Thomas Mueller (Hypersonic SQL Group)
version:
   1.8.0
since:
   Hypersonic SQL

The datapart parameter indicates the part to be used for computing the difference.

The given String object must consist of a sequence of 4 digit hexidecimal character substrings.

If its length is not evenly divisible by 4, null is returned.

In some SQL CLI implementations, a null is returned if the range is outside 0..255. In HSQLDB, the corresponding Unicode character is returned unchecked.
Parameters:
  code - the character code for which to return a Stringrepresentation the String representation of the character

When only one string is NULL, the result is different from that returned by an (string1 || string2) expression:

• if both String objects are null, return null
• if only one string is null, return the other
• if both String objects are non-null, return as a String object the character sequence obtained by listing, in left to right order, the characters of the first string followed by the characters of the second

Dummy mehtod.

a date value representing the current date

Dummy mehtod.

a time value representing the current local time

The datapart parameter indicates the part to be used for computing the difference. Supported types include: 'year', 'yy', 'month', 'mm' 'day', 'dd', 'hour', 'hh', 'minute', 'mi', 'second', 'ss', 'millisecond', 'ms'. Contributed by Michael Landon

Parameters:
  datepart - Specifies the unit in which the interval is to be measured.
Parameters:
  d1 - The starting datetime value for the interval. This value issubtracted from d2 to return the number ofdate-parts between the two arguments.
Parameters:
  d2 - The ending datetime for the interval. d1 is subtractedfrom this value to return the number of date-partsbetween the two arguments.since 1.7.3

Parameters:
  conn - the Connection object for which to retrievethe current autocommit status a boolean value representing the connection's autocommit status
since:
   1.7.0

database version number as a String object
since:
   1.8.0.4

the database's major version as an int value
since:
   1.7.2

the database's major version as an int value
since:
   1.7.2

database product name as a String object
since:
   1.7.2

database version number as a String object
since:
   1.7.2

The given String object must consist of a sequence of 4 digit hexidecimal character substrings.

If its length is not evenly divisible by 4, null is returned. If any of its 4 character subsequences cannot be parsed as a 4 digit, base 16 value, then a NumberFormatException is thrown. This conversion has the effect of reducing the character count 4:1.
Parameters:
  s - a String of hexidecimal digit characters an equivalent raw binary value, represented as aString

Dummy mehtod.

the connection's the last generated integer identity value
throws:
  HsqlException - if a database access error occurs

Note: In order of precedence, boundry conditions are handled as follows:

• if either supplied String is null, then the other is returned; the check starts with the first given String.
• if start is less than one, s1 is returned
• if length is less than or equal to zero, s1 is returned
• if the length of s2 is zero, s1 is returned
• if start is greater than the length of s1, s1 is returned
• if length is such that, taken together with start, the indicated interval extends beyond the end of s1, then the insertion is performed precisely as if upon a copy of s1 extended in length to just include the indicated interval

Dummy mehtod.

Parameters:
  conn - the Connection object for which to retrievethe current read-only status true if connection is read-only andfalse otherwise
since:
   1.7.2

Parameters:
  c - the Connection object for which to retrievethe current database read-only status true if so; false otherwise
since:
   1.7.2

Dummy mehtod.

Parameters:
  c - the Connection object for which to retrievethe current database files read-only status true if so; false otherwise
since:
   1.7.2

Note: boundry conditions are handled in the following order of precedence:

• if s is null, then null is returned
• if count is less than 1, then a zero-length String is returned
• if count is greater than the length of s, then a copy of s is returned

Parameters:
  i1 - the numerator
Parameters:
  i2 - the divisor i1 % i2, as an int

The sql_month database property is now obsolete. The function always returns the SQL (1-12) value for month.
Parameters:
  d - the date value from which to extract the month value the month value from the given date value

Dummy mehtod.

a timestamp value representing the current date and time

Parameters:
  search - the String occurence to find in s
Parameters:
  s - the String within which to find the firstoccurence of search the one-based starting position of the first occurrence ofsearch within s, or 0 if not found

Parameters:
  d - the date value from which to extract the quarter of the year an integer representing the quater of the year from the givendate value

This conversion has the effect of expanding the character count 1:4.
Parameters:
  s - the raw binary value, as a String an equivalent String of hexidecimal digit characters

Note: boundry conditions are handled in the following order of precedence:

• if s is null, null is returned
• if count is less than one, a zero-length String is returned
• if count is greater than the length of s, a copy of s is returned

Special handling includes:

• input in the interval -0.0000000000001..0.0000000000001 returns 0.0
• input outside the interval -1000000000000..1000000000000 returns input unchanged
• input is converted to String form
• input with a String form length greater than 16 returns input unchaged
• String form with last four characters of '...000x' where x != '.' is converted to '...0000'
• String form with last four characters of '...9999' is converted to '...999999'
• the java.lang.Double.doubleValue of the String form is returned

This method was rewritten for HSQLDB by fredt@users to comply with the description at http://www.nara.gov/genealogy/coding.html.

Parameters:
  s - the String for which to calculate the 4 characterSOUNDEX value the 4 character SOUNDEX value for the givenString

Parameters:
  count - the number of spaces to produce a String of count spaces

1.) if s is null, return null 2.) If length is less than 1, return null. 3.) If start is 0, it is treated as 1. 4.) If start is positive, count from the beginning of s to find the first character postion. 5.) If start is negative, count backwards from the end of s to find the first character. 6.) If, after applying 2.) or 3.), the start position lies outside s, then return null 7.) if length is ommited or is greated than the number of characters from the start position to the end of s, return the remaineder of s, starting with the start position.
Parameters:
  s - the String from which to produce the indicatedsubstring
Parameters:
  start - the starting position of the desired substring
Parameters:
  length - the length of the desired substring the indicted substring of s.

This method is in support of the standard SQL String function TRIM. Ordinarily, the functionality of this method is accessed from SQL using the following syntax:

 <trim function> ::= TRIM <left paren> <trim operands> <right paren>
 <trim operands> ::= [ [ <trim specification> ] [ <trim character> ] FROM ] <trim source>
 <trim source> ::= <character value expression>
 <trim specification> ::= LEADING | TRAILING | BOTH
 <trim character> ::= <character value expression>
 

Parameters:
  d - the date value from which to extract the week of the year an integer representing the week of the year from the givendate value

Parameters:
  d - the date value from which to extract the year an integer value representing the year from the givendate value