nz.co.gregs.dbvolution.columns

Class Polygon2DColumn

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.Polygon,Polygon2DResult,DBPolygon2D>

nz.co.gregs.dbvolution.expressions.Polygon2DExpression

nz.co.gregs.dbvolution.columns.Polygon2DColumn

All Implemented Interfaces:

ColumnProvider, DBExpression, ExpressionColumn<DBPolygon2D>, AnyComparable<com.vividsolutions.jts.geom.Polygon,Polygon2DResult>, AnyResult<com.vividsolutions.jts.geom.Polygon>, EqualComparable<com.vividsolutions.jts.geom.Polygon,Polygon2DResult>, EqualResult<com.vividsolutions.jts.geom.Polygon>, ExpressionCanHaveNullValues, ExpressionHasStandardStringResult, Polygon2DResult, Spatial2DComparable<com.vividsolutions.jts.geom.Polygon,Polygon2DResult>, Spatial2DResult<com.vividsolutions.jts.geom.Polygon>, SpatialResult<com.vividsolutions.jts.geom.Polygon>

public class Polygon2DColumn
extends Polygon2DExpression
implements ColumnProvider

Provides a portable representation of a column of Polygon2D values.

Support DBvolution at Patreon

Author:

Gregory Graham

Nested Class Summary

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

EqualExpression.ModeSimpleExpression, EqualExpression.ModeStrictExpression

Constructor Summary

Constructors

Constructor and Description
Polygon2DColumn(RowDefinition row, DBPolygon2D field) Creates a portable reference to the column represented by the field of the row.
Polygon2DColumn(RowDefinition row, com.vividsolutions.jts.geom.Polygon field)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractColumn	getColumn() Returns the AbstractColumn from this ColumnProvider.
Set<DBRow>	getTablesInvolved() Returns a Set of the DBRow instances involved in this expression.
boolean	isAggregator() Returns TRUE if this expression is an Aggregator like SUM() or LEAST().
boolean	isPurelyFunctional() Indicates whether or not the expression includes table columns.
void	setUseTableAlias(boolean useTableAlias) Indicates whether the ColumnProvider should use the table alias during query creation.
String	toSQLString(DBDefinition db) Produces the snippet provided by this class.

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

area, asExpressionColumn, boundingBox, contains, contains, contains, contains, copy, doesNotIntersect, doesNotIntersect, expression, expression, expression, expression, expression, expression, expression, exteriorRing, getIncludesNull, getQueryableDatatypeForExpressionValue, hasMagnitude, intersects, intersects, is, is, isNot, isNot, isNullSafetyTerminator, magnitude, maxX, maxY, measurableDimensions, minX, minY, modeSimple, nullExpression, overlaps, overlaps, polygon2DResult, spatialDimensions, stringResult, touches, touches, toWKTFormat, unitSquare, value, value, value, value, value, value, within, within

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, getInnerResult, isComplexExpression, nullBoolean, nullDate, nullDateRepeat, nullInteger, nullLine2D, nullLineSegment2D, nullMultiPoint2D, nullNumber, nullPoint2D, nullPolygon2D, nullString, 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

createSQLForFromClause, isComplexExpression

Constructor Detail

Polygon2DColumn

public Polygon2DColumn(RowDefinition row,
               DBPolygon2D field)

Creates a portable reference to the column represented by the field of the row.

Parameters:

row - the table defining object that contains the field

field - the field that defines the column

Polygon2DColumn

public Polygon2DColumn(RowDefinition row,
               com.vividsolutions.jts.geom.Polygon field)

Method Detail

getColumn

public AbstractColumn getColumn()

Description copied from interface: ColumnProvider

Returns the AbstractColumn from this ColumnProvider.

Support DBvolution at Patreon

Specified by:

getColumn in interface ColumnProvider

Returns:

the column that this provider supplies.

setUseTableAlias

public void setUseTableAlias(boolean useTableAlias)

Description copied from interface: ColumnProvider

Indicates whether the ColumnProvider should use the table alias during query creation.

the standard implementation is this.column.setUseTableAlias(useTableAlias); and passes the boolean along to the underlying AbstractColumn

Specified by:

setUseTableAlias in interface ColumnProvider

Parameters:

useTableAlias - true or false

toSQLString

public String toSQLString(DBDefinition db)

Description copied from interface: DBExpression

Produces the snippet provided by this class.

This is only used internally.

If you are extending DBvolution and adding a new function this is the place to format the information for use in SQL. A DBDefinition instance is provided to supply context and so your SQL can used on multiple database engines.

Specified by:

toSQLString in interface DBExpression

Overrides:

toSQLString in class AnyExpression<com.vividsolutions.jts.geom.Polygon,Polygon2DResult,DBPolygon2D>

Parameters:

db - the target database

Support DBvolution at Patreon

Returns:

the DBValue formatted as a SQL snippet

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 AnyExpression<com.vividsolutions.jts.geom.Polygon,Polygon2DResult,DBPolygon2D>

Returns:

a set of DBRow instances involved in this DBExpression.

isPurelyFunctional

public boolean isPurelyFunctional()

Description copied from interface: DBExpression

Indicates whether or not the expression includes table columns.

Purely functional expressions use only in-built functions or literal values to produce results and do not require data from tables.

Some databases, notably MS SQLServer, can not group purely functional expressions.

Support DBvolution at Patreon

Specified by:

isPurelyFunctional in interface DBExpression

Overrides:

isPurelyFunctional in class AnyExpression<com.vividsolutions.jts.geom.Polygon,Polygon2DResult,DBPolygon2D>

Returns:

TRUE if the expression does not access table data, otherwise FALSE.

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

Overrides:

isAggregator in class AnyExpression<com.vividsolutions.jts.geom.Polygon,Polygon2DResult,DBPolygon2D>

Returns:

TRUE if this DBExpression represents an aggregating functions