Package org.machanism.machai.bindex.builder

Class BindexBuilder

java.lang.Object

org.machanism.machai.bindex.builder.BindexBuilder

Direct Known Subclasses:

JScriptBindexBuilder, MavenBindexBuilder, PythonBindexBuilder

public class BindexBuilder
extends Object

Builds and generates Bindex documents from a supplied ProjectLayout using GenAI.

Supports schema prompt, project context retrieval, and AI-driven Bindex creation.

Usage example:

     BindexBuilder builder = new BindexBuilder(layout);
     builder.genAIProvider(provider);
      Bindex bindex = builder.build();
 

Since:

0.0.2

Author:

Viktor Tovstyi

See Also:

• BindexBuilderFactory
• ProjectLayout

Field Summary

Fields

Modifier and Type	Field	Description
static String	BINDEX_SCHEMA_RESOURCE	Path to the Bindex schema resource file.
static final String	BINDEX_TEMP_DIR	Temp directory path for assembly inputs.

Constructor Summary

Constructors

Constructor	Description
BindexBuilder(ProjectLayout projectLayout)	Constructs a BindexBuilder for the specified ProjectLayout.

Method Summary

Modifier and Type	Method	Description
static void	bindexSchemaPrompt(org.machanism.machai.ai.manager.GenAIProvider provider)	Issues a schema prompt to GenAIProvider for Bindex schema setup.
Bindex	build()	Builds a new Bindex, using possible schema prompt, origin update, and AI generation.
BindexBuilder	genAIProvider(org.machanism.machai.ai.manager.GenAIProvider genAIProvider)	Sets the GenAIProvider for this builder.
org.machanism.machai.ai.manager.GenAIProvider	getGenAIProvider()	Returns the GenAIProvider for building.
Bindex	getOrigin()	Gets the origin Bindex instance.
ProjectLayout	getProjectLayout()	Returns the ProjectLayout for this builder.
BindexBuilder	origin(Bindex bindex)	Sets the origin Bindex for update operations.
protected void	projectContext()	Defines project context if needed for the assembly (to be overridden).

Methods inherited from class java.lang.Object

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

Field Details

BINDEX_TEMP_DIR

public static final String BINDEX_TEMP_DIR

Temp directory path for assembly inputs.

See Also:

• Constant Field Values

BINDEX_SCHEMA_RESOURCE

public static String BINDEX_SCHEMA_RESOURCE

Path to the Bindex schema resource file.

Constructor Details

BindexBuilder

public BindexBuilder(ProjectLayout projectLayout)

Constructs a BindexBuilder for the specified ProjectLayout.

Parameters:

projectLayout - A project layout to analyze for Bindex generation.

Method Details

build

public Bindex build()
             throws IOException

Builds a new Bindex, using possible schema prompt, origin update, and AI generation.

Returns:

Newly created Bindex object, or null on failure.

Throws:

IOException - When prompt or log operations fail, or result cannot be parsed.

projectContext

protected void projectContext()
                       throws IOException

Defines project context if needed for the assembly (to be overridden).

Throws:

IOException - if project context cannot be established.

bindexSchemaPrompt

public static void bindexSchemaPrompt(org.machanism.machai.ai.manager.GenAIProvider provider)
                               throws IOException

Issues a schema prompt to GenAIProvider for Bindex schema setup.

Parameters:

provider - GenAIProvider to receive schema instructions.

Throws:

IOException - On prompt or IO errors.

origin

public BindexBuilder origin(Bindex bindex)

Sets the origin Bindex for update operations.

Parameters:

bindex - Origin Bindex instance for updates.

Returns:

This BindexBuilder instance for chain usage.

getOrigin

public Bindex getOrigin()

Gets the origin Bindex instance.

Returns:

The currently set origin Bindex (may be null).

getGenAIProvider

public org.machanism.machai.ai.manager.GenAIProvider getGenAIProvider()

Returns the GenAIProvider for building.

Returns:

GenAIProvider used for prompts.

genAIProvider

public BindexBuilder genAIProvider(org.machanism.machai.ai.manager.GenAIProvider genAIProvider)

Sets the GenAIProvider for this builder.

Parameters:

genAIProvider - Provider instance.

Returns:

This BindexBuilder for chain calls.

getProjectLayout

public ProjectLayout getProjectLayout()

Returns the ProjectLayout for this builder.

Returns:

ProjectLayout used for analysis.