Pipeline Javadocs

The pipeline Javadocs provide detailed information about the Java classes, methods, and variables used in Fusion’s query and indexing pipelines:

• Index Stage SDK Javadocs
• Query Stage SDK Javadocs

The javadocs are organized by tabs that include information about the Java elements. Some tabs are only accessible by drilling down from a higher element.

​

Overview

The Overview tab is the main landing page for the javadocs. The default view shows a list of packages. It includes links to All Classes to view an alphabetical list of all classes included in the javadocs for a release. From the Overview tab you can select a package that takes you to the Package tab.

​

Package

The Package tab list summaries for the package, for example class summaries, enum summaries, and interface summaries. Selecting one of the summaries leads you to the Class tab.

​

Class

The Class tab contains links for All Known Implementing Classes. A Constructor Summary table is included if the class contains constructors. A Method Summary table is included that lists all methods used with the class. Details are given for methods that are inherited from other classes. Detail lists are used for any constructors or methods and lists them alphabetically.

​

Tree

The Tree tab shows package, class, interface, and enum hierarchies. To view a hierarchy for a particular package, select the package from the list of Package Hierarchies.

​

Deprecated

The Deprecated tab lists any fields, methods, or constructors that are no longer recommended for use.

​

Index

The Index tab is an alphabetical list of all classes, methods, constructors, and variables. A deprecation notice is included for any elements that are deprecated.

​

Help

The Help tab gives additional details on how the javadocs are organized.