Point2DExpression (DBvolution 7 0.9.13-SNAPSHOT API)

java.lang.Object
- nz.co.gregs.dbvolution.expressions.AnyExpression<B,R,D>
- - nz.co.gregs.dbvolution.expressions.EqualExpression<B,R,D>
  - - nz.co.gregs.dbvolution.expressions.Spatial2DExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
    - - nz.co.gregs.dbvolution.expressions.Point2DExpression

All Implemented Interfaces:

DBExpression, ExpressionColumn<DBPoint2D>, AnyComparable<com.vividsolutions.jts.geom.Point,Point2DResult>, AnyResult<com.vividsolutions.jts.geom.Point>, EqualComparable<com.vividsolutions.jts.geom.Point,Point2DResult>, EqualResult<com.vividsolutions.jts.geom.Point>, ExpressionCanHaveNullValues, ExpressionHasStandardStringResult, Point2DResult, Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>, Spatial2DResult<com.vividsolutions.jts.geom.Point>, SpatialResult<com.vividsolutions.jts.geom.Point>

Direct Known Subclasses:

Point2DColumn
```
public class Point2DExpression
extends Spatial2DExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
implements Point2DResult
```
Represents SQL expressions that are a 2 dimensional points, that is a physical location in a 2D space with X and Y points.
Use these methods to manipulate and transform point2d values and results.
Support DBvolution at Patreon

Author:

gregorygraham

Nested Class Summary
- Nested classes/interfaces inherited from class nz.co.gregs.dbvolution.expressions.EqualExpression
  EqualExpression.ModeSimpleExpression, EqualExpression.ModeStrictExpression

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Point2DExpression()` Default constructor
`protected`	`Point2DExpression(AnyResult<?> value)` Create a Point2DExpression that represents the point value provided.
	`Point2DExpression(double xValue, double yValue)`
	`Point2DExpression(com.vividsolutions.jts.geom.Point point)` Create a Point2DExpression that represents the point value provided.
	`Point2DExpression(Point2DResult value)` Create a Point2DExpression that represents the point value provided.

Method Summary

Methods
Modifier and Type	Method and Description
`DBPoint2D`	`asExpressionColumn()` Creates a QueryableDatatype version of the expression suitable for use as a column.
`Polygon2DExpression`	`boundingBox()` Return a rectangular Polygon2D that fully encompasses all point(s) within this value.
`Point2DExpression`	`copy()` A Complete Copy Of This DBValue.
`NumberExpression`	`distanceTo(Point2DExpression otherPoint)` Calculate the distance between this point and the other point.
`boolean`	`equals(Object other)`
`Point2DExpression`	`expression(DBPoint2D value)`
`Point2DExpression`	`expression(Double xValue, Double yValue)` Create a Point2DExpression that represents the values provided.
`Point2DExpression`	`expression(IntegerExpression xValue, IntegerExpression yValue)` Create a Point2DExpression that represents the values provided.
`Point2DExpression`	`expression(Integer xValue, Integer yValue)` Create a Point2DExpression that represents the values provided.
`Point2DExpression`	`expression(Long xValue, Long yValue)` Create a Point2DExpression that represents the values provided.
`Point2DExpression`	`expression(NumberExpression xValue, NumberExpression yValue)` Create a Point2DExpression that represents the values provided.
`Point2DExpression`	`expression(com.vividsolutions.jts.geom.Point point)` Create a Point2DExpression that represents the point value provided.
`Point2DExpression`	`expression(Point2DResult value)`
`DBPoint2D`	`getQueryableDatatypeForExpressionValue()` Provides a blank instance of the `QueryableDatatype` used by this expression.
`NumberExpression`	`getX()` Retrieves the X value of this point expression.
`NumberExpression`	`getY()` Retrieves the Y value of this point expression.
`int`	`hashCode()`
`BooleanExpression`	`hasMagnitude()` Indicates whether this geometry has a magnitude value.
`BooleanExpression`	`is(com.vividsolutions.jts.geom.Point rightHandSide)` Creates a `BooleanExpression` that compares the 2 instances using the EQUALS operation.
`BooleanExpression`	`is(Point2DResult rightHandSide)` Creates a `BooleanExpression` that compares the 2 values using the EQUALS operation.
`BooleanExpression`	`isNot(com.vividsolutions.jts.geom.Point rightHandSide)` Creates a `BooleanExpression` that compares the 2 instances using the NOT EQUALS operation.
`BooleanExpression`	`isNot(Point2DResult rightHandSide)` Creates a `BooleanExpression` that compares the 2 values using the NOT EQUALS operation.
`NumberExpression`	`magnitude()` Returns the numerical magnitude value, if any, for this expression.
`NumberExpression`	`maxX()` Return a expression that provides the largest X value within the spatial value.
`NumberExpression`	`maxY()` Return a expression that provides the largest Y value within the spatial value.
`NumberExpression`	`measurableDimensions()` Return the measurableDimensions of this expression.
`NumberExpression`	`minX()` Return a expression that provides the smallest X value within the spatial value.
`NumberExpression`	`minY()` Return a expression that provides the smallest Y value within the spatial value.
`Point2DExpression`	`modeSimple()` Creates an expression that will return the most common value of the column supplied.
`Point2DExpression`	`nullExpression()` Returns an expression that will evaluate to NULL in SQL.
`NumberExpression`	`spatialDimensions()` Return the spatial dimensions of this expression.
`StringExpression`	`stringResult()` Converts the expression into the standard string/character expression representing the value.
`StringExpression`	`toWKTFormat()` Transform the value into the Well Known Text (WKT) format.
`static Point2DExpression`	`value(Double xValue, Double yValue)`
`static Point2DExpression`	`value(IntegerExpression xValue, IntegerExpression yValue)`
`static Point2DExpression`	`value(Integer xValue, Integer yValue)`
`static Point2DExpression`	`value(Long xValue, Long yValue)`
`static Point2DExpression`	`value(NumberExpression xValue, NumberExpression yValue)`
`static Point2DExpression`	`value(Point2DResult point)` Create a Point2DExpression that represents the point value provided.

Methods inherited from class nz.co.gregs.dbvolution.expressions.EqualExpression
count, countAll, countIf, is, isNot, modeStrict

Methods inherited from class nz.co.gregs.dbvolution.expressions.AnyExpression
createSQLForFromClause, getIncludesNull, getInnerResult, getTablesInvolved, isAggregator, isComplexExpression, isNullSafetyTerminator, isPurelyFunctional, nullBoolean, nullDate, nullDateRepeat, nullInteger, nullLine2D, nullLineSegment2D, nullMultiPoint2D, nullNumber, nullPoint2D, nullPolygon2D, nullString, toSQLString, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value, value

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

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

Methods inherited from interface nz.co.gregs.dbvolution.results.ExpressionCanHaveNullValues
getIncludesNull

- Constructor Detail
  - Point2DExpression
```
protected Point2DExpression()
```
    Default constructor
  - Point2DExpression
```
protected Point2DExpression(AnyResult<?> value)
```
    Create a Point2DExpression that represents the point value provided.
    
    Parameters:
    value -
  - Point2DExpression
```
public Point2DExpression(Point2DResult value)
```
    Create a Point2DExpression that represents the point value provided.
    
    Parameters:
    value -
  - Point2DExpression
```
public Point2DExpression(com.vividsolutions.jts.geom.Point point)
```
    Create a Point2DExpression that represents the point value provided.
    
    Parameters:
    point -
  - Point2DExpression
```
public Point2DExpression(double xValue,
                 double yValue)
```
- Method Detail
  - expression
```
public Point2DExpression expression(com.vividsolutions.jts.geom.Point point)
```
    Create a Point2DExpression that represents the point value provided.
    
    Specified by:
    
    expression in class AnyExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
    
    Parameters:
    point - the value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the point.
  - value
```
public static Point2DExpression value(Point2DResult point)
```
    Create a Point2DExpression that represents the point value provided.
    
    Parameters:
    point - the value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the point.
  - expression
```
public Point2DExpression expression(Integer xValue,
                           Integer yValue)
```
    Create a Point2DExpression that represents the values provided.
    
    Parameters:
    xValue - the X value of this value.
    yValue - the Y value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the x and y values provided.
  - value
```
public static Point2DExpression value(Integer xValue,
                      Integer yValue)
```
  - expression
```
public Point2DExpression expression(Long xValue,
                           Long yValue)
```
    Create a Point2DExpression that represents the values provided.
    
    Parameters:
    xValue - the X value of this value.
    yValue - the Y value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the x and y values provided.
  - value
```
public static Point2DExpression value(Long xValue,
                      Long yValue)
```
  - expression
```
public Point2DExpression expression(Double xValue,
                           Double yValue)
```
    Create a Point2DExpression that represents the values provided.
    
    Parameters:
    xValue - the X value of this value.
    yValue - the Y value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the x and y values provided.
  - value
```
public static Point2DExpression value(Double xValue,
                      Double yValue)
```
  - expression
```
public Point2DExpression expression(NumberExpression xValue,
                           NumberExpression yValue)
```
    Create a Point2DExpression that represents the values provided.
    
    Parameters:
    xValue - the X value of this value.
    yValue - the Y value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the x and y values provided.
  - value
```
public static Point2DExpression value(NumberExpression xValue,
                      NumberExpression yValue)
```
  - expression
```
public Point2DExpression expression(IntegerExpression xValue,
                           IntegerExpression yValue)
```
    Create a Point2DExpression that represents the values provided.
    
    Parameters:
    xValue - the X value of this value.
    yValue - the Y value of this value.
    Support DBvolution at Patreon
    
    Returns:
    a Point2DExpression of the x and y values provided.
  - value
```
public static Point2DExpression value(IntegerExpression xValue,
                      IntegerExpression yValue)
```
  - nullExpression
```
public Point2DExpression nullExpression()
```
    Description copied from class: AnyExpression
    
    Returns an expression that will evaluate to NULL in SQL.
    
    Overrides:
    
    nullExpression in class AnyExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
    
    Returns:
    an untyped expression that returns NULL
  - expression
```
public Point2DExpression expression(Point2DResult value)
```
    Specified by:
    
    expression in class AnyExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
  - expression
```
public Point2DExpression expression(DBPoint2D value)
```
    Specified by:
    
    expression in class AnyExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
  - getQueryableDatatypeForExpressionValue
```
public DBPoint2D 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
    
    Returns:
    the QueryableDatatype subclass that corresponds to the results of this expression
  - copy
```
public Point2DExpression copy()
```
    Description copied from interface: DBExpression
    
    A Complete Copy Of This DBValue.
    Immutability in DBvolution is maintain by internally copying objects.
    This method enables immutability by performing a deep copy of the object.
    Singletons may return themselves but all other objects must return a new instance with copies of all mutable fields.
    Support DBvolution at Patreon
    
    Specified by:
    
    copy in interface DBExpression
    
    Returns:
    a copy of this DBValue
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toWKTFormat
```
public StringExpression toWKTFormat()
```
    Description copied from interface: Spatial2DComparable
    
    Transform the value into the Well Known Text (WKT) format.
    Support DBvolution at Patreon
    
    Specified by:
    
    toWKTFormat in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    an expression that converts the geometry into the WKT format.
  - 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.
  - is
```
public BooleanExpression is(com.vividsolutions.jts.geom.Point rightHandSide)
```
    Creates a BooleanExpression that compares the 2 instances using the EQUALS operation.
    
    Specified by:
    
    is in interface EqualComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Parameters:
    rightHandSide - the value to compare against.
    Support DBvolution at Patreon
    
    Returns:
    a BooleanExpression
  - is
```
public BooleanExpression is(Point2DResult rightHandSide)
```
    Description copied from interface: EqualComparable
    
    Creates a BooleanExpression that compares the 2 values using the EQUALS operation.
    
    Specified by:
    
    is in interface EqualComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Parameters:
    rightHandSide - an instance to compare to
    Support DBvolution at Patreon
    
    Returns:
    a BooleanExpression
  - isNot
```
public BooleanExpression isNot(com.vividsolutions.jts.geom.Point rightHandSide)
```
    Creates a BooleanExpression that compares the 2 instances using the NOT EQUALS operation.
    
    Specified by:
    
    isNot in interface EqualComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Parameters:
    rightHandSide - the value to compare against.
    Support DBvolution at Patreon
    
    Returns:
    a BooleanExpression
  - isNot
```
public BooleanExpression isNot(Point2DResult rightHandSide)
```
    Description copied from interface: EqualComparable
    
    Creates a BooleanExpression that compares the 2 values using the NOT EQUALS operation.
    
    Specified by:
    
    isNot in interface EqualComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Parameters:
    rightHandSide - and instance to compare to
    Support DBvolution at Patreon
    
    Returns:
    a BooleanExpression
  - getX
```
public NumberExpression getX()
```
    Retrieves the X value of this point expression.
    Provides access to the X value of this point allowing for transforms and tests.
    Support DBvolution at Patreon
    
    Returns:
    a NumberExpression of the X coordinate.
  - getY
```
public NumberExpression getY()
```
    Retrieves the Y value of this point expression.
    Provides access to the Y value of this point allowing for transforms and tests.
    Support DBvolution at Patreon
    
    Returns:
    a NumberExpression of the Y coordinate.
  - measurableDimensions
```
public NumberExpression measurableDimensions()
```
    Description copied from interface: Spatial2DComparable
    
    Return the measurableDimensions of this expression.
    This represents measurableDimensions in the sense of how many dimensions they can be measured in.
    For instance points are zero dimensional in this sense, while lines have a single measurableDimensions, and polygons have 2.
    Since this is a 2D expression, the maximum value of measurableDimensions() is 2.
    All Spatial2D values are still defined in 2D space and require an X and a Y value.
    Support DBvolution at Patreon
    
    Specified by:
    
    measurableDimensions in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a NumberExpression
  - spatialDimensions
```
public NumberExpression spatialDimensions()
```
    Description copied from interface: Spatial2DComparable
    
    Return the spatial dimensions of this expression.
    This represents spatial dimensions in the sense of how many dimensions the locations of the geometry in defined in. That is to say how many of X, Y, Z, and W the geometry must be defined in.
    For instance 2D geometries have 2 spatial dimensions: X and Y. 3D geometries use X, Y, and Z. Presumably hyper-geometries have X, Y, Z, W, etc dimensions.
    Support DBvolution at Patreon
    
    Specified by:
    
    spatialDimensions in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a number expression representing the number of spatial dimensions
  - hasMagnitude
```
public BooleanExpression hasMagnitude()
```
    Description copied from interface: Spatial2DComparable
    
    Indicates whether this geometry has a magnitude value.
    Magnitude is a single value that has been measured at this point. For instance density, depth, color, or temperature. The particular meaning of magnitude is not defined and it can be anything with a numerical value.
    Magnitude isn't actually a very good way to store this information but it is used sometimes.
    Support DBvolution at Patreon
    
    Specified by:
    
    hasMagnitude in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    TRUE if this spatial type supports magnitude values.
  - magnitude
```
public NumberExpression magnitude()
```
    Description copied from interface: Spatial2DComparable
    
    Returns the numerical magnitude value, if any, for this expression.
    Magnitude is a single value that has been measured at this point. For instance density, depth, color, or temperature. The particular meaning of magnitude is not defined and it can be anything with a numerical value.
    Magnitude isn't actually a very good way to store this information but it is used sometimes.
    This value will be null if the actual value is null OR if the spatial type does not support magnitudes.
    Support DBvolution at Patreon
    
    Specified by:
    
    magnitude in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a NumberExpression for the magnitude value of this spatial value.
  - distanceTo
```
public NumberExpression distanceTo(Point2DExpression otherPoint)
```
    Calculate the distance between this point and the other point.
    Creates an SQL value that will report the distance (in units) between these two points.
    Essentially this utilizes a database specific method to calculate sqrt((x2-x1)^2+(y2-y1)^2).
    
    Parameters:
    otherPoint - the point from which to derive the distance.
    Support DBvolution at Patreon
    
    Returns:
    a number value of the distance between the two points in units.
  - boundingBox
```
public Polygon2DExpression boundingBox()
```
    Description copied from interface: Spatial2DComparable
    
    Return a rectangular Polygon2D that fully encompasses all point(s) within this value.
    Support DBvolution at Patreon
    
    Specified by:
    
    boundingBox in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a Polygon2D expression
  - maxX
```
public NumberExpression maxX()
```
    Description copied from interface: Spatial2DComparable
    
    Return a expression that provides the largest X value within the spatial value.
    Support DBvolution at Patreon
    
    Specified by:
    
    maxX in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a NumberExpression
  - maxY
```
public NumberExpression maxY()
```
    Description copied from interface: Spatial2DComparable
    
    Return a expression that provides the largest Y value within the spatial value.
    Support DBvolution at Patreon
    
    Specified by:
    
    maxY in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a NumberExpression
  - minX
```
public NumberExpression minX()
```
    Description copied from interface: Spatial2DComparable
    
    Return a expression that provides the smallest X value within the spatial value.
    Support DBvolution at Patreon
    
    Specified by:
    
    minX in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a NumberExpression
  - minY
```
public NumberExpression minY()
```
    Description copied from interface: Spatial2DComparable
    
    Return a expression that provides the smallest Y value within the spatial value.
    Support DBvolution at Patreon
    
    Specified by:
    
    minY in interface Spatial2DComparable<com.vividsolutions.jts.geom.Point,Point2DResult>
    
    Returns:
    a NumberExpression
  - modeSimple
```
public Point2DExpression modeSimple()
```
    Creates an expression that will return the most common value of the column supplied.
    MODE: The number which appears most often in a set of numbers. For example: in {6, 3, 9, 6, 6, 5, 9, 3} the Mode is 6.
    
    Support DBvolution at Patreon
    
    Overrides:
    
    modeSimple in class EqualExpression<com.vividsolutions.jts.geom.Point,Point2DResult,DBPoint2D>
    
    Returns:
    a number expression.
  - asExpressionColumn
```
public DBPoint2D asExpressionColumn()
```
    Description copied from interface: ExpressionColumn
    
    Creates a QueryableDatatype version of the expression suitable for use as a column.
    For example: @DBColumn public DBString title = person.column(person.fullname).substringBefore(" ").asExpressionColumn();
    Support DBvolution at Patreon
    
    Specified by:
    
    asExpressionColumn in interface ExpressionColumn<DBPoint2D>
    
    Returns:
    a QDT version of the expression

Class Point2DExpression

Nested Class Summary

Nested classes/interfaces inherited from class nz.co.gregs.dbvolution.expressions.EqualExpression

Constructor Summary

Method Summary

Methods inherited from class nz.co.gregs.dbvolution.expressions.EqualExpression

Methods inherited from class nz.co.gregs.dbvolution.expressions.AnyExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.co.gregs.dbvolution.results.ExpressionCanHaveNullValues

Constructor Detail

Point2DExpression

Point2DExpression

Point2DExpression

Point2DExpression

Point2DExpression

Method Detail

expression

value

expression

value

expression

value

expression

value

expression

value

expression

value

nullExpression

expression

expression

getQueryableDatatypeForExpressionValue

copy

equals

hashCode

toWKTFormat

stringResult

is

is

isNot

isNot

getX

getY

measurableDimensions

spatialDimensions

hasMagnitude

magnitude

distanceTo

boundingBox

maxX

maxY

minX

minY

modeSimple

asExpressionColumn