mil.nga.sf.util.filter

Class PointFiniteFilter

java.lang.Object

mil.nga.sf.util.filter.PointFiniteFilter

All Implemented Interfaces:

GeometryFilter

public class PointFiniteFilter
extends Object
implements GeometryFilter

Point filter for finite checks on x and y properties, optionally filter on z and m properties and non finite values (NaN or infinity)

Since:

2.0.3

Author:

osbornb

Constructor Summary

Constructors

Constructor and Description
PointFiniteFilter() Default Constructor, filter on x and y, allowing only finite values
PointFiniteFilter(boolean filterZ) Constructor, filter on x, y, and optionally z
PointFiniteFilter(boolean filterZ, boolean filterM) Constructor, filter on x, y, and optionally z and m
PointFiniteFilter(FiniteFilterType type) Constructor, filter on x and y
PointFiniteFilter(FiniteFilterType type, boolean filterZ) Constructor, filter on x, y, and optionally z
PointFiniteFilter(FiniteFilterType type, boolean filterZ, boolean filterM) Constructor, filter on x, y, and optionally z and m

Method Summary

Modifier and Type	Method and Description
boolean	filter(GeometryType containingType, Geometry geometry) Filter the geometry
FiniteFilterType	getType() Get the finite filter type
boolean	isFilterM() Is filtering for m values enabled?
boolean	isFilterZ() Is filtering for z values enabled?
void	setFilterM(boolean filterM) Set the m value filtering mode
void	setFilterZ(boolean filterZ) Set the z value filtering mode
void	setType(FiniteFilterType type) Set the finite filter type, null defaults to FiniteFilterType.FINITE

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PointFiniteFilter

public PointFiniteFilter()

Default Constructor, filter on x and y, allowing only finite values

PointFiniteFilter

public PointFiniteFilter(FiniteFilterType type)

Constructor, filter on x and y

Parameters:

type - finite filter type

PointFiniteFilter

public PointFiniteFilter(FiniteFilterType type,
                         boolean filterZ)

Constructor, filter on x, y, and optionally z

Parameters:

type - finite filter type

filterZ - filter z values mode

PointFiniteFilter

public PointFiniteFilter(FiniteFilterType type,
                         boolean filterZ,
                         boolean filterM)

Constructor, filter on x, y, and optionally z and m

Parameters:

type - finite filter type

filterZ - filter z values mode

filterM - filter m values mode

PointFiniteFilter

public PointFiniteFilter(boolean filterZ)

Constructor, filter on x, y, and optionally z

Parameters:

filterZ - filter z values mode

PointFiniteFilter

public PointFiniteFilter(boolean filterZ,
                         boolean filterM)

Constructor, filter on x, y, and optionally z and m

Parameters:

filterZ - filter z values mode

filterM - filter m values mode

Method Detail

getType

public FiniteFilterType getType()

Get the finite filter type

Returns:

finite filter type

setType

public void setType(FiniteFilterType type)

Set the finite filter type, null defaults to FiniteFilterType.FINITE

Parameters:

type - finite filter type

isFilterZ

public boolean isFilterZ()

Is filtering for z values enabled?

Returns:

true if z filtering

setFilterZ

public void setFilterZ(boolean filterZ)

Set the z value filtering mode

Parameters:

filterZ - true to z filter

isFilterM

public boolean isFilterM()

Is filtering for m values enabled?

Returns:

true if m filtering

setFilterM

public void setFilterM(boolean filterM)

Set the m value filtering mode

Parameters:

filterM - true to m filter

filter

public boolean filter(GeometryType containingType,
                      Geometry geometry)

Filter the geometry

Specified by:

filter in interface GeometryFilter

Parameters:

containingType - geometry type of the geometry containing this geometry element, null if geometry is top level

geometry - geometry, may be modified

Returns:

true if passes filter and geometry should be included