PUBLIC: A utility class used to set parameters on spatial operators within TopLink's expression framework. This class allows the aptial operator parameters to be passed in directly as a string or to be programatically configured using the attributes defined and the enum types. Each spatial operator offers different parameter arguments and values. This class does not enforce these rules but instead leaves it to the caller to decide what values they want included.

When providing the parameter string through setParams or the constructor none of the other values will be used. Instead the string as provided will be used.

Creating an instance of SpatialParameters without configuring it and passing it into the SpatialExpressionFactory call is equivalent to passing in null. The resulting SQL will have NULL writen out for the parameters argument to the spatial operator.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	SpatialParameters.Mask
public static enum	SpatialParameters.QueryType
public static enum	SpatialParameters.Units

Field Summary

Modifier and Type	Field and Description
private Number	distance
private static String	DISTANCE_PARAM
private static String	MASK_PARAM
private SpatialParameters.Mask[]	masks
private static String	MAX_RES_PARAM
private Number	maxResolution
private static String	MIN_RES_PARAM
private Number	minResolution
private String	params
private SpatialParameters.QueryType	queryType
private static String	QUERYTYPE_PARAM
private static String	UNIT_PARAM
private SpatialParameters.Units	units

Constructor Summary

Access	Constructor and Description
public	SpatialParameters()
public	SpatialParameters(String params)

Method Summary

Modifier and Type	Method and Description
public Number	getDistance()
public SpatialParameters.Mask[]	getMasks()
public Number	getMaxResolution()
public Number	getMinResolution()
public String	getParameterString() PUBLIC: build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function
public String	getParams()
public SpatialParameters.QueryType	getQueryType()
public SpatialParameters.Units	getUnits()
public SpatialParameters	Returns: this instance of SpatialParameters setDistance(Number distance) PUBLIC: Set the DISTANCE parameter
public SpatialParameters	Returns: this instance of SpatialParameters setMask(SpatialParameters.Mask a value from the SpatialParmeters.Mask enum mask) PUBLIC: Set the MASK parameter
public SpatialParameters	Returns: this instance of SpatialParameters setMasks(SpatialParameters.Mask[] an array of values from the SpatialParmeters.Mask enum masks) PUBLIC: Set the MASK parameter
public SpatialParameters	Returns: this instance of SpatialParameters setMaxResolution(Number maxResolution) PUBLIC: Set the MAX_RESOLUTION parameter
public SpatialParameters	Returns: this instance of SpatialParameters setMinResolution(Number minResolution) PUBLIC: Set the MIN_RESOLUTION parameter
public SpatialParameters	Returns: this instance of SpatialParameters setParams(String params) PUBLIC: Set the PARAMS (String) value.
public SpatialParameters	Returns: this instance of SpatialParameters setQueryType(SpatialParameters.QueryType a value from the SpatialParameters.QueryType enum queryType) PUBLIC: Set the QUERY_TYPE parameter
public SpatialParameters	Returns: this instance of SpatialParameters setUnits(SpatialParameters.Units a value from the SpatialParameters.Units enum units) PUBLIC: Set the UNIT parameter
private boolean	writeParam(StringWriter writer, String paramName, Object paramValue, boolean hasParams) INTERNAL: Write the parameter onto the StringWriter being used to construct the params string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

distance	back to summary
private Number distance

DISTANCE_PARAM	back to summary
private static String DISTANCE_PARAM

MASK_PARAM	back to summary
private static String MASK_PARAM

masks	back to summary
private SpatialParameters.Mask[] masks

MAX_RES_PARAM	back to summary
private static String MAX_RES_PARAM

maxResolution	back to summary
private Number maxResolution

MIN_RES_PARAM	back to summary
private static String MIN_RES_PARAM

minResolution	back to summary
private Number minResolution

params	back to summary
private String params

queryType	back to summary
private SpatialParameters.QueryType queryType

QUERYTYPE_PARAM	back to summary
private static String QUERYTYPE_PARAM

UNIT_PARAM	back to summary
private static String UNIT_PARAM

units	back to summary
private SpatialParameters.Units units

Constructor Detail

SpatialParameters	back to summary
public SpatialParameters()

SpatialParameters	back to summary
public SpatialParameters(String params)

Method Detail

getDistance	back to summary
public Number getDistance()

getMasks	back to summary
public SpatialParameters.Mask[] getMasks()

getMaxResolution	back to summary
public Number getMaxResolution()

getMinResolution	back to summary
public Number getMinResolution()

getParameterString	back to summary
public String getParameterString() PUBLIC: build a String describing this set of parameters that can be used in conjunction with an Oracle Spatial function

getParams	back to summary
public String getParams()

getQueryType	back to summary
public SpatialParameters.QueryType getQueryType()

getUnits	back to summary
public SpatialParameters.Units getUnits()

setDistance	back to summary
public SpatialParameters setDistance(Number distance) PUBLIC: Set the DISTANCE parameter Returns:SpatialParameters this instance of SpatialParameters

setDistance

back to summary

public SpatialParameters setDistance(Number distance)

PUBLIC: Set the DISTANCE parameter

Returns:SpatialParameters: this instance of SpatialParameters

setMask	back to summary
public SpatialParameters setMask(SpatialParameters.Mask mask) PUBLIC: Set the MASK parameter Parameters mask:SpatialParameters.Mask a value from the SpatialParmeters.Mask enum Returns:SpatialParameters this instance of SpatialParameters

setMask

back to summary

public SpatialParameters setMask(SpatialParameters.Mask mask)

PUBLIC: Set the MASK parameter

Parameters

mask:SpatialParameters.Mask: a value from the SpatialParmeters.Mask enum

Returns:SpatialParameters

this instance of SpatialParameters

setMasks	back to summary
public SpatialParameters setMasks(SpatialParameters.Mask[] masks) PUBLIC: Set the MASK parameter Parameters masks:SpatialParameters.Mask[] an array of values from the SpatialParmeters.Mask enum Returns:SpatialParameters this instance of SpatialParameters

setMasks

back to summary

public SpatialParameters setMasks(SpatialParameters.Mask[] masks)

PUBLIC: Set the MASK parameter

Parameters

masks:SpatialParameters.Mask[]: an array of values from the SpatialParmeters.Mask enum

Returns:SpatialParameters

this instance of SpatialParameters

setMaxResolution	back to summary
public SpatialParameters setMaxResolution(Number maxResolution) PUBLIC: Set the MAX_RESOLUTION parameter Returns:SpatialParameters this instance of SpatialParameters

setMaxResolution

back to summary

public SpatialParameters setMaxResolution(Number maxResolution)

PUBLIC: Set the MAX_RESOLUTION parameter

Returns:SpatialParameters: this instance of SpatialParameters

setMinResolution	back to summary
public SpatialParameters setMinResolution(Number minResolution) PUBLIC: Set the MIN_RESOLUTION parameter Returns:SpatialParameters this instance of SpatialParameters

setMinResolution

back to summary

public SpatialParameters setMinResolution(Number minResolution)

PUBLIC: Set the MIN_RESOLUTION parameter

Returns:SpatialParameters: this instance of SpatialParameters

setParams	back to summary
public SpatialParameters setParams(String params) PUBLIC: Set the PARAMS (String) value. If this value is set then no other param values will be used. Returns:SpatialParameters this instance of SpatialParameters

setParams

back to summary

public SpatialParameters setParams(String params)

PUBLIC: Set the PARAMS (String) value. If this value is set then no other param values will be used.

Returns:SpatialParameters: this instance of SpatialParameters

setQueryType	back to summary
public SpatialParameters setQueryType(SpatialParameters.QueryType queryType) PUBLIC: Set the QUERY_TYPE parameter Parameters queryType:SpatialParameters.QueryType a value from the SpatialParameters.QueryType enum Returns:SpatialParameters this instance of SpatialParameters

setQueryType

back to summary

public SpatialParameters setQueryType(SpatialParameters.QueryType queryType)

PUBLIC: Set the QUERY_TYPE parameter

Parameters

queryType:SpatialParameters.QueryType: a value from the SpatialParameters.QueryType enum

Returns:SpatialParameters

this instance of SpatialParameters

setUnits	back to summary
public SpatialParameters setUnits(SpatialParameters.Units units) PUBLIC: Set the UNIT parameter Parameters units:SpatialParameters.Units a value from the SpatialParameters.Units enum Returns:SpatialParameters this instance of SpatialParameters

setUnits

back to summary

public SpatialParameters setUnits(SpatialParameters.Units units)

PUBLIC: Set the UNIT parameter

Parameters

units:SpatialParameters.Units: a value from the SpatialParameters.Units enum

Returns:SpatialParameters

this instance of SpatialParameters

writeParam	back to summary
private boolean writeParam(StringWriter writer, String paramName, Object paramValue, boolean hasParams) INTERNAL: Write the parameter onto the StringWriter being used to construct the params string. Only write something if there is a value and return true indicating if a parameter is written.

org.eclipse.persistence.expressions.spatial back to summary

public final Enum SpatialParameters.Mask

Class Inheritance

extends Enum<SpatialParameters.Mask>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.expressions.spatial.SpatialParameters.Mask

Field Summary

Modifier and Type	Field and Description
public static final SpatialParameters.Mask	ANYINTERACT
public static final SpatialParameters.Mask	CONTAINS
public static final SpatialParameters.Mask	COVEREDBY
public static final SpatialParameters.Mask	COVERS
public static final SpatialParameters.Mask	EQUAL
public static final SpatialParameters.Mask	INSIDE
public static final SpatialParameters.Mask	ON
public static final SpatialParameters.Mask	OVERLAPBDYDISJOINT
public static final SpatialParameters.Mask	OVERLAPBDYINTERSECT
public static final SpatialParameters.Mask	TOUCH

Constructor Summary

Access	Constructor and Description
private	Mask()

Method Summary

Modifier and Type	Method and Description
public static SpatialParameters.Mask	valueOf(String name)
public static SpatialParameters.Mask[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANYINTERACT	back to summary
public static final SpatialParameters.Mask ANYINTERACT

CONTAINS	back to summary
public static final SpatialParameters.Mask CONTAINS

COVEREDBY	back to summary
public static final SpatialParameters.Mask COVEREDBY

COVERS	back to summary
public static final SpatialParameters.Mask COVERS

EQUAL	back to summary
public static final SpatialParameters.Mask EQUAL

INSIDE	back to summary
public static final SpatialParameters.Mask INSIDE

ON	back to summary
public static final SpatialParameters.Mask ON

OVERLAPBDYDISJOINT	back to summary
public static final SpatialParameters.Mask OVERLAPBDYDISJOINT

OVERLAPBDYINTERSECT	back to summary
public static final SpatialParameters.Mask OVERLAPBDYINTERSECT

TOUCH	back to summary
public static final SpatialParameters.Mask TOUCH

Constructor Detail

Mask	back to summary
private Mask()

Method Detail

valueOf	back to summary
public static SpatialParameters.Mask valueOf(String name)

values	back to summary
public static SpatialParameters.Mask[] values()

org.eclipse.persistence.expressions.spatial back to summary

public final Enum SpatialParameters.QueryType

Class Inheritance

extends Enum<SpatialParameters.QueryType>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.expressions.spatial.SpatialParameters.QueryType

Field Summary

Modifier and Type	Field and Description
public static final SpatialParameters.QueryType	FILTER
public static final SpatialParameters.QueryType	JOIN
public static final SpatialParameters.QueryType	WINDOW

Constructor Summary

Access	Constructor and Description
private	QueryType()

Method Summary

Modifier and Type	Method and Description
public static SpatialParameters.QueryType	valueOf(String name)
public static SpatialParameters.QueryType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FILTER	back to summary
public static final SpatialParameters.QueryType FILTER

JOIN	back to summary
public static final SpatialParameters.QueryType JOIN

WINDOW	back to summary
public static final SpatialParameters.QueryType WINDOW

Constructor Detail

QueryType	back to summary
private QueryType()

Method Detail

valueOf	back to summary
public static SpatialParameters.QueryType valueOf(String name)

values	back to summary
public static SpatialParameters.QueryType[] values()

org.eclipse.persistence.expressions.spatial back to summary

public final Enum SpatialParameters.Units

Class Inheritance

extends Enum<SpatialParameters.Units>

java.lang.Object
java.lang.Enum
org.eclipse.persistence.expressions.spatial.SpatialParameters.Units

Field Summary

Modifier and Type	Field and Description
public static final SpatialParameters.Units	CM
public static final SpatialParameters.Units	FOOT
public static final SpatialParameters.Units	INCH
public static final SpatialParameters.Units	KM
public static final SpatialParameters.Units	M
public static final SpatialParameters.Units	MILE
public static final SpatialParameters.Units	MM
public static final SpatialParameters.Units	NAUT_MILE

Constructor Summary

Access	Constructor and Description
private	Units()

Method Summary

Modifier and Type	Method and Description
public static SpatialParameters.Units	valueOf(String name)
public static SpatialParameters.Units[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CM	back to summary
public static final SpatialParameters.Units CM

FOOT	back to summary
public static final SpatialParameters.Units FOOT

INCH	back to summary
public static final SpatialParameters.Units INCH

KM	back to summary
public static final SpatialParameters.Units KM

M	back to summary
public static final SpatialParameters.Units M

MILE	back to summary
public static final SpatialParameters.Units MILE

MM	back to summary
public static final SpatialParameters.Units MM

NAUT_MILE	back to summary
public static final SpatialParameters.Units NAUT_MILE

Constructor Detail

Units	back to summary
private Units()

Method Detail

valueOf	back to summary
public static SpatialParameters.Units valueOf(String name)

values	back to summary
public static SpatialParameters.Units[] values()

public Class SpatialParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SpatialParameters.Mask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SpatialParameters.QueryType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SpatialParameters.Units

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail