Public Member Functions
	FindParam (int aFeatureType, String aText, Geometry aLocation)

Public Attributes
int	maxObjectCount = 0x7FFFFFFF

Geometry	clip

Geometry	location

String	layers

String	attributes

String	text

int	stringMatchMethod = Framework.EXACT_STRING_MATCH_METHOD

String	condition

boolean	merge = false

double	timeOut = 0.5

Detailed Description

Parameters for the general find function.

Constructor & Destructor Documentation

◆ FindParam()

com.cartotype.FindParam.FindParam	(	int	aFeatureType,
		String	aText,
		Geometry	aLocation
	)

Creates a FindParam object for a feature type, some text, and a location.

Member Data Documentation

◆ attributes

String com.cartotype.FindParam.attributes

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).

◆ clip

Geometry com.cartotype.FindParam.clip

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

◆ condition

String com.cartotype.FindParam.condition

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

◆ layers

String com.cartotype.FindParam.layers

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 ?.

◆ location

Geometry com.cartotype.FindParam.location

The current location. If it is non-empty, objects in or near this region are preferred.

◆ maxObjectCount

int com.cartotype.FindParam.maxObjectCount = 0x7FFFFFFF

The maximum number of objects to return.

◆ merge

boolean com.cartotype.FindParam.merge = false

If iMerge is true adjoining objects with the same name and attributes may be merged into a single object. The default value is false.

◆ stringMatchMethod

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

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

◆ text

String com.cartotype.FindParam.text

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

◆ timeOut

double com.cartotype.FindParam.timeOut = 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. A timeout of zero or less means there is no timeout.

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

src/com/cartotype/FindParam.java

Public Member Functions

Public Attributes