DBString (DBvolution 7 0.9.13-SNAPSHOT API)

java.lang.Object
- nz.co.gregs.dbvolution.datatypes.QueryableDatatype<String>
- - nz.co.gregs.dbvolution.datatypes.DBString

All Implemented Interfaces:

Serializable, DBExpression, AnyResult<String>, EqualResult<String>, ExpressionCanHaveNullValues, ExpressionHasStandardStringResult, InResult<String>, RangeResult<String>, StringResult

Direct Known Subclasses:

DBStatistics, DBStringTrimmed
```
public class DBString
extends QueryableDatatype<String>
implements StringResult
```
Encapsulates database values that are strings of characters.
Use DBString when the column is a char, varchar, or nvarchar datatype.
Generally DBString is declared inside your DBRow sub-class as: @DBColumn public DBString myCharColumn = new DBString();
If the string column encodes repeating information like a status code, use DBStringEnum to encapsulate the values.
Support DBvolution at Patreon

Author:

Gregory Graham

See Also:
Serialized Form

Field Summary
- Fields inherited from class nz.co.gregs.dbvolution.datatypes.QueryableDatatype
  SORT_ASCENDING, SORT_DESCENDING

Constructor Summary

Constructors
Constructor and Description
`DBString()` The default constructor for DBString.
`DBString(String string)` Creates a DBString with the value provided.
`DBString(StringExpression stringExpression)` Creates a column expression with a string result from the expression provided.

Method Summary

Methods
Modifier and Type	Method and Description
`DBString`	`copy()` Copies a QueryableDatatype and returns the copy.
`void`	`excludedPattern(String pattern)` Perform searches based on using database compatible pattern matching
`void`	`excludedPattern(StringExpression pattern)` Perform searches based on using database compatible pattern matching
`void`	`excludedRange(StringExpression lowerBound, StringExpression upperBound)` Performs searches based on a range.
`void`	`excludedRange(String lowerBound, String upperBound)` Performs searches based on a range.
`void`	`excludedRangeExclusive(StringExpression lowerBound, StringExpression upperBound)` Performs searches based on a range.
`void`	`excludedRangeExclusive(String lowerBound, String upperBound)` Performs searches based on a range.
`void`	`excludedRangeInclusive(StringExpression lowerBound, StringExpression upperBound)` Performs searches based on a range.
`void`	`excludedRangeInclusive(String lowerBound, String upperBound)` Performs searches based on a range.
`void`	`excludedValues(Collection<String> excluded)` excludes the object, Set, List, Array, or vararg of objects
`void`	`excludedValues(String... excluded)` excludes the object, Set, List, Array, or vararg of objects
`void`	`excludedValues(StringExpression... excluded)` excludes the object, Set, List, Array, or vararg of objects
`void`	`excludedValuesIgnoreCase(Collection<String> excluded)` Reduces the rows to excluding the object, Set, List, Array, or vararg of Strings ignoring letter case.
`void`	`excludedValuesIgnoreCase(String... excluded)` Reduces the rows to excluding the object, Set, List, Array, or vararg of Strings ignoring letter case.
`void`	`excludedValuesIgnoreCase(StringExpression... excluded)` Reduces the rows to excluding the object, Set, List, Array, or vararg of Strings ignoring letter case.
`String`	`formatValueForSQLStatement(DBDefinition defn)` Returns the value of the object formatted for the database This should be overridden in each subclass This method is called by toSQLString after checking for NULLs and should return a string representation of the object formatted for use within a SQL select, insert, update, or delete statement.
`StringColumn`	`getColumn(RowDefinition row)` Creates a Column Provider suitable to this QDT.
`protected String`	`getFromResultSet(DBDefinition database, ResultSet resultSet, String fullColumnName)` Returns the correct object from the ResultSet for the QueryableDatatype to handle.
`boolean`	`getIncludesNull()` Returns TRUE if this expression requires support for possible NULL database values.
`DBString`	`getQueryableDatatypeForExpressionValue()` Provides a blank instance of the `QueryableDatatype` used by this expression.
`String`	`getSQLDatatype()` Provides the SQL datatype used by default for this type of object.
`Set<DBRow>`	`getTablesInvolved()` Returns a Set of the DBRow instances involved in this expression.
`String`	`getValue()` Gets the current literal value of this queryable data type.
`boolean`	`isAggregator()` Returns TRUE if this expression is an Aggregator like SUM() or LEAST().
`boolean`	`isEmptyOrNullString()` Returns TRUE if the database value is the empty string or NULL Support DBvolution at Patreon
`boolean`	`isEmptyString()` Indicates whether this DBString value is the SQL equivalent of a java empty String.
`void`	`permittedPattern(String pattern)` Perform searches based on using database compatible pattern matching
`void`	`permittedPattern(StringExpression pattern)` Perform searches based on using database compatible pattern matching
`void`	`permittedPatternIgnoreCase(String pattern)` Perform case-insensitive searches based on using database compatible pattern matching.
`void`	`permittedRange(StringExpression lowerBound, StringExpression upperBound)` Performs searches based on a range.
`void`	`permittedRange(String lowerBound, String upperBound)` Performs searches based on a range.
`void`	`permittedRangeExclusive(StringExpression lowerBound, StringExpression upperBound)` Performs searches based on a range.
`void`	`permittedRangeExclusive(String lowerBound, String upperBound)` Performs searches based on a range.
`void`	`permittedRangeInclusive(StringExpression lowerBound, StringExpression upperBound)` Performs searches based on a range.
`void`	`permittedRangeInclusive(String lowerBound, String upperBound)` Performs searches based on a range.
`void`	`permittedValues(Collection<String> permitted)` reduces the rows to only the object, Set, List, Array, or vararg of objects
`void`	`permittedValues(Object... permitted)` reduces the rows to only the object, Set, List, Array, or vararg of objects
`void`	`permittedValues(String... permitted)` reduces the rows to only the object, Set, List, Array, or vararg of objects
`void`	`permittedValues(StringExpression... permitted)` reduces the rows to only the object, Set, List, Array, or vararg of objects
`void`	`permittedValuesIgnoreCase(List<String> permitted)` reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
`void`	`permittedValuesIgnoreCase(Set<String> permitted)` reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
`void`	`permittedValuesIgnoreCase(String... permitted)` reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
`void`	`permittedValuesIgnoreCase(StringExpression... permitted)` reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
`protected DBOperator`	`setToNull(DBDefinition database)` Used during setFromResultSet to set the QDT to a database NULL value.
`void`	`setValue(String str)` Sets the value of this DBString to the value provided.
`protected void`	`setValueFromStandardStringEncoding(String encodedValue)` Set the value of this QDT to the value provided from the standard string encoding of this datatype
`StringExpression`	`stringResult()` Converts the expression into the standard string/character expression representing the value.
`static List<String>`	`toStringList(List<DBString> dbStrings)` Utility function to return the values of a list of DBStrings in a list of Strings.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nz.co.gregs.dbvolution.expressions.DBExpression
createSQLForFromClause, isComplexExpression, isPurelyFunctional, toSQLString

- Constructor Detail
  - DBString
```
public DBString()
```
    The default constructor for DBString.
    Creates an unset undefined DBString object.
  - DBString
```
public DBString(String string)
```
    Creates a DBString with the value provided.
    The resulting DBString will be set as having the value provided but will not be defined in the database.
    
    Parameters:
    string - string
  - DBString
```
public DBString(StringExpression stringExpression)
```
    Creates a column expression with a string result from the expression provided.
    Used in DBReport, and some DBRow, sub-classes to derive data from the database prior to retrieval.
    
    Parameters:
    stringExpression - stringExpression
- Method Detail
  - toStringList
```
public static List<String> toStringList(List<DBString> dbStrings)
```
    Utility function to return the values of a list of DBStrings in a list of Strings.
    
    Parameters:
    dbStrings - dbStrings
    Support DBvolution at Patreon
    
    Returns:
    the defined values of all the DBStrings.
  - setValue
```
public void setValue(String str)
```
    Sets the value of this DBString to the value provided.
    
    Parameters:
    str - str
  - getValue
```
public String getValue()
```
    Description copied from class: QueryableDatatype
    
    Gets the current literal value of this queryable data type. The returned value should be in the correct type as appropriate for the type of queryable data type.
    This method will return NULL if the QDT represents a database NULL OR the field is undefined. Use QueryableDatatype.isNull() and QueryableDatatype.isDefined() to differentiate the 2 states.
    Undefined QDTs represents a QDT that is not a field from the database. Undefined QDTs are similar to undefined DBRows
    Support DBvolution at Patreon
    
    Overrides:
    
    getValue in class QueryableDatatype<String>
    
    Returns:
    the literal value, if defined, which may be null
  - getSQLDatatype
```
public String getSQLDatatype()
```
    Description copied from class: QueryableDatatype
    
    Provides the SQL datatype used by default for this type of object.
    This should be overridden in each subclass
    
    Example return value: "VARCHAR(1000)"
    
    Database specific datatypes are provided by the DBDefinition in the method DBDefinition.getDatabaseDataTypeOfQueryableDatatype(nz.co.gregs.dbvolution.datatypes.QueryableDatatype<?>)
    
    Support DBvolution at Patreon
    
    Specified by:
    
    getSQLDatatype in class QueryableDatatype<String>
    
    Returns:
    the standard SQL datatype that corresponds to this QDT as a String
  - formatValueForSQLStatement
```
public String formatValueForSQLStatement(DBDefinition defn)
```
    Description copied from class: QueryableDatatype
    
    Returns the value of the object formatted for the database This should be overridden in each subclass This method is called by toSQLString after checking for NULLs and should return a string representation of the object formatted for use within a SQL select, insert, update, or delete statement. For Example: DBString{yada} => 'yada' DBInteger{1234} => 123 DBDate{1/March/2013} => TO_DATE('20130301', 'YYYYMMDD')
    
    Specified by:
    
    formatValueForSQLStatement in class QueryableDatatype<String>
    
    Parameters:
    defn - db
    Support DBvolution at Patreon
    
    Returns:
    the literal value translated to a String ready to insert into an SQL statement
  - copy
```
public DBString copy()
```
    Description copied from class: QueryableDatatype
    
    Copies a QueryableDatatype and returns the copy. Used internally to provide immutability to DBOperator objects. The intention is that this method will provide a snapshot of the QDT at this moment in time and copy or clone any internal objects that might change. Subclasses should extend this method if they have fields that maintain the state of the QDT. Always use the super.copy() method first when overriding this method.
    Support DBvolution at Patreon
    
    Specified by:
    
    copy in interface DBExpression
    
    Specified by:
    
    copy in interface StringResult
    
    Overrides:
    
    copy in class QueryableDatatype<String>
    
    Returns:
    a complete copy of the QDT with all values set.
  - getQueryableDatatypeForExpressionValue
```
public DBString getQueryableDatatypeForExpressionValue()
```
    Description copied from interface: DBExpression
    
    Provides a blank instance of the QueryableDatatype used by this expression.
    You are probably looking for ExpressionColumn.asExpressionColumn().
    Note that this method is not good for use in everyday DBvolution code and should probably be reserved for meta-programming.
    Support DBvolution at Patreon
    
    Specified by:
    
    getQueryableDatatypeForExpressionValue in interface DBExpression
    
    Overrides:
    
    getQueryableDatatypeForExpressionValue in class QueryableDatatype<String>
    
    Returns:
    the QueryableDatatype subclass that corresponds to the results of this expression
  - isAggregator
```
public boolean isAggregator()
```
    Description copied from interface: DBExpression
    
    Returns TRUE if this expression is an Aggregator like SUM() or LEAST().
    Subclasses must implement this method returning TRUE if the expression will combine the results of several rows to produce a result. If the expression relies on subexpressions, then the isAggregator method must return TRUE if the subexpressions include an aggregator.
    Aggregators collect several rows together to produce a single result. Examples are MAX, MIN, and AVERAGE.
    They are only appropriate in the SELECT clause and generally require the GROUP BY clause to be useful.
    Aggregators are used with DBReport. Aggregator expressions are included in the SELECT clause but excluded from the GROUP BY clause.
    Support DBvolution at Patreon
    
    Specified by:
    
    isAggregator in interface DBExpression
    
    Returns:
    TRUE if this DBExpression represents an aggregating functions
  - getTablesInvolved
```
public Set<DBRow> getTablesInvolved()
```
    Description copied from interface: DBExpression
    
    Returns a Set of the DBRow instances involved in this expression.
    Used by QueryGraph to plot the connections between tables and avoid cartesian joins.
    Support DBvolution at Patreon
    
    Specified by:
    
    getTablesInvolved in interface DBExpression
    
    Overrides:
    
    getTablesInvolved in class QueryableDatatype<String>
    
    Returns:
    a set of DBRow instances involved in this DBExpression.
  - permittedValues
```
public void permittedValues(String... permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of objects
    
    Parameters:
    permitted - permitted
  - permittedValues
```
public void permittedValues(Object... permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of objects
    
    Parameters:
    permitted - permitted
  - permittedValues
```
public void permittedValues(Collection<String> permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of objects
    
    Parameters:
    permitted - permitted
  - permittedValuesIgnoreCase
```
public void permittedValuesIgnoreCase(String... permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    permitted - permitted
  - permittedValuesIgnoreCase
```
public void permittedValuesIgnoreCase(StringExpression... permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    permitted - permitted
  - permittedValuesIgnoreCase
```
public void permittedValuesIgnoreCase(List<String> permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    permitted - permitted
  - permittedValuesIgnoreCase
```
public void permittedValuesIgnoreCase(Set<String> permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    permitted - permitted
  - excludedValuesIgnoreCase
```
public void excludedValuesIgnoreCase(String... excluded)
```
    Reduces the rows to excluding the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    excluded - excluded
  - excludedValuesIgnoreCase
```
public void excludedValuesIgnoreCase(StringExpression... excluded)
```
    Reduces the rows to excluding the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    excluded - excluded
  - excludedValuesIgnoreCase
```
public void excludedValuesIgnoreCase(Collection<String> excluded)
```
    Reduces the rows to excluding the object, Set, List, Array, or vararg of Strings ignoring letter case.
    
    Parameters:
    excluded - excluded
  - excludedValues
```
public void excludedValues(String... excluded)
```
    excludes the object, Set, List, Array, or vararg of objects
    
    Parameters:
    excluded - excluded
  - excludedValues
```
public void excludedValues(Collection<String> excluded)
```
    excludes the object, Set, List, Array, or vararg of objects
    
    Parameters:
    excluded - excluded
  - permittedRange
```
public void permittedRange(String lowerBound,
                  String upperBound)
```
    Performs searches based on a range. if both ends of the range are specified the lower-bound will be included in the search and the upper-bound excluded. I.e permittedRange(1,3) will return 1 and 2.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e permittedRange(1,null) will return 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e permittedRange(null, 5) will return 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - permittedRangeInclusive
```
public void permittedRangeInclusive(String lowerBound,
                           String upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be included in the search. I.e permittedRangeInclusive(1,3) will return 1, 2, and 3.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e permittedRangeInclusive(1,null) will return 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e permittedRangeInclusive(null, 5) will return 5,4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - permittedRangeExclusive
```
public void permittedRangeExclusive(String lowerBound,
                           String upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be excluded in the search. I.e permittedRangeExclusive(1,3) will return 2.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e permittedRangeExclusive(1,null) will return 2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e permittedRangeExclusive(null, 5) will return 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - excludedRange
```
public void excludedRange(String lowerBound,
                 String upperBound)
```
    Performs searches based on a range. if both ends of the range are specified the lower-bound will be included within the range and the upper-bound excluded. I.e excludedRange(1,3) will exclude 1 and 2.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e excludedRange(1,null) will exclude 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e excludedRange(null, 5) will exclude 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - excludedRangeInclusive
```
public void excludedRangeInclusive(String lowerBound,
                          String upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be included within the range. I.e excludedRangeInclusive(1,3) will exclude 1, 2, and 3.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e excludedRangeInclusive(1,null) will exclude 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e excludedRangeInclusive(null, 5) will exclude 5,4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - excludedRangeExclusive
```
public void excludedRangeExclusive(String lowerBound,
                          String upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be excluded from the range. I.e excludedRangeExclusive(1,3) will exclude 2.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e excludedRangeExclusive(1,null) will exclude 2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e excludedRangeExclusive(null, 5) will exclude 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - permittedPattern
```
public void permittedPattern(String pattern)
```
    Perform searches based on using database compatible pattern matching
    This facilitates the LIKE operator.
    Please use the pattern system appropriate to your database.
    Java-style regular expressions are not yet supported.
    
    Parameters:
    pattern - pattern
  - excludedPattern
```
public void excludedPattern(String pattern)
```
    Perform searches based on using database compatible pattern matching
    This facilitates the LIKE operator.
    Please use the pattern system appropriate to your database.
    Java-style regular expressions are not yet supported.
    
    Parameters:
    pattern - pattern
  - permittedPattern
```
public void permittedPattern(StringExpression pattern)
```
    Perform searches based on using database compatible pattern matching
    This facilitates the LIKE operator.
    Please use the pattern system appropriate to your database.
    Java-style regular expressions are not yet supported.
    
    Parameters:
    pattern - pattern
  - excludedPattern
```
public void excludedPattern(StringExpression pattern)
```
    Perform searches based on using database compatible pattern matching
    This facilitates the LIKE operator.
    Please use the pattern system appropriate to your database.
    Java-style regular expressions are not yet supported.
    
    Parameters:
    pattern - pattern
  - permittedValues
```
public void permittedValues(StringExpression... permitted)
```
    reduces the rows to only the object, Set, List, Array, or vararg of objects
    
    Parameters:
    permitted - permitted
  - excludedValues
```
public void excludedValues(StringExpression... excluded)
```
    excludes the object, Set, List, Array, or vararg of objects
    
    Parameters:
    excluded - excluded
  - permittedRange
```
public void permittedRange(StringExpression lowerBound,
                  StringExpression upperBound)
```
    Performs searches based on a range. if both ends of the range are specified the lower-bound will be included in the search and the upper-bound excluded. I.e permittedRange(1,3) will return 1 and 2.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e permittedRange(1,null) will return 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e permittedRange(null, 5) will return 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - permittedRangeInclusive
```
public void permittedRangeInclusive(StringExpression lowerBound,
                           StringExpression upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be included in the search. I.e permittedRangeInclusive(1,3) will return 1, 2, and 3.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e permittedRangeInclusive(1,null) will return 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e permittedRangeInclusive(null, 5) will return 5,4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - permittedRangeExclusive
```
public void permittedRangeExclusive(StringExpression lowerBound,
                           StringExpression upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be excluded in the search. I.e permittedRangeExclusive(1,3) will return 2.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e permittedRangeExclusive(1,null) will return 2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e permittedRangeExclusive(null, 5) will return 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - excludedRange
```
public void excludedRange(StringExpression lowerBound,
                 StringExpression upperBound)
```
    Performs searches based on a range. if both ends of the range are specified the lower-bound will be included in the search and the upper-bound excluded from the range. I.e excludedRange(1,3) will exclude 1 and 2.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e excludedRange(1,null) will exclude 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e excludedRange(null, 5) will exclude 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - excludedRangeInclusive
```
public void excludedRangeInclusive(StringExpression lowerBound,
                          StringExpression upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be included in the range. I.e excludedRangeInclusive(1,3) will exclude 1, 2, and 3.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e excludedRangeInclusive(1,null) will exclude 1,2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and inclusive.
    I.e excludedRangeInclusive(null, 5) will exclude 5,4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - excludedRangeExclusive
```
public void excludedRangeExclusive(StringExpression lowerBound,
                          StringExpression upperBound)
```
    Performs searches based on a range. if both ends of the range are specified both the lower- and upper-bound will be excluded in the range. I.e excludedRangeExclusive(1,3) will exclude 2.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e excludedRangeExclusive(1,null) will exclude 2,3,4,5, etc.
    if the upper-bound is null the range will be open ended and exclusive.
    I.e excludedRangeExclusive(null, 5) will exclude 4,3,2,1, etc.
    
    Parameters:
    lowerBound - lowerBound
    upperBound - upperBound
  - getIncludesNull
```
public boolean getIncludesNull()
```
    Description copied from interface: ExpressionCanHaveNullValues
    
    Returns TRUE if this expression requires support for possible NULL database values.
    Support DBvolution at Patreon
    
    Specified by:
    
    getIncludesNull in interface ExpressionCanHaveNullValues
    
    Returns:
    TRUE if the expression should check for NULLs, FALSE otherwise.
  - isEmptyString
```
public boolean isEmptyString()
```
    Indicates whether this DBString value is the SQL equivalent of a java empty String.
    Some databases, notably Oracle, cannot differentiate between empty strings and NULL strings. This method helps programmers access the empty or NULL states will allowing DBV to provide a consistent interface.
    In Oracle and similar databases isDBNull and isEmptyString will both be TRUE when the value is NULL. However most databases will have isEmptyString false when the string is null, and isDBNull false when the string is empty.
    Support DBvolution at Patreon
    
    Returns:
    true if the database value represents an empty string, otherwise FALSE.
  - getFromResultSet
```
protected String getFromResultSet(DBDefinition database,
                      ResultSet resultSet,
                      String fullColumnName)
                           throws SQLException
```
    Description copied from class: QueryableDatatype
    
    Returns the correct object from the ResultSet for the QueryableDatatype to handle.
    
    Specified by:
    
    getFromResultSet in class QueryableDatatype<String>
    
    Parameters:
    database - database
    resultSet - resultSet
    fullColumnName - fullColumnName
    Support DBvolution at Patreon
    
    Returns:
    the expected object from the ResultSet. 1 Database exceptions may be thrown
    
    Throws:
    
    SQLException - java.sql.SQLException
  - permittedPatternIgnoreCase
```
public void permittedPatternIgnoreCase(String pattern)
```
    Perform case-insensitive searches based on using database compatible pattern matching.
    This facilitates the LIKE operator.
    Please use the pattern system appropriate to your database.
    Java-style regular expressions are not yet supported.
    
    Parameters:
    pattern - pattern
  - setToNull
```
protected DBOperator setToNull(DBDefinition database)
```
    Description copied from class: QueryableDatatype
    
    Used during setFromResultSet to set the QDT to a database NULL value.
    DBDatabase is supplied so that database-specific processing, such as Oracle empty strings, can be performed.
    Sets the value of this column to DBNull Also changes the operator to DBIsNullOperator for comparisons.
    The default implementation just calls QueryableDatatype.setToNull()
    
    Overrides:
    
    setToNull in class QueryableDatatype<String>
    
    Parameters:
    database - database
    Support DBvolution at Patreon
    
    Returns:
    the DBOperator that will be used with this QDT
  - isEmptyOrNullString
```
public boolean isEmptyOrNullString()
```
    Returns TRUE if the database value is the empty string or NULL
    Support DBvolution at Patreon
    
    Returns:
    TRUE if the database value is "" or NULL, otherwise FALSE.
  - setValueFromStandardStringEncoding
```
protected void setValueFromStandardStringEncoding(String encodedValue)
```
    Description copied from class: QueryableDatatype
    
    Set the value of this QDT to the value provided from the standard string encoding of this datatype
    Subclass writers should ensure that the method handles nulls correctly and throws an exception if an inappropriate value is supplied.
    
    Specified by:
    
    setValueFromStandardStringEncoding in class QueryableDatatype<String>
    
    Parameters:
    encodedValue - the value of the QDT in the appropriate encoding
  - getColumn
```
public StringColumn getColumn(RowDefinition row)
                       throws IncorrectRowProviderInstanceSuppliedException
```
    Description copied from class: QueryableDatatype
    
    Creates a Column Provider suitable to this QDT.
    Creates a ColumnProvider object of the correct type for this QueryableDatatype, using this object and the provided row.
    
    Used internally to maintain the relationship between QDTs and their ColumnProvider equivalents.
    
    Specified by:
    
    getColumn in class QueryableDatatype<String>
    
    Returns:
    a column object appropriate to this datatype based on the object and the row
    
    Throws:
    
    IncorrectRowProviderInstanceSuppliedException - if this object is not a field in the row.
  - stringResult
```
public StringExpression stringResult()
```
    Description copied from interface: ExpressionHasStandardStringResult
    
    Converts the expression into the standard string/character expression representing the value.
    Not all types have a standard string/character representation, notably dates.
    Please note that this is not the SQL version of the expression (toSQLString() will provide that), nor does this provide a String of the value.
    To get the string value use the stringValue method of the appropriate QDT.
    Support DBvolution at Patreon
    
    Specified by:
    
    stringResult in interface ExpressionHasStandardStringResult
    
    Returns:
    a StringExpression of the expression.

Class DBString

Field Summary

Fields inherited from class nz.co.gregs.dbvolution.datatypes.QueryableDatatype

Constructor Summary

Method Summary

Methods inherited from class nz.co.gregs.dbvolution.datatypes.QueryableDatatype

Methods inherited from class java.lang.Object

Methods inherited from interface nz.co.gregs.dbvolution.expressions.DBExpression

Constructor Detail

DBString

DBString

DBString

Method Detail

toStringList

setValue

getValue

getSQLDatatype

formatValueForSQLStatement

copy

getQueryableDatatypeForExpressionValue

isAggregator

getTablesInvolved

permittedValues

permittedValues

permittedValues

permittedValuesIgnoreCase

permittedValuesIgnoreCase

permittedValuesIgnoreCase

permittedValuesIgnoreCase

excludedValuesIgnoreCase

excludedValuesIgnoreCase

excludedValuesIgnoreCase

excludedValues

excludedValues

permittedRange

permittedRangeInclusive

permittedRangeExclusive

excludedRange

excludedRangeInclusive

excludedRangeExclusive

permittedPattern

excludedPattern

permittedPattern

excludedPattern

permittedValues

excludedValues

permittedRange

permittedRangeInclusive

permittedRangeExclusive

excludedRange

excludedRangeInclusive

excludedRangeExclusive

getIncludesNull

isEmptyString

getFromResultSet

permittedPatternIgnoreCase

setToNull

isEmptyOrNullString

setValueFromStandardStringEncoding

getColumn

stringResult