Overview (Parsing API Indexing)

Parsing API Indexing
Package	Description
org.netbeans.modules.parsing.api.indexing
org.netbeans.modules.parsing.spi.indexing
org.netbeans.modules.parsing.spi.indexing.support

IndexingAPI Indexing API allows all clients to request (re)indexing of a certain index, or certain root of project sources. Indexing SPIs allow module owners to implement indexer for a particular feature or language.

This API was historically part of Parsing API, but was separated into its own module.

What is New (see all changes)?

Sep 14 '21 Allow plugins to exclude files from being indexed.

There are situations where it is desireable to exclude files from the NetBeans indexing infrastructure. Implementors of IndexabilityQueryImplementation are queried whether an indexer should be invoked for a given file.

Indexing for a file can be rejected verbatim (boolean preventIndexing(FileObject fo)) or more specific by indexer name, URL to the file to be indexed and the UTL of the indexing root. boolean preventIndexing(String indexerName, URL indexable, URL rootUrl).

One such example are Angular projects, where code assistence is provided by the typescript integration by the language server. In these cases the node_modules folder often contains huge amounts of javascript code, that the IDE user does not need to be indexed, but which take a lot of time to parse. A hypothetical plugin could check if an angular.json file is present and then prevent the js indexer from indexing files in the node_modules directory.
Jul 28 '21 Allow Parsers to adjust results for indexing

Parsers may need to provide reduced data for indexing, or enriched data for source parsing. The added isIndexingTask() method identifies tasks applied by indexing infrastructure.
Apr 14 '15 Added custom camel case support into QuerySupport

Added a support for custom camel case separators and custom camel case parts into QuerySupport
Apr 20 '14 Indexing API separated to its own module

Historically the module offered both APIs for Parsing (invoking parser, implementing parser) and Indexing (refresh index, index SPIs). Those APIs are typically used by unrelated pieces of code, possibly with the exception of "refresh" actions.

The indexing now resides separately in its parsing.indexing module. Binary compatibility is kept by using module-auto-deps.xml.

Please also refer to the API Changes document of the parental module.

Use Cases

Indexing API client may request that some or all indexes should be rebuilt for a certain or all project source roots, or certain files. The indexing infrastructure eventually rebuilds the indexes. The API client may choose to wait for the indexing to complete.
Module implementor may plug into the indexing system by declaring a CustomIndexer, BinaryIndexer, or EmbeddingIndexer. The implementation is called at appropriate time to generate or refresh index information for portion of project sources.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
IndexingAPI	Exported	Stable	index.html

Group of logger interfaces

Interface Name In/Out Stability Specified in What Document?

org.netbeans.ui.indexing

Exported

Under Development

Since version 1.47 the RepositorUpdater cooperates with UI Gestures Collector by sending following messages to the org.netbeans.ui.indexing logger:

INDEXING_STARTED - message about a start of indexing (up to date check). Arguments:
- {0}: Long - the time from the last indexing
INDEXING_FINISHED - message about an end of indexing (up to date check). Arguments:
- {0}: Long - the time of indexing
- For each indexer following 3 records are logged
  - {1}: String - name of indexer
  - {2}: Integer - indexer invocation count
  - {3}: Integer - indexing time spent in given indexer

Implementation Details

Where are the sources for the module?

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

XXX no answer for deploy-dependencies

Read more about the implementation in the answers to architecture questions.

Parsing API IndexingStable