Package org.machanism.machai.bindex

Class BindexRegister

java.lang.Object

org.machanism.machai.project.ProjectProcessor

org.machanism.machai.bindex.BindexProjectProcessor

org.machanism.machai.bindex.BindexRegister

All Implemented Interfaces:

Closeable, AutoCloseable

public class BindexRegister
extends BindexProjectProcessor
implements Closeable

BindexRegister handles registration and update of Bindex documents for given projects, leveraging Picker for registration id management.

Usage Example:

     try(BindexRegister register = new BindexRegister(provider)) {
         register.processFolder(layout);
     }
 

This class supports registration, ID lookup, and document update via Picker.

Since:

0.0.2

Author:

Viktor Tovstyi

See Also:

• BindexProjectProcessor

Field Summary

Fields inherited from class org.machanism.machai.bindex.BindexProjectProcessor

BINDEX_FILE_NAME

Fields inherited from class org.machanism.machai.project.ProjectProcessor

MACHAI_TEMP_DIR

Constructor Summary

Constructors

Constructor	Description
BindexRegister(org.machanism.machai.ai.manager.GenAIProvider provider, String url)	Constructs a BindexRegister with specified GenAIProvider.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the Picker resource.
void	processFolder(ProjectLayout projectLayout)	Processes folder registration using the provided project layout, optionally updating IDs.
BindexRegister	update(boolean overwrite)	Sets the update mode for registration, enabling overwrite if true.

Methods inherited from class org.machanism.machai.bindex.BindexProjectProcessor

getBindex, getBindexFile

Methods inherited from class org.machanism.machai.project.ProjectProcessor

getProjectLayout, processModule, scanFolder

Methods inherited from class java.lang.Object

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

Constructor Details

BindexRegister

public BindexRegister(org.machanism.machai.ai.manager.GenAIProvider provider,
 String url)

Constructs a BindexRegister with specified GenAIProvider.

Parameters:

provider - GenAIProvider used for Picker instantiation

url -

Method Details

processFolder

public void processFolder(ProjectLayout projectLayout)

Processes folder registration using the provided project layout, optionally updating IDs.

Specified by:

processFolder in class ProjectProcessor

Parameters:

projectLayout - ProjectLayout to process

Throws:

IllegalArgumentException - If an IO error occurs during registration

close

public void close()
           throws IOException

Closes the Picker resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - If Picker close fails

update

public BindexRegister update(boolean overwrite)

Sets the update mode for registration, enabling overwrite if true.

Parameters:

overwrite - Whether to force update registration

Returns:

This BindexRegister instance for chained calls