# Package org.apache.uima.pear.tools

The `org.apache.uima.pear.tools` package provides applications and tools that allow installing PEAR packages containing UIMA-compliant components, verifying serviceability of installed components by using UIMA API and browsing PEAR packages.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  InstallationController.InstallationMonitor | The `InstallationMonitor` interface defines methods required for notifying of component installation status and location of the installed PEAR packages.
  InstallationController.PackageSelector | The `PackageSelector` interface defines methods required for manually or automatically selecting installed PEAR package root directories and PEAR package files.

- Class Summary
  Class | Description
  --- | ---
  InstallationController | The `InstallationController` class allows installing PEAR files that contain UIMA compliant components.
  InstallationController.TestStatus | The `TestStatus` class encapsulates attributes related to the results of the 'serviceability' verification test.
  InstallationDescriptor | The `InstallationDescriptor` class encapsulates all elements and parameters included in the XML Installation Descriptor file.
  InstallationDescriptor.ActionInfo | The `ActionInfo` class defines 'installation action' attributes.
  InstallationDescriptor.ArgInfo | The `ArgInfo` class defines attributes of a service command argument.
  InstallationDescriptor.ComponentInfo | The `ComponentInfo` class defines UIMA component attributes.
  InstallationDescriptor.ServiceInfo | The `ServiceInfo` class defines attributes of a 'service' component.
  InstallationDescriptorHandler | The `InstallationDescriptorHandler` class allows parsing XML installation descriptor files, creating instances of the `InstallationDescriptor` class.
  InstallationProcessor | The `InstallationProcessor` class implements operations specified in the installation descriptor.
  InstallationTester | The `InstallationTester` application allows performing simple verification of the installed UIMA compliant component by using standard UIMA framework interface.
  LocalInstallationAgent | The `LocalInstallationAgent` allows localizing files of UIMA compliant components within the single PEAR structure, and verifying localized component's files using UIMA framework API.
  PackageBrowser | The `PackageBrowser` class allows browsing both archived and unarchived PEAR packages, finding package files and directories, loading installation descriptor files and returning run-time environment settings required for installed components.
  PackageCreator | Utility class to generate a pear package.
  PackageInstaller | The `PackageInstaller` class is the main user API for installing PEAR packages.
  PackageSelectorGUI | The `PackageSelectorGUI` class provides simple Swing-based file dialog windows for selecting root directories of installed PEAR packages, as well as PEAR package files, which contain components that need to be installed.
  PackageSelectorGUI.PackageDirFilter | The `PackageDirFilter` class allows filtering directories.
  PackageSelectorGUI.PackageFileFilter | The `PackageFileFilter` class allows filtering PEAR package files.
  SimplePackageSelector | The `SimplePackageSelector` class provides simple command line dialog for selecting root directories of installed PEAR packages, as well as PEAR package files, which contain components that need to be installed.

- Exception Summary
  Exception | Description
  --- | ---
  PackageCreatorException | Exception thrown if the PEAR package generation fails.
  PackageInstallerException | Exception thrown if PEAR installation fails.

## Package org.apache.uima.pear.tools Description

The `org.apache.uima.pear.tools` package provides applications and tools that allow installing PEAR packages containing UIMA-compliant components, verifying serviceability of installed components by using UIMA API and browsing PEAR packages.

Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.