Package com.luciad.lucy.addons.search

Class TLcySearchAddOn

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.search.TLcySearchAddOn

public final class TLcySearchAddOn
extends ALcyAddOn

This add-on adds search functionality to Lucy. It adds a search box for

• Coordinates: when the coordinates are found, Lucy will mark it on the map and fit on it.
• A property of a model element. For example when you load data containing airspaces, you can search on the name of any of the loaded airspaces. When a hit is found, Lucy will select the airspace and fit on it.
• The name of cities and countries: Lucy will use an online geo-coding service and try to map the city/country name to a location. When a match is found, Lucy will mark it on the map and fit on it.

This add-on is final, and the only possible customization options are listed in the configuration file. However, the source code of this add-on is available as sample code. This allows you to make any customization you can think of. If you want to use the sample code version of this add-on, you need to exclude the search add-on in your addons file, and add an entry for the sample add-on (or for your customized version of the sample add-on):

   <!-- Exclude the standard search add-ons --!>
   <addon>
     <class>com.luciad.lucy.addons.search.TLcySearchAddOn</class>
     <exclude/>
   </addon>

   <!-- Include the sample versions of the add-on --!>
   <addon>
     <name>Search</name>
     <class>samples.lucy.search.SearchAddOn</class>
     <configFile>samples/search/SearchAddOn.cfg</configFile>
   </addon>
 

The sample code javadoc explains how the most common customizations can be done. The package documentation of the samples.lucy.search package is a good starting point.

Since:

2016.0

Constructor Summary

Constructors

Constructor	Description
TLcySearchAddOn()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	plugInto(ILcyLucyEnv aLucyEnv)	Plugs this addon into the given lucy environment.
void	unplugFrom(ILcyLucyEnv aLucyEnv)	Unplugs this addon from the given Lucy environment.

Methods inherited from class com.luciad.lucy.addons.ALcyAddOn

getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Details

TLcySearchAddOn

public TLcySearchAddOn()

Default constructor

Method Details

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyAddOn

Plugs this addon into the given lucy environment. It is in the implementation of this method that the addon adds its functionality to the Lucy backend.

Specified by:

plugInto in class ALcyAddOn

Parameters:

aLucyEnv - The lucy environment to plug into.

See Also:

• ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)

unplugFrom

public void unplugFrom(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyAddOn

Unplugs this addon from the given Lucy environment. It removes the functionality previously added to the Lucy backend.

Specified by:

unplugFrom in class ALcyAddOn

Parameters:

aLucyEnv - The lucy environment to unplug from.

See Also:

• ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)