FeatureOverlayQuery (geopackage-sdk 1.1.0 API)

java.lang.Object
- mil.nga.geopackage.tiles.overlay.FeatureOverlayQuery

```
public class FeatureOverlayQuery
extends java.lang.Object
```
Used to query the features represented by the tiles drawn in a FeatureOverlay

Since:

1.1.0

Constructor Summary

Constructors
Constructor and Description

FeatureOverlayQuery(android.content.Context context, FeatureOverlay featureOverlay)
Constructor

Constructors
Constructor and Description
`FeatureOverlayQuery(android.content.Context context, FeatureOverlay featureOverlay)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoundingBox`	`buildClickBoundingBox(LatLng latLng, android.view.View view, GoogleMap map)` Build a bounding box using the click location, map view, and map.
`java.lang.String`	`buildMapClickMessage(LatLng latLng, android.view.View view, GoogleMap map)` Perform a query based upon the map click location and build a info message
`java.lang.String`	`buildMaxFeaturesInfoMessage(long tileFeaturesCount)` Get a max features information message
`java.lang.String`	`buildResultsInfoMessage(FeatureIndexResults results)` Build a feature results information message
`java.lang.String`	`buildResultsInfoMessage(FeatureIndexResults results, LatLng clickLocation)` Build a feature results information message
`java.lang.String`	`buildResultsInfoMessageAndClose(FeatureIndexResults results)` Build a feature results information message and close the results
`java.lang.String`	`buildResultsInfoMessageAndClose(FeatureIndexResults results, LatLng clickLocation)` Build a feature results information message and close the results
`float`	`getCurrentZoom(GoogleMap map)` Get the current zoom level of the map
`FeatureOverlay`	`getFeatureOverlay()` Get the feature overlay
`FeatureTiles`	`getFeatureTiles()` Get the feature tiles
`GeometryType`	`getGeometryType()` Get the geometry type
`int`	`getMaxFeatureDetailedInfo()` Get the max features in a query to print detailed results about
`int`	`getMaxPointDetailedInfo()` Get the max points in a query to print detailed results about
`java.lang.String`	`getName()` Get the name used in text
`float`	`getScreenClickPercentage()` Get the screen click percentage, between 0.0 and 1.0
`boolean`	`isDetailedInfoPrintFeatures()` Is the detailed info going to print feature geometries
`boolean`	`isDetailedInfoPrintPoints()` Is the detailed info going to print point geometries
`boolean`	`isMoreThanMaxFeatures(long tileFeaturesCount)` Determine if the provided count of features in the tile is more than the configured max features per tile
`boolean`	`isOnAtCurrentZoom(GoogleMap map)` Determine if the the feature overlay is on for the current zoom level of the map
`FeatureIndexResults`	`queryFeatures(BoundingBox boundingBox)` Query for features in the WGS84 projected bounding box
`FeatureIndexResults`	`queryFeatures(BoundingBox boundingBox, mil.nga.geopackage.projection.Projection projection)` Query for features in the bounding box
`void`	`setDetailedInfoPrintFeatures(boolean detailedInfoPrintFeatures)` Set the detailed info to print feature geometries
`void`	`setDetailedInfoPrintPoints(boolean detailedInfoPrintPoints)` Set the detailed info to print point geometries
`void`	`setMaxFeatureDetailedInfo(int maxFeatureDetailedInfo)` Set the max features in a query to print detailed results about
`void`	`setMaxPointDetailedInfo(int maxPointDetailedInfo)` Set the max points in a query to print detailed results about
`void`	`setName(java.lang.String name)` Set the name used in text
`void`	`setScreenClickPercentage(float screenClickPercentage)` Set the screen click percentage, between 0.0 and 1.0
`long`	`tileFeatureCount(LatLng latLng, float zoom)` Get the count of features in the tile at the lat lng coordinate and zoom level
`long`	`tileFeatureCount(LatLng latLng, int zoom)` Get the count of features in the tile at the lat lng coordinate and zoom level
`long`	`tileFeatureCount(Point point, float zoom)` Get the count of features in the tile at the point coordinate and zoom level
`long`	`tileFeatureCount(Point point, int zoom)` Get the count of features in the tile at the point coordinate and zoom level

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

- Constructor Detail
  - FeatureOverlayQuery
```
public FeatureOverlayQuery(android.content.Context context,
                           FeatureOverlay featureOverlay)
```
    Constructor
    
    Parameters:
    
    context -
    
    featureOverlay -
- Method Detail
  - getFeatureOverlay
```
public FeatureOverlay getFeatureOverlay()
```
    Get the feature overlay
    
    Returns:
    
    feature overlay
  - getFeatureTiles
```
public FeatureTiles getFeatureTiles()
```
    Get the feature tiles
    
    Returns:
    
    feature tiles
  - getGeometryType
```
public GeometryType getGeometryType()
```
    Get the geometry type
    
    Returns:
    
    geometry type
  - getName
```
public java.lang.String getName()
```
    Get the name used in text
    
    Returns:
    
    name
  - setName
```
public void setName(java.lang.String name)
```
    Set the name used in text
    
    Parameters:
    
    name -
  - getScreenClickPercentage
```
public float getScreenClickPercentage()
```
    Get the screen click percentage, between 0.0 and 1.0
    
    Returns:
    
    screen click percentage
  - setScreenClickPercentage
```
public void setScreenClickPercentage(float screenClickPercentage)
```
    Set the screen click percentage, between 0.0 and 1.0
    
    Parameters:
    
    screenClickPercentage -
  - getMaxPointDetailedInfo
```
public int getMaxPointDetailedInfo()
```
    Get the max points in a query to print detailed results about
    
    Returns:
    
    max point detailed info
  - setMaxPointDetailedInfo
```
public void setMaxPointDetailedInfo(int maxPointDetailedInfo)
```
    Set the max points in a query to print detailed results about
    
    Parameters:
    
    maxPointDetailedInfo -
  - getMaxFeatureDetailedInfo
```
public int getMaxFeatureDetailedInfo()
```
    Get the max features in a query to print detailed results about
    
    Returns:
    
    max feature detailed info
  - setMaxFeatureDetailedInfo
```
public void setMaxFeatureDetailedInfo(int maxFeatureDetailedInfo)
```
    Set the max features in a query to print detailed results about
    
    Parameters:
    
    maxFeatureDetailedInfo -
  - isDetailedInfoPrintPoints
```
public boolean isDetailedInfoPrintPoints()
```
    Is the detailed info going to print point geometries
    
    Returns:
    
    detailed info print points flag
  - setDetailedInfoPrintPoints
```
public void setDetailedInfoPrintPoints(boolean detailedInfoPrintPoints)
```
    Set the detailed info to print point geometries
    
    Parameters:
    
    detailedInfoPrintPoints -
  - isDetailedInfoPrintFeatures
```
public boolean isDetailedInfoPrintFeatures()
```
    Is the detailed info going to print feature geometries
    
    Returns:
    
    detailed info print features flag
  - setDetailedInfoPrintFeatures
```
public void setDetailedInfoPrintFeatures(boolean detailedInfoPrintFeatures)
```
    Set the detailed info to print feature geometries
    
    Parameters:
    
    detailedInfoPrintFeatures -
  - getCurrentZoom
```
public float getCurrentZoom(GoogleMap map)
```
    Get the current zoom level of the map
    
    Parameters:
    
    map -
    
    Returns:
    
    current zoom level
  - isOnAtCurrentZoom
```
public boolean isOnAtCurrentZoom(GoogleMap map)
```
    Determine if the the feature overlay is on for the current zoom level of the map
    
    Parameters:
    
    map -
    
    Returns:
    
    true if on
  - tileFeatureCount
```
public long tileFeatureCount(LatLng latLng,
                             float zoom)
```
    Get the count of features in the tile at the lat lng coordinate and zoom level
    
    Parameters:
    
    latLng - lat lng location
    
    zoom - zoom level
    
    Returns:
  - tileFeatureCount
```
public long tileFeatureCount(LatLng latLng,
                             int zoom)
```
    Get the count of features in the tile at the lat lng coordinate and zoom level
    
    Parameters:
    
    latLng - lat lng location
    
    zoom - zoom level
    
    Returns:
  - tileFeatureCount
```
public long tileFeatureCount(Point point,
                             float zoom)
```
    Get the count of features in the tile at the point coordinate and zoom level
    
    Parameters:
    
    point - point location
    
    zoom - zoom level
    
    Returns:
  - tileFeatureCount
```
public long tileFeatureCount(Point point,
                             int zoom)
```
    Get the count of features in the tile at the point coordinate and zoom level
    
    Parameters:
    
    point - point location
    
    zoom - zoom level
    
    Returns:
  - isMoreThanMaxFeatures
```
public boolean isMoreThanMaxFeatures(long tileFeaturesCount)
```
    Determine if the provided count of features in the tile is more than the configured max features per tile
    
    Parameters:
    
    tileFeaturesCount -
    
    Returns:
    
    true if more than the max features, false if less than or no configured max features
  - buildClickBoundingBox
```
public BoundingBox buildClickBoundingBox(LatLng latLng,
                                         android.view.View view,
                                         GoogleMap map)
```
    Build a bounding box using the click location, map view, and map. The bounding box can be used to query for features that were clicked
    
    Parameters:
    
    latLng - click location
    
    view - view
    
    map - Google map
    
    Returns:
    
    bounding box
  - queryFeatures
```
public FeatureIndexResults queryFeatures(BoundingBox boundingBox)
```
    Query for features in the WGS84 projected bounding box
    
    Parameters:
    
    boundingBox - query bounding box in WGS84 projection
    
    Returns:
    
    feature index results, must be closed
  - queryFeatures
```
public FeatureIndexResults queryFeatures(BoundingBox boundingBox,
                                         mil.nga.geopackage.projection.Projection projection)
```
    Query for features in the bounding box
    
    Parameters:
    
    boundingBox - query bounding box
    
    projection - bounding box projection
    
    Returns:
    
    feature index results, must be closed
  - buildMaxFeaturesInfoMessage
```
public java.lang.String buildMaxFeaturesInfoMessage(long tileFeaturesCount)
```
    Get a max features information message
    
    Parameters:
    
    tileFeaturesCount -
    
    Returns:
    
    max features message
  - buildResultsInfoMessageAndClose
```
public java.lang.String buildResultsInfoMessageAndClose(FeatureIndexResults results)
```
    Build a feature results information message and close the results
    
    Parameters:
    
    results -
    
    Returns:
    
    results message or null if no results
  - buildResultsInfoMessageAndClose
```
public java.lang.String buildResultsInfoMessageAndClose(FeatureIndexResults results,
                                                        LatLng clickLocation)
```
    Build a feature results information message and close the results
    
    Parameters:
    
    results -
    
    clickLocation -
    
    Returns:
    
    results message or null if no results
  - buildResultsInfoMessage
```
public java.lang.String buildResultsInfoMessage(FeatureIndexResults results)
```
    Build a feature results information message
    
    Parameters:
    
    results -
    
    Returns:
    
    results message or null if no results
  - buildResultsInfoMessage
```
public java.lang.String buildResultsInfoMessage(FeatureIndexResults results,
                                                LatLng clickLocation)
```
    Build a feature results information message
    
    Parameters:
    
    results -
    
    clickLocation -
    
    Returns:
    
    results message or null if no results
  - buildMapClickMessage
```
public java.lang.String buildMapClickMessage(LatLng latLng,
                                             android.view.View view,
                                             GoogleMap map)
```
    Perform a query based upon the map click location and build a info message
    
    Parameters:
    
    latLng -
    
    view -
    
    map -
    
    Returns:
    
    information message on what was clicked, or null

Class FeatureOverlayQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FeatureOverlayQuery

Method Detail

getFeatureOverlay

getFeatureTiles

getGeometryType

getName

setName

getScreenClickPercentage

setScreenClickPercentage

getMaxPointDetailedInfo

setMaxPointDetailedInfo

getMaxFeatureDetailedInfo

setMaxFeatureDetailedInfo

isDetailedInfoPrintPoints

setDetailedInfoPrintPoints

isDetailedInfoPrintFeatures

setDetailedInfoPrintFeatures

getCurrentZoom

isOnAtCurrentZoom

tileFeatureCount

tileFeatureCount

tileFeatureCount

tileFeatureCount

isMoreThanMaxFeatures

buildClickBoundingBox

queryFeatures

queryFeatures

buildMaxFeaturesInfoMessage

buildResultsInfoMessageAndClose

buildResultsInfoMessageAndClose

buildResultsInfoMessage

buildResultsInfoMessage

buildMapClickMessage