TLcdOGCSpatialFilterCapabilities (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.ogc.filter.model.capabilities.TLcdOGCSpatialFilterCapabilities

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, java.lang.Cloneable
```
public class TLcdOGCSpatialFilterCapabilities
extends TLcdDataObject
```
Class defining a set of spatial-based filter capabilities, defined by a list of a geometry operands and spatial operators.

See Also:

TLcdOGCFilterCapabilities

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdXMLName`	`ARC` GML arc operand
`static TLcdXMLName`	`ARCBYBULGE` GML arc by bulge operand
`static TLcdXMLName`	`ARCBYCENTERPOINT` GML arc by center point operand
`static java.lang.String`	`BBOX` Spatial BBOX operator name
`static java.lang.String`	`BEYOND` Spatial Beyond operator name
`static TLcdXMLName`	`BEZIER` GML bezier operand
`static TLcdXMLName`	`CIRCLE` GML circle operand
`static TLcdXMLName`	`CIRCLEBYCENTERPOINT` GML circle by center point operand
`static TLcdXMLName`	`CLOTHOID` GML clothoid operand
`static java.lang.String`	`CONTAINS` Spatial Contains operator name
`static java.lang.String`	`CROSSES` Spatial Crosses operator name
`static TLcdXMLName`	`CUBICSPLINE` GML cubic spline operand
`static java.lang.String`	`DISJOINT` Spatial Disjoint operator name
`static java.lang.String`	`DWITHIN` Spatial DWithin operator name
`static TLcdXMLName`	`ENVELOPE` GML envelope operand
`static java.lang.String`	`EQUALS` Spatial Equals operator name
`static TLcdXMLName`	`GEODESIC` GML geodesic operand
`static java.lang.String`	`INTERSECT` Deprecated. Use `INTERSECTS`.
`static java.lang.String`	`INTERSECTS` Spatial Intersects operator name
`static TLcdXMLName`	`LINESTRING` GML linestring operand
`static TLcdXMLName`	`OFFSETCURVE` GML offset curve operand
`static java.lang.String`	`OVERLAPS` Spatial Overlaps operator name
`static TLcdXMLName`	`POINT` GML point operand
`static TLcdXMLName`	`POLYGON` GML polygon operand
`static TLcdXMLName`	`POLYHEDRALSURFACE` GML polyhedral surface operand
`static TLcdXMLName`	`SOLID` GML solid operand
`static TLcdXMLName`	`TIN` GML tin operand
`static java.lang.String`	`TOUCHES` Spatial Touches operator name
`static TLcdXMLName`	`TRIANGLE` GML triangle operand
`static TLcdXMLName`	`TRIANGULATEDSURFACE` GML triangulated surface operand
`static java.lang.String`	`WITHIN` Spatial Within operator name

Constructor Summary

Constructors
Constructor and Description
`TLcdOGCSpatialFilterCapabilities()` Default constructor.
`TLcdOGCSpatialFilterCapabilities(TLcdOGCSpatialOperator[] aSpatialOperators, TLcdXMLName[] aGeometryOperands)` Constructs a spatial filter capabilities object, with the given spatial operators and geometry operands.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGeometryOperand(TLcdXMLName aOperand)` Add a geometry operand to the list of geometry operands specified in this capabilities object.
`void`	`addSpatialOperator(TLcdOGCSpatialOperator aOperator)` Add a spatial operator to the list of spatial operators specified in this capabilities object.
`TLcdXMLName`	`getGeometryOperand(int aIndex)` Returns the geometry operand at the given index.
`int`	`getGeometryOperandCount()` Returns the number of supported geometry operands.
`java.util.List<TLcdXMLName>`	`getGeometryOperands()` Returns a list containing the supported geometry operands.
`TLcdOGCSpatialOperator`	`getSpatialOperator(int index)` Returns the spatial operator at aIndex index in the list of supported spatial operators.
`int`	`getSpatialOperatorCount()` Returns the number of supported spatial operators.
`java.util.List<TLcdOGCSpatialOperator>`	`getSpatialOperators()` Returns a list containing the supported spatial operators.
`void`	`removeGeometryOperand(TLcdXMLName aOperand)` Remove the geometry operand aOperand to the list of geometry operands specified in this capabilities object.
`void`	`removeSpatialOperator(TLcdOGCSpatialOperator aOperator)` Remove the spatial operator aOperator from the list of spatial operators specified in this capabilities object.

Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

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

- Field Detail
  - BBOX
```
public static final java.lang.String BBOX
```
    Spatial BBOX operator name
    
    See Also:
    
    Constant Field Values
  - DISJOINT
```
public static final java.lang.String DISJOINT
```
    Spatial Disjoint operator name
    
    See Also:
    
    Constant Field Values
  - INTERSECT
```
@Deprecated
public static final java.lang.String INTERSECT
```
    Deprecated. Use INTERSECTS.
    
    Spatial Intersects operator name
    
    See Also:
    
    Constant Field Values
  - INTERSECTS
```
public static final java.lang.String INTERSECTS
```
    Spatial Intersects operator name
    
    See Also:
    
    Constant Field Values
  - WITHIN
```
public static final java.lang.String WITHIN
```
    Spatial Within operator name
    
    See Also:
    
    Constant Field Values
  - CROSSES
```
public static final java.lang.String CROSSES
```
    Spatial Crosses operator name
    
    See Also:
    
    Constant Field Values
  - TOUCHES
```
public static final java.lang.String TOUCHES
```
    Spatial Touches operator name
    
    See Also:
    
    Constant Field Values
  - EQUALS
```
public static final java.lang.String EQUALS
```
    Spatial Equals operator name
    
    See Also:
    
    Constant Field Values
  - OVERLAPS
```
public static final java.lang.String OVERLAPS
```
    Spatial Overlaps operator name
    
    See Also:
    
    Constant Field Values
  - CONTAINS
```
public static final java.lang.String CONTAINS
```
    Spatial Contains operator name
    
    See Also:
    
    Constant Field Values
  - DWITHIN
```
public static final java.lang.String DWITHIN
```
    Spatial DWithin operator name
    
    See Also:
    
    Constant Field Values
  - BEYOND
```
public static final java.lang.String BEYOND
```
    Spatial Beyond operator name
    
    See Also:
    
    Constant Field Values
  - ENVELOPE
```
public static final TLcdXMLName ENVELOPE
```
    GML envelope operand
  - LINESTRING
```
public static final TLcdXMLName LINESTRING
```
    GML linestring operand
  - POINT
```
public static final TLcdXMLName POINT
```
    GML point operand
  - POLYGON
```
public static final TLcdXMLName POLYGON
```
    GML polygon operand
  - ARCBYCENTERPOINT
```
public static final TLcdXMLName ARCBYCENTERPOINT
```
    GML arc by center point operand
  - CIRCLEBYCENTERPOINT
```
public static final TLcdXMLName CIRCLEBYCENTERPOINT
```
    GML circle by center point operand
  - ARC
```
public static final TLcdXMLName ARC
```
    GML arc operand
  - CIRCLE
```
public static final TLcdXMLName CIRCLE
```
    GML circle operand
  - ARCBYBULGE
```
public static final TLcdXMLName ARCBYBULGE
```
    GML arc by bulge operand
  - BEZIER
```
public static final TLcdXMLName BEZIER
```
    GML bezier operand
  - CLOTHOID
```
public static final TLcdXMLName CLOTHOID
```
    GML clothoid operand
  - CUBICSPLINE
```
public static final TLcdXMLName CUBICSPLINE
```
    GML cubic spline operand
  - GEODESIC
```
public static final TLcdXMLName GEODESIC
```
    GML geodesic operand
  - OFFSETCURVE
```
public static final TLcdXMLName OFFSETCURVE
```
    GML offset curve operand
  - TRIANGLE
```
public static final TLcdXMLName TRIANGLE
```
    GML triangle operand
  - POLYHEDRALSURFACE
```
public static final TLcdXMLName POLYHEDRALSURFACE
```
    GML polyhedral surface operand
  - TRIANGULATEDSURFACE
```
public static final TLcdXMLName TRIANGULATEDSURFACE
```
    GML triangulated surface operand
  - TIN
```
public static final TLcdXMLName TIN
```
    GML tin operand
  - SOLID
```
public static final TLcdXMLName SOLID
```
    GML solid operand
- Constructor Detail
  - TLcdOGCSpatialFilterCapabilities
```
public TLcdOGCSpatialFilterCapabilities()
```
    Default constructor.
  - TLcdOGCSpatialFilterCapabilities
```
public TLcdOGCSpatialFilterCapabilities(TLcdOGCSpatialOperator[] aSpatialOperators,
                                        TLcdXMLName[] aGeometryOperands)
```
    Constructs a spatial filter capabilities object, with the given spatial operators and geometry operands.
    
    Parameters:
    
    aSpatialOperators - an array of spatial operators
    
    aGeometryOperands - an array of geometry operands
- Method Detail
  - getSpatialOperatorCount
```
public int getSpatialOperatorCount()
```
    Returns the number of supported spatial operators.
    
    Returns:
    
    the number of supported spatial operators.
  - getSpatialOperators
```
public java.util.List<TLcdOGCSpatialOperator> getSpatialOperators()
```
    Returns a list containing the supported spatial operators.
    
    Returns:
    
    a list containing the supported spatial operators.
  - getSpatialOperator
```
public TLcdOGCSpatialOperator getSpatialOperator(int index)
```
    Returns the spatial operator at aIndex index in the list of supported spatial operators.
    
    Parameters:
    
    index -
    
    Returns:
    
    the spatial operator at aIndex index in the list of supported spatial operators.
  - getGeometryOperandCount
```
public int getGeometryOperandCount()
```
    Returns the number of supported geometry operands.
    
    Returns:
    
    the number of supported geometry operands.
  - getGeometryOperands
```
public java.util.List<TLcdXMLName> getGeometryOperands()
```
    Returns a list containing the supported geometry operands.
    
    Returns:
    
    a list containing the supported geometry operands.
  - getGeometryOperand
```
public TLcdXMLName getGeometryOperand(int aIndex)
```
    Returns the geometry operand at the given index.
    
    Parameters:
    
    aIndex - the index of the geometry operand to retrieve
    
    Returns:
    
    the geometry operand at the given index.
  - addSpatialOperator
```
public void addSpatialOperator(TLcdOGCSpatialOperator aOperator)
```
    Add a spatial operator to the list of spatial operators specified in this capabilities object.
    
    Parameters:
    
    aOperator - a spatial operator
  - removeSpatialOperator
```
public void removeSpatialOperator(TLcdOGCSpatialOperator aOperator)
```
    Remove the spatial operator aOperator from the list of spatial operators specified in this capabilities object.
    
    Parameters:
    
    aOperator - a spatial operator.
  - addGeometryOperand
```
public void addGeometryOperand(TLcdXMLName aOperand)
```
    Add a geometry operand to the list of geometry operands specified in this capabilities object.
    
    Parameters:
    
    aOperand - an operand that is one of the constants of this class.
  - removeGeometryOperand
```
public void removeGeometryOperand(TLcdXMLName aOperand)
```
    Remove the geometry operand aOperand to the list of geometry operands specified in this capabilities object.
    
    Parameters:
    
    aOperand - an operand

LuciadLightspeedClass TLcdOGCSpatialFilterCapabilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

BBOX

DISJOINT

INTERSECT

INTERSECTS

WITHIN

CROSSES

TOUCHES

EQUALS

OVERLAPS

CONTAINS

DWITHIN

BEYOND

ENVELOPE

LINESTRING

POINT

POLYGON

ARCBYCENTERPOINT

CIRCLEBYCENTERPOINT

ARC

CIRCLE

ARCBYBULGE

BEZIER

CLOTHOID

CUBICSPLINE

GEODESIC

OFFSETCURVE

TRIANGLE

POLYHEDRALSURFACE

TRIANGULATEDSURFACE

TIN

SOLID

Constructor Detail

TLcdOGCSpatialFilterCapabilities

TLcdOGCSpatialFilterCapabilities

Method Detail

getSpatialOperatorCount

getSpatialOperators

getSpatialOperator

getGeometryOperandCount

getGeometryOperands

getGeometryOperand

addSpatialOperator

removeSpatialOperator

addGeometryOperand

removeGeometryOperand