CartoType Android API 7.8.2, 2022-03-25
for Java development on Android
Public Member Functions | Public Attributes | List of all members
com.cartotype.FindParam Class Reference

Public Member Functions

 FindParam (PointOfInterestType aType, String aText, Geometry aLocation)
 

Public Attributes

int iMaxObjectCount = 0x7FFFFFFF
 
Geometry iClip
 
Geometry iLocation
 
String iLayers
 
String iAttributes
 
String iText
 
int iStringMatchMethod = Framework.EXACT_STRING_MATCH_METHOD
 
String iCondition
 
boolean iMerge = true
 
double iTimeOut = 0.5
 

Detailed Description

Parameters for the general find function.

Constructor & Destructor Documentation

◆ FindParam()

com.cartotype.FindParam.FindParam ( PointOfInterestType  aType,
String  aText,
Geometry  aLocation 
)

Creates a FindParam object for a point of interest type, some text, and a location.

Member Data Documentation

◆ iAttributes

String com.cartotype.FindParam.iAttributes

iAttributes is used in text searching (if iText is non-null). If iAttributes is empty, search all attributes, otherwise iAttributes is a list of attributes separated by spaces or commas; use "$" to indicate the label (the unnamed attribute).

◆ iClip

Geometry com.cartotype.FindParam.iClip

The clip path; no clipping is done if iClip is empty.

◆ iCondition

String com.cartotype.FindParam.iCondition

iCondition, if not empty, is a style sheet condition (e.g., "Type==2") which must be fulfilled by all the objects.

◆ iLayers

String com.cartotype.FindParam.iLayers

A list of layer names separated by spaces or commas. If it is empty all layers are searched. Layer names may contain the wild cards * and ?.

◆ iLocation

Geometry com.cartotype.FindParam.iLocation

The current location. If it is non-empty, objects in or near this region are preferred. It may be a single point.

◆ iMaxObjectCount

int com.cartotype.FindParam.iMaxObjectCount = 0x7FFFFFFF

The maximum number of objects to return.

◆ iMerge

boolean com.cartotype.FindParam.iMerge = true

If iMerge is true (the default), adjoining objects with the same name and attributes may be merged into a single object.

◆ iStringMatchMethod

int com.cartotype.FindParam.iStringMatchMethod = Framework.EXACT_STRING_MATCH_METHOD

The string matching method used for text searching; default = Framework.EXACT_STRING_MATCH_METHOD.

◆ iText

String com.cartotype.FindParam.iText

iText, if not empty, restricts the search to objects containing a string in one of their string attributes.

◆ iTimeOut

double com.cartotype.FindParam.iTimeOut = 0.5

The maximum time in seconds allowed for a find operation. Find operations are not guaranteed to return in this time or less, but will attempt to do so.


The documentation for this class was generated from the following file: