Package com.luciad.lucy.addons

Class ALcyAddOn

java.lang.Object
com.luciad.lucy.addons.ALcyAddOn
Direct Known Subclasses:
ALcyDefaultAddOn, ALcyPreferencesAddOn, TLcyAboutBoxAddon, TLcyAIXM51RealtimeAddOn, TLcyASDIDecoderAddOn, TLcyBCIDecoderAddOn, TLcyDAFIFAddOn, TLcyDataRepositoryAddOn, TLcyDGNDecoderAddOn, TLcyDIMAPDecoderAddOn, TLcyDWGDecoderAddOn, TLcyEarthAddOn, TLcyECWDecoderAddOn, TLcyExportAddOn, TLcyGeoSPOTDecoderAddOn, TLcyGotoAreaOfInterestAddOn, TLcyGRIBDecoderAddOn, TLcyGridAddOn, TLcyGridCoordinateAddOn, TLcyHyperlinkAddOn, TLcyJPEG2000DecoderAddOn, TLcyKML22RealtimeAddOn, TLcyLookAndFeelAddOn, TLcyLspFallbackFormatAddOn, TLcyLspGridCoordinateAddOn, TLcyLspToteAddOn, TLcyLVDBMilitaryAddOn, TLcyMagneticNorthAddOn, TLcyMapAddOn, TLcyMapColorAddOn, TLcyMapOverviewAddOn, TLcyMapRadarViewAddOn, TLcyMapRotationAddOn, TLcyMapWorkSpaceAddon, TLcyModelReferenceAddOn, TLcyMrSidDecoderAddOn, TLcyNITFDecoderAddOn, TLcyOpenFlightDecoderAddOn, TLcyOracleGeoRasterDecoderAddOn, TLcyOracleLocatorDecoderAddOn, TLcyPersistentPreferencesAddOn, TLcyPOLDecoderAddOn, TLcyPreviewAddOn, TLcyPrintAddOn, TLcySearchAddOn, TLcySelectionEditorAddOn, TLcySwissDHMMatrixDecoderAddOn, TLcyTEAControllerAddOn, TLcyToteAddOn, TLcyTreeTableViewAddOn, TLcyUndoAddOn, TLcyUSRPDecoderAddOn, TLcyVerticalViewAddOn, TLcyViewshedOpenFlightAddOn, TLcyVPFDecoderAddOn
public abstract class ALcyAddOn extends Object

An ALcyAddOn is the basic block in Lucy for contributing functionality.

Every addon needs a default constructor, because the implementing classes will be instantiated by the Lucy frontend when the addon is loaded.

It is the responsibility of the Lucy frontend to load the addons. The default frontend uses the TLcyXMLAddOnLoader, which reads an XML file to determine which addons need to be loaded and what their configuration source names are.

See Also:
  • "The Lucy Developer Guide"

  • Constructor Details

    • ALcyAddOn

      protected ALcyAddOn()
      Creates a new ALcyAddOn.

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Returns the display name of this addon. This name can be used, for instance, in a progress bar to indicate which addon is being loaded.
      Returns:
      The display name of this addon. This name could be null.

    • setDisplayName

      public void setDisplayName(String aDisplayName)
      Sets the display name for this addon. This name can be used, for instance, in a progress bar to indicate which addon is being loaded.
      Parameters:
      aDisplayName - The display name for this addon. This name may be null.

    • plugInto

      public abstract void plugInto(ILcyLucyEnv aLucyEnv)
      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.
      Parameters:
      aLucyEnv - The lucy environment to plug into.
      See Also:

    • unplugFrom

      public abstract void unplugFrom(ILcyLucyEnv aLucyEnv)
      Unplugs this addon from the given Lucy environment. It removes the functionality previously added to the Lucy backend.
      Parameters:
      aLucyEnv - The lucy environment to unplug from.
      See Also:

    • getConfigSourceName

      public String getConfigSourceName()
      Returns the configuration source name. The addon can retrieve its configuration details from this source name.
      Returns:
      The configuration source name. It can be null.

    • setConfigSourceName

      public void setConfigSourceName(String aConfigSourceName)
      Sets the configuration source name. The addon can retrieve its configuration details from this source name.
      Parameters:
      aConfigSourceName - The configuration source name. It may be null.