nz.co.gregs.dbvolution.datatypes

Class DBNumber

java.lang.Object

nz.co.gregs.dbvolution.datatypes.QueryableDatatype<Number>

nz.co.gregs.dbvolution.datatypes.DBNumber

All Implemented Interfaces:

Serializable, DBExpression, ExpressionCanHaveNullValues, ExpressionHasStandardStringResult, NumberResult

Direct Known Subclasses:

DBNumberStatistics

public class DBNumber
extends QueryableDatatype<Number>
implements NumberResult

Encapsulates database values that are Numbers.

Use DBNumber when the column is a NUMBER or NUMBER(x,y), that is any integer or real datatype..

Use DBInteger when the numbers do not have a decimal or fractional part.

Generally DBNumber is declared inside your DBRow sub-class as: @DBColumn public DBNumber myIntColumn = new DBNumber();

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
DBNumber() The default constructor for DBNumber.
DBNumber(IntegerExpression integerExpression)
DBNumber(Long aNumber)
DBNumber(Number aNumber) Creates a new DBNumber with the value set to the number provided.
DBNumber(NumberExpression... numberExpression) Creates a column expression with a number result from the expression provided.

Method Summary

Methods

Modifier and Type	Method and Description
DBNumber	copy() Copies a QueryableDatatype and returns the copy.
Double	doubleValue() The current literal value of this DBNumber as a Double Support DBvolution at Patreon
void	excludedRange(Number lowerBound, Number upperBound) Performs searches based on a range.
void	excludedRange(NumberResult lowerBound, NumberResult upperBound) Performs searches based on a range.
void	excludedRangeExclusive(Number lowerBound, Number upperBound) Performs searches based on a range.
void	excludedRangeExclusive(NumberResult lowerBound, NumberResult upperBound) Performs searches based on a range.
void	excludedRangeInclusive(Number lowerBound, Number upperBound) Performs searches based on a range.
void	excludedRangeInclusive(NumberResult lowerBound, NumberResult upperBound) Performs searches based on a range.
void	excludedValues(Collection<Number> excluded) excludes the object, Set, List, Array, or vararg of objects
void	excludedValues(Number... excluded) excludes the object, Set, List, Array, or vararg of objects
void	excludedValues(NumberResult... excluded) excludes the object, Set, List, Array, or vararg of objects
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.
protected Number	getFromResultSet(DBDefinition defn, 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.
static int	getNumericPrecision()
static int	getNumericScale()
DBNumber	getQueryableDatatypeForExpressionValue() Provides a blank instance of the QueryableDatatype used by this expression.
String	getSQLDatatype() Support DBvolution at Patreon
Set<DBRow>	getTablesInvolved() Returns a Set of the DBRow instances involved in this expression.
Number	getValue() Gets the current literal value of this DBNumber, without any formatting.
Integer	intValue() The current literal value of this DBNumber as an Integer Support DBvolution at Patreon
boolean	isAggregator() Returns TRUE if this expression is an Aggregator like SUM() or LEAST().
Long	longValue() The current literal value of this DBNumber as a Long Support DBvolution at Patreon
Number	numberValue() The current literal value of this DBNumber as a Number Support DBvolution at Patreon
void	permittedRange(Number lowerBound, Number upperBound) Performs searches based on a range.
void	permittedRange(NumberResult lowerBound, NumberResult upperBound) Performs searches based on a range.
void	permittedRangeExclusive(Number lowerBound, Number upperBound) Performs searches based on a range.
void	permittedRangeExclusive(NumberResult lowerBound, NumberResult upperBound) Performs searches based on a range.
void	permittedRangeInclusive(Number lowerBound, Number upperBound) Performs searches based on a range.
void	permittedRangeInclusive(NumberResult lowerBound, NumberResult upperBound) Performs searches based on a range.
void	permittedValues(Collection<Number> permitted) reduces the rows to only the object, Set, List, Array, or vararg of objects
void	permittedValues(Number... permitted) reduces the rows to only the object, Set, List, Array, or vararg of objects
void	permittedValues(NumberResult... permitted) reduces the rows to only the object, Set, List, Array, or vararg of objects
void	setValue(DBNumber newLiteralValue) Sets the value of this DBNumber to the value of the DBNumber provided.
void	setValue(Number newLiteralValue) Set the value of this DBNumber to the Double, Long, Integer, or other number 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.

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

clear, equals, formatColumnForSQLStatement, getColumnExpression, getLiteralValue, getOperator, getPreviousSQLValue, getPreviousValue, getPropertyWrapperDefinition, getQueryableDatatypeForObject, getQueryableDatatypeInstance, getSortOrder, hasBeenSet, hasChanged, hasColumnExpression, hashCode, includingNulls, isDefined, isNotNull, isNull, isPurelyFunctional, negateOperator, removeConstraints, setChanged, setColumnExpression, setDefined, setFromResultSet, setLiteralValue, setOperator, setPreviousValue, setSortOrderAscending, setSortOrderDescending, setToNull, setToNull, setUnchanged, setValueToNull, stringValue, toSQLString, toString

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

isPurelyFunctional, toSQLString

Constructor Detail

DBNumber

public DBNumber()

The default constructor for DBNumber.

Creates an unset undefined DBNumber object.

DBNumber

public DBNumber(NumberExpression... numberExpression)

Creates a column expression with a number result from the expression provided.

Used in DBReport, and some DBRow, sub-classes to derive data from the database prior to retrieval.

Parameters:

numberExpression - numberExpression

DBNumber

public DBNumber(Number aNumber)

Creates a new DBNumber with the value set to the number provided.

Parameters:

aNumber - aNumber

DBNumber

public DBNumber(Long aNumber)

Parameters:

aNumber - aNumber

DBNumber

public DBNumber(IntegerExpression integerExpression)

Method Detail

copy

public DBNumber 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 NumberResult

Overrides:

copy in class QueryableDatatype<Number>

Returns:

a complete copy of the QDT with all values set.

setValue

public void setValue(DBNumber newLiteralValue)

Sets the value of this DBNumber to the value of the DBNumber provided.

This allows DBNumbers to be treated somewhat like normal numbers. However setValue(java.lang.Number) may be more useful in normal usage.

Parameters:

newLiteralValue - newLiteralValue

setValue

public void setValue(Number newLiteralValue)

Set the value of this DBNumber to the Double, Long, Integer, or other number provided.

This is probably the method you want to use to set or change the value of this DBNumber. When creating a new row or updating an existing row use this method or setValue(nz.co.gregs.dbvolution.datatypes.DBNumber) to correctly set the value.

Remember:

• Set the column to NULL using setValue((Number)null)
• Use DBDatabase.insert(nz.co.gregs.dbvolution.DBRow...) or DBDatabase.update(nz.co.gregs.dbvolution.DBRow...) to make the changes permanent.

Parameters:

newLiteralValue - newLiteralValue

getSQLDatatype

public String getSQLDatatype()

Support DBvolution at Patreon

Specified by:

getSQLDatatype in class QueryableDatatype<Number>

Returns:

the default database type as a string, may be gazumped by the DBDefinition

getNumericScale

public static int getNumericScale()

getNumericPrecision

public static int getNumericPrecision()

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<Number>

Parameters:

db - db

Support DBvolution at Patreon

Returns:

the underlying number formatted for a SQL statement

getValue

public Number getValue()

Gets the current literal value of this DBNumber, without any formatting.

The literal value is undefined (and null) if using an operator other than equals.

Support DBvolution at Patreon

Overrides:

getValue in class QueryableDatatype<Number>

Returns:

the literal value, if defined, which may be null

numberValue

public Number numberValue()

The current literal value of this DBNumber as a Number

Support DBvolution at Patreon

Returns:

the number as the original number class

doubleValue

public Double doubleValue()

The current literal value of this DBNumber as a Double

Support DBvolution at Patreon

Returns:

the number as a Double

longValue

public Long longValue()

The current literal value of this DBNumber as a Long

Support DBvolution at Patreon

Returns:

the number as a Long

intValue

public Integer intValue()

The current literal value of this DBNumber as an Integer

Support DBvolution at Patreon

Returns:

the number as an Integer

getQueryableDatatypeForExpressionValue

public DBNumber 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<Number>

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<Number>

Returns:

a set of DBRow instances involved in this DBExpression.

permittedValues

public void permittedValues(Number... permitted)

reduces the rows to only the object, Set, List, Array, or vararg of objects

Parameters:

permitted - permitted

permittedValues

public void permittedValues(Collection<Number> permitted)

reduces the rows to only the object, Set, List, Array, or vararg of objects

Parameters:

permitted - permitted

permittedValues

public void permittedValues(NumberResult... permitted)

reduces the rows to only the object, Set, List, Array, or vararg of objects

Parameters:

permitted - permitted

excludedValues

public void excludedValues(Number... excluded)

excludes the object, Set, List, Array, or vararg of objects

Parameters:

excluded - excluded

excludedValues

public void excludedValues(Collection<Number> excluded)

excludes the object, Set, List, Array, or vararg of objects

Parameters:

excluded - excluded

excludedValues

public void excludedValues(NumberResult... excluded)

excludes the object, Set, List, Array, or vararg of objects

Parameters:

excluded - excluded

permittedRange

public void permittedRange(Number lowerBound,
                  Number 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

permittedRange

public void permittedRange(NumberResult lowerBound,
                  NumberResult 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(Number lowerBound,
                           Number 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

permittedRangeInclusive

public void permittedRangeInclusive(NumberResult lowerBound,
                           NumberResult 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(Number lowerBound,
                           Number 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

permittedRangeExclusive

public void permittedRangeExclusive(NumberResult lowerBound,
                           NumberResult 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(Number lowerBound,
                 Number upperBound)

Performs searches based on a range. if both ends of the range are specified the lower-bound will be within the range and the upper-bound outside. 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

excludedRange

public void excludedRange(NumberResult lowerBound,
                 NumberResult upperBound)

Performs searches based on a range. if both ends of the range are specified the lower-bound will be within in the range and the upper-bound outside. 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 return 4,3,2,1, etc.

Parameters:

lowerBound - lowerBound

upperBound - upperBound

excludedRangeInclusive

public void excludedRangeInclusive(Number lowerBound,
                          Number 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

excludedRangeInclusive

public void excludedRangeInclusive(NumberResult lowerBound,
                          NumberResult 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(Number lowerBound,
                          Number 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

excludedRangeExclusive

public void excludedRangeExclusive(NumberResult lowerBound,
                          NumberResult 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.

getFromResultSet

protected Number getFromResultSet(DBDefinition defn,
                      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<Number>

Parameters:

defn - 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

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.

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<Number>

Parameters:

encodedValue - the value of the QDT in the appropriate encoding