Index (Bindex Core 0.0.2-SNAPSHOT API)

A B C D E F G H I J L M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values

A

ADAPTERS - Enum constant in enum class org.machanism.machai.schema.Layer
addDependencies(Set<String>, String) - Method in class org.machanism.machai.bindex.Picker: Adds all transitive dependencies of a Bindex into the provided set.
ApplicationAssembly - Class in org.machanism.machai.bindex: Handles assembly operations for Bindex projects using GenAIProvider and prompts.
ApplicationAssembly(GenAIProvider) - Constructor for class org.machanism.machai.bindex.ApplicationAssembly: Constructs an ApplicationAssembly using the specified GenAIProvider.
assembly(String, List<Bindex>) - Method in class org.machanism.machai.bindex.ApplicationAssembly: Assemble a Bindex project based on given prompts and instructions.
Author - Class in org.machanism.machai.schema: Describes the author or organization responsible for the artifact.
Author() - Constructor for class org.machanism.machai.schema.Author

B

Bindex - Class in org.machanism.machai.schema: Bindex
Bindex() - Constructor for class org.machanism.machai.schema.Bindex
BINDEX_FILE_NAME - Static variable in class org.machanism.machai.bindex.BindexProjectProcessor: Name of the Bindex document file.
BINDEX_PROPERTY_NAME - Static variable in class org.machanism.machai.bindex.Picker
BINDEX_SCHEMA_RESOURCE - Static variable in class org.machanism.machai.bindex.builder.BindexBuilder: Path to the Bindex schema resource file.
BINDEX_TEMP_DIR - Static variable in class org.machanism.machai.bindex.builder.BindexBuilder: Temp directory path for assembly inputs.
BindexBuilder - Class in org.machanism.machai.bindex.builder: Builds and generates Bindex documents from a supplied ProjectLayout using GenAI.
BindexBuilder(ProjectLayout) - Constructor for class org.machanism.machai.bindex.builder.BindexBuilder: Constructs a BindexBuilder for the specified ProjectLayout.
BindexBuilderFactory - Class in org.machanism.machai.bindex: Factory class for creating BindexBuilder instances based on specific ProjectLayout types.
BindexBuilderFactory() - Constructor for class org.machanism.machai.bindex.BindexBuilderFactory
BindexCreator - Class in org.machanism.machai.bindex: BindexCreator is responsible for generating and updating Bindex representation files for the supplied project layout using a GenAIProvider.
BindexCreator(GenAIProvider) - Constructor for class org.machanism.machai.bindex.BindexCreator: Constructs a BindexCreator with the specified GenAIProvider and LLM invocation setting.
BindexProjectProcessor - Class in org.machanism.machai.bindex: Abstract class providing Bindex utilities for project processing operations.
BindexProjectProcessor() - Constructor for class org.machanism.machai.bindex.BindexProjectProcessor
BindexRegister - Class in org.machanism.machai.bindex: BindexRegister handles registration and update of Bindex documents for given projects, leveraging Picker for registration id management.
BindexRegister(GenAIProvider, String) - Constructor for class org.machanism.machai.bindex.BindexRegister: Constructs a BindexRegister with specified GenAIProvider.
bindexSchemaPrompt(GenAIProvider) - Static method in class org.machanism.machai.bindex.builder.BindexBuilder: Issues a schema prompt to GenAIProvider for Bindex schema setup.
build() - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Builds a new Bindex, using possible schema prompt, origin update, and AI generation.

C

Classification - Class in org.machanism.machai.schema: Categorizes the artifact by type, domain, and supported languages.
Classification() - Constructor for class org.machanism.machai.schema.Classification
close() - Method in class org.machanism.machai.bindex.BindexRegister: Closes the Picker resource.
close() - Method in class org.machanism.machai.bindex.Picker: Closes the resource-backed connections.
Constructor - Class in org.machanism.machai.schema
Constructor() - Constructor for class org.machanism.machai.schema.Constructor
Coordinates - Class in org.machanism.machai.schema: Coordinates identifying the artifact within the repository.
Coordinates() - Constructor for class org.machanism.machai.schema.Coordinates
create(ProjectLayout) - Static method in class org.machanism.machai.bindex.BindexBuilderFactory: Creates a BindexBuilder suitable for the given ProjectLayout type.
create(Bindex) - Method in class org.machanism.machai.bindex.Picker: Registers (inserts or updates) a Bindex document for the supplied Bindex instance.
Customization - Class in org.machanism.machai.schema
Customization() - Constructor for class org.machanism.machai.schema.Customization

D

DEFAULT_MIN_SCORE - Static variable in class org.machanism.machai.bindex.Picker: Default minimum similarity score for queries.
DefaultProjectLayout - Class in org.machanism.machai.project.layout: Provides a default implementation for project layout handling.
DefaultProjectLayout() - Constructor for class org.machanism.machai.project.layout.DefaultProjectLayout
detectProjectLayout(File) - Static method in class org.machanism.machai.project.ProjectLayoutManager: Detects the project layout based on the contents of the specified directory.

E

effectivePomRequired(boolean) - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Enables/disables effective POM calculation for module resolution.
ENTITIES - Enum constant in enum class org.machanism.machai.schema.Layer
equals(Object) - Method in class org.machanism.machai.schema.Author
equals(Object) - Method in class org.machanism.machai.schema.Bindex
equals(Object) - Method in class org.machanism.machai.schema.Classification
equals(Object) - Method in class org.machanism.machai.schema.Constructor
equals(Object) - Method in class org.machanism.machai.schema.Coordinates
equals(Object) - Method in class org.machanism.machai.schema.Customization
equals(Object) - Method in class org.machanism.machai.schema.Example__1
equals(Object) - Method in class org.machanism.machai.schema.Example__2
equals(Object) - Method in class org.machanism.machai.schema.Example__3
equals(Object) - Method in class org.machanism.machai.schema.Example__4
equals(Object) - Method in class org.machanism.machai.schema.Example
equals(Object) - Method in class org.machanism.machai.schema.Feature
equals(Object) - Method in class org.machanism.machai.schema.Language
equals(Object) - Method in class org.machanism.machai.schema.Location
equals(Object) - Method in class org.machanism.machai.schema.Stud
Example - Class in org.machanism.machai.schema
Example() - Constructor for class org.machanism.machai.schema.Example
Example__1 - Class in org.machanism.machai.schema
Example__1() - Constructor for class org.machanism.machai.schema.Example__1
Example__2 - Class in org.machanism.machai.schema
Example__2() - Constructor for class org.machanism.machai.schema.Example__2
Example__3 - Class in org.machanism.machai.schema
Example__3() - Constructor for class org.machanism.machai.schema.Example__3
Example__4 - Class in org.machanism.machai.schema: A usage example object.
Example__4() - Constructor for class org.machanism.machai.schema.Example__4
EXCLUDE_DIRS - Static variable in class org.machanism.machai.project.layout.ProjectLayout: Standard set of excluded directories for project structure analysis.

F

Feature - Class in org.machanism.machai.schema
Feature() - Constructor for class org.machanism.machai.schema.Feature
fromValue(String) - Static method in enum class org.machanism.machai.schema.Layer

G

genAIProvider(GenAIProvider) - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Sets the GenAIProvider for this builder.
getAdditionalProperties() - Method in class org.machanism.machai.schema.Author
getAdditionalProperties() - Method in class org.machanism.machai.schema.Bindex
getAdditionalProperties() - Method in class org.machanism.machai.schema.Classification
getAdditionalProperties() - Method in class org.machanism.machai.schema.Constructor
getAdditionalProperties() - Method in class org.machanism.machai.schema.Coordinates
getAdditionalProperties() - Method in class org.machanism.machai.schema.Customization
getAdditionalProperties() - Method in class org.machanism.machai.schema.Example__1
getAdditionalProperties() - Method in class org.machanism.machai.schema.Example__2
getAdditionalProperties() - Method in class org.machanism.machai.schema.Example__3
getAdditionalProperties() - Method in class org.machanism.machai.schema.Example__4
getAdditionalProperties() - Method in class org.machanism.machai.schema.Example
getAdditionalProperties() - Method in class org.machanism.machai.schema.Feature
getAdditionalProperties() - Method in class org.machanism.machai.schema.Language
getAdditionalProperties() - Method in class org.machanism.machai.schema.Location
getAdditionalProperties() - Method in class org.machanism.machai.schema.Stud
getArtifactId() - Method in class org.machanism.machai.schema.Coordinates: Name of the artifact within its group (e.g., artifactId in Maven).
getAuthors() - Method in class org.machanism.machai.schema.Bindex: (Required)
getBindex(File) - Method in class org.machanism.machai.bindex.BindexProjectProcessor: Loads the Bindex object from the bindex file in a given project directory.
getBindexFile(File) - Method in class org.machanism.machai.bindex.BindexProjectProcessor: Gets the File object for the Bindex document in a given project directory.
getClassification() - Method in class org.machanism.machai.schema.Bindex: Categorizes the artifact by type, domain, and supported languages.
getClassifier() - Method in class org.machanism.machai.schema.Coordinates: Optional classifier providing context (e.g., 'sources', 'javadoc').
getConstructors() - Method in class org.machanism.machai.schema.Bindex: This section should contain information about how the object (service) is created and how it is configured before use.
getCoordinates() - Method in class org.machanism.machai.schema.Location: Coordinates identifying the artifact within the repository.
getCustomizations() - Method in class org.machanism.machai.schema.Bindex: Extension or customization points for developers to extend or modify the artifact's functionality.
getDependencies() - Method in class org.machanism.machai.schema.Bindex: A list of artifact dependencies.
getDescription() - Method in class org.machanism.machai.schema.Bindex: A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications.
getDescription() - Method in class org.machanism.machai.schema.Constructor: Detailed explanation.
getDescription() - Method in class org.machanism.machai.schema.Customization: Detailed description of the extension or customization point.
getDescription() - Method in class org.machanism.machai.schema.Example__1: Detailed description of the example snippet.
getDescription() - Method in class org.machanism.machai.schema.Example__2: Detailed description of the example snippet.
getDescription() - Method in class org.machanism.machai.schema.Example__3: Detailed description of the example snippet.
getDescription() - Method in class org.machanism.machai.schema.Example: Detailed description of the example snippet.
getDescription() - Method in class org.machanism.machai.schema.Feature: Detailed explanation of the feature.
getDescription() - Method in class org.machanism.machai.schema.Stud: Summary of the purpose and intended use of this interface or abstract class.
getDocuments() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of document sources for this project layout.
getDocuments() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Retrieves documentation sources for JS/TS projects.
getDocuments() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of documentation sources for Maven projects.
getDocuments() - Method in class org.machanism.machai.project.layout.ProjectLayout
getDocuments() - Method in class org.machanism.machai.project.layout.PythonProjectLayout: Gets list of document directories for the Python project.
getDomains() - Method in class org.machanism.machai.schema.Classification: Application domains (e.g., Data Processing, Machine Learning).
getEmail() - Method in class org.machanism.machai.schema.Author: Email for support or queries.
getEmbeddingBson(Classification, Integer) - Method in class org.machanism.machai.bindex.Picker: Generates a BSON array representing the embedding of a classification for semantic search.
getExamples() - Method in class org.machanism.machai.schema.Bindex: General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.
getExamples() - Method in class org.machanism.machai.schema.Constructor: Code examples for the object creation.
getExamples() - Method in class org.machanism.machai.schema.Customization: Code examples for the feature.
getExamples() - Method in class org.machanism.machai.schema.Feature: Code examples for the feature.
getExamples() - Method in class org.machanism.machai.schema.Stud: Code examples for the feature.
getExtension() - Method in class org.machanism.machai.schema.Coordinates: File extension or type (e.g., JAR, WAR, tar.gz, whl).
getFeatures() - Method in class org.machanism.machai.schema.Bindex: The primary functions or capabilities provided by the artifact.
getGenAIProvider() - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Returns the GenAIProvider for building.
getGroup() - Method in class org.machanism.machai.schema.Coordinates: Group or namespace of the artifact (e.g., Maven groupId).
getId() - Method in class org.machanism.machai.schema.Bindex: A unique identifier for the artifact.
getImplement() - Method in class org.machanism.machai.schema.Stud: Fully qualified name of the class in this artifact that implements or extends this stub.
getIntegrations() - Method in class org.machanism.machai.schema.Classification: Names of external backing systems the library integrates with (e.g., commercetools, Adyen, Braintree), if supported.
getLanguages() - Method in class org.machanism.machai.schema.Classification: Programming languages supported.
getLayers() - Method in class org.machanism.machai.schema.Classification: Defines which Clean Architecture layers the library belongs to.
getLicense() - Method in class org.machanism.machai.schema.Bindex: License type (e.g., MIT, Apache 2.0, etc.).
getLocation() - Method in class org.machanism.machai.schema.Bindex: Details about the artifact's storage location, repository type, and metadata.
getModel() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns the current Maven Model (parsed pom.xml).
getModules() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns the list of module names present in the project directory excluding standard excluded directories.
getModules() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Gets workspace modules listed in package.json under the "workspaces" key.
getModules() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of modules for Maven projects if packaging is pom.
getModules() - Method in class org.machanism.machai.project.layout.ProjectLayout: Gets a list of project modules.
getName() - Method in class org.machanism.machai.schema.Author: Name of the author or organization.
getName() - Method in class org.machanism.machai.schema.Bindex: The full name of the artifact or library.
getName() - Method in class org.machanism.machai.schema.Customization: Name of the customization or extension point (e.g., class, interface, method).
getName() - Method in class org.machanism.machai.schema.Feature: Name of the function or constructor.
getName() - Method in class org.machanism.machai.schema.Language: The name of the programming language (e.g., Python, Java, C++) (Required)
getName() - Method in class org.machanism.machai.schema.Stud: Fully qualified name of the interface or abstract class, as exported in this artifact.
getNormalizedLanguageName(Language) - Static method in class org.machanism.machai.bindex.Picker: Normalizes a Language name for semantic aggregation queries.
getOrigin() - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Gets the origin Bindex instance.
getPackage() - Method in class org.machanism.machai.schema.Constructor: Name of the package.
getPackage() - Method in class org.machanism.machai.schema.Customization: Name of the package.
getPackage() - Method in class org.machanism.machai.schema.Feature: Name of the package.
getPackage() - Method in class org.machanism.machai.schema.Stud: Name of the package.
getPomProperties() - Static method in class org.machanism.machai.project.layout.PomReader: Returns properties parsed from pom.xml files.
getProjectDir() - Method in class org.machanism.machai.project.layout.ProjectLayout: Gets the current project directory.
getProjectLayout() - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Returns the ProjectLayout for this builder.
getProjectLayout(File) - Method in class org.machanism.machai.project.ProjectProcessor: Returns the detected ProjectLayout for the specified project directory.
getProjectModel(File) - Static method in class org.machanism.machai.project.layout.PomReader: Loads a Maven model from the given file, preferring the effective model but falling back if unsuccessful.
getProjectModel(File, boolean) - Static method in class org.machanism.machai.project.layout.PomReader: Loads and returns the Maven model from a pom.xml file.
getRegistredId(Bindex) - Method in class org.machanism.machai.bindex.Picker: Looks up the registered database ID for a Bindex (if it exists).
getRelatedPath(File, File) - Static method in class org.machanism.machai.project.layout.ProjectLayout: Computes relative path from project directory to target file.
getRelatedPath(File, File, boolean) - Static method in class org.machanism.machai.project.layout.ProjectLayout: Computes relative path, optionally prepending single dot.
getRelatedPath(String, File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Computes relative path from current directory to target file.
getRepositoryType() - Method in class org.machanism.machai.schema.Location: Type of repository (e.g., Maven, NPM, Git, DockerHub, PyPI).
getRepositoryUrl() - Method in class org.machanism.machai.schema.Location: URL of the repository hosting the artifact.
getScore(String) - Method in class org.machanism.machai.bindex.Picker: Retrieves similarity score for a Bindex result by its ID.
getSignature() - Method in class org.machanism.machai.schema.Constructor: The complete method signature, where all parameter and exception types are fully qualified with their package names (e.g., 'java.util.Listinvalid input: '<'java.lang.String> methodName(java.lang.String param) throws java.io.IOException').
getSignature() - Method in class org.machanism.machai.schema.Feature: The complete method signature, where all parameter and exception types are fully qualified with their package names (e.g., 'java.util.Listinvalid input: '<'java.lang.String> methodName(java.lang.String param) throws java.io.IOException').
getSnippet() - Method in class org.machanism.machai.schema.Example__1: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
getSnippet() - Method in class org.machanism.machai.schema.Example__2: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
getSnippet() - Method in class org.machanism.machai.schema.Example__3: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
getSnippet() - Method in class org.machanism.machai.schema.Example: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
getSources() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of sources for this project layout.
getSources() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Retrieves source directories for JS/TS projects.
getSources() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of source directories by inspecting the Maven build section.
getSources() - Method in class org.machanism.machai.project.layout.ProjectLayout
getSources() - Method in class org.machanism.machai.project.layout.PythonProjectLayout: Gets list of source directories for the Python project.
getStuds() - Method in class org.machanism.machai.schema.Bindex: A list of interfaces or abstract classes defined in this artifact, intended for implementation or extension by other modules to support forking, plugin, or extension scenarios.
getTargetEnvironment() - Method in class org.machanism.machai.schema.Classification: A property that defines the fundamental runtime or platform required for the library to function.
getTests() - Method in class org.machanism.machai.project.layout.DefaultProjectLayout: Returns a list of test sources for this project layout.
getTests() - Method in class org.machanism.machai.project.layout.JScriptProjectLayout: Retrieves test sources for JS/TS projects.
getTests() - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Returns a list of test directories by inspecting the Maven build section.
getTests() - Method in class org.machanism.machai.project.layout.ProjectLayout
getTests() - Method in class org.machanism.machai.project.layout.PythonProjectLayout: Gets list of test source directories for the Python project.
getType() - Method in class org.machanism.machai.schema.Classification: Type of the artifact (e.g., library, plugin, module).
getType() - Method in class org.machanism.machai.schema.Customization: Type of customization point (e.g., method, interface, configuration property).
getType() - Method in class org.machanism.machai.schema.Stud: Kind of stub: always 'interface' or 'abstract class' as provided by this artifact.
getUsageContext() - Method in class org.machanism.machai.schema.Classification: Specifies the contexts or environments in which the library can be used.
getVersion() - Method in class org.machanism.machai.schema.Bindex: Version of the artifact (e.g., semantic versioning, tag, or hash).
getVersion() - Method in class org.machanism.machai.schema.Coordinates: Version of the artifact.
getVersion() - Method in class org.machanism.machai.schema.Language: The version of the programming language (e.g., 3.9.1, 11, 17) (Required)
getWebsite() - Method in class org.machanism.machai.schema.Author: Link to the website or documentation.

H

hashCode() - Method in class org.machanism.machai.schema.Author
hashCode() - Method in class org.machanism.machai.schema.Bindex
hashCode() - Method in class org.machanism.machai.schema.Classification
hashCode() - Method in class org.machanism.machai.schema.Constructor
hashCode() - Method in class org.machanism.machai.schema.Coordinates
hashCode() - Method in class org.machanism.machai.schema.Customization
hashCode() - Method in class org.machanism.machai.schema.Example__1
hashCode() - Method in class org.machanism.machai.schema.Example__2
hashCode() - Method in class org.machanism.machai.schema.Example__3
hashCode() - Method in class org.machanism.machai.schema.Example__4
hashCode() - Method in class org.machanism.machai.schema.Example
hashCode() - Method in class org.machanism.machai.schema.Feature
hashCode() - Method in class org.machanism.machai.schema.Language
hashCode() - Method in class org.machanism.machai.schema.Location
hashCode() - Method in class org.machanism.machai.schema.Stud

I

INFRASTRUCTURE - Enum constant in enum class org.machanism.machai.schema.Layer
INTERACTORS - Enum constant in enum class org.machanism.machai.schema.Layer
isMavenProject(File) - Static method in class org.machanism.machai.project.layout.MavenProjectLayout: Checks if the given directory is a Maven project by looking for pom.xml.
isPackageJsonPresent(File) - Static method in class org.machanism.machai.project.layout.JScriptProjectLayout: Checks if the specified directory contains a package.json file, indicating a JS/TS project.
isPythonProject(File) - Static method in class org.machanism.machai.project.layout.PythonProjectLayout: Checks whether the provided directory is a Python project.

J

JScriptBindexBuilder - Class in org.machanism.machai.bindex.builder: JScriptBindexBuilder provides project context and source file analysis for JavaScript/TypeScript/Vue projects.
JScriptBindexBuilder(ProjectLayout) - Constructor for class org.machanism.machai.bindex.builder.JScriptBindexBuilder: Constructs a JScriptBindexBuilder for a JS/TS/Vue project layout.
JScriptProjectLayout - Class in org.machanism.machai.project.layout: A project layout utility for JavaScript/TypeScript-based projects.
JScriptProjectLayout() - Constructor for class org.machanism.machai.project.layout.JScriptProjectLayout

L

Language - Class in org.machanism.machai.schema: The implementation language.
Language() - Constructor for class org.machanism.machai.schema.Language
Layer - Enum Class in org.machanism.machai.schema
Location - Class in org.machanism.machai.schema: Details about the artifact's storage location, repository type, and metadata.
Location() - Constructor for class org.machanism.machai.schema.Location

M

MavenBindexBuilder - Class in org.machanism.machai.bindex.builder: MavenBindexBuilder provides project context and source manifest aggregation for Maven projects.
MavenBindexBuilder(MavenProjectLayout) - Constructor for class org.machanism.machai.bindex.builder.MavenBindexBuilder: Constructs a MavenBindexBuilder for a Maven-based layout.
MavenProjectLayout - Class in org.machanism.machai.project.layout: A Maven-specific implementation for project layout.
MavenProjectLayout() - Constructor for class org.machanism.machai.project.layout.MavenProjectLayout
model(Model) - Method in class org.machanism.machai.project.layout.MavenProjectLayout: Sets the Maven Model for chaining configuration.

O

org.machanism.machai.bindex - package org.machanism.machai.bindex: Provides classes and utilities for creating, assembling, registering, and managing Bindex documents and semantic search capabilities using AI-powered technologies and MongoDB vector search.
org.machanism.machai.bindex.builder - package org.machanism.machai.bindex.builder: Provides builder implementations for generating Bindex documents in support of semantic, AI-powered indexing operations.
org.machanism.machai.project - package org.machanism.machai.project: Provides core classes for project structure detection and processing in Machanism systems.
org.machanism.machai.project.layout - package org.machanism.machai.project.layout
org.machanism.machai.schema - package org.machanism.machai.schema
origin(Bindex) - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Sets the origin Bindex for update operations.

P

pick(String) - Method in class org.machanism.machai.bindex.Picker: Performs a semantic pick/search with a query string, retrieving Bindex results and dependencies.
Picker - Class in org.machanism.machai.bindex: Picker handles Bindex registration, lookup, and semantic queries using embeddings and MongoDB.
Picker(GenAIProvider, String) - Constructor for class org.machanism.machai.bindex.Picker: Constructs a Picker for registration and semantic search.
PomReader - Class in org.machanism.machai.project.layout: Utility for reading and processing Maven pom.xml files into Maven models.
PomReader() - Constructor for class org.machanism.machai.project.layout.PomReader
printModel(Model) - Static method in class org.machanism.machai.project.layout.PomReader: Serializes a Maven Model to its string (XML) representation.
processFolder(ProjectLayout) - Method in class org.machanism.machai.bindex.BindexCreator: Processes the specified project layout folder to create/update the Bindex file.
processFolder(ProjectLayout) - Method in class org.machanism.machai.bindex.BindexRegister: Processes folder registration using the provided project layout, optionally updating IDs.
processFolder(ProjectLayout) - Method in class org.machanism.machai.project.ProjectProcessor: Processes a project folder layout.
processModule(File, String) - Method in class org.machanism.machai.project.ProjectProcessor: Processes a given project module by recursively scanning.
PROJECT_MODEL_FILE_NAME - Static variable in class org.machanism.machai.project.layout.JScriptProjectLayout
projectContext() - Method in class org.machanism.machai.bindex.builder.BindexBuilder: Defines project context if needed for the assembly (to be overridden).
projectContext() - Method in class org.machanism.machai.bindex.builder.JScriptBindexBuilder: Provides prompts for manifest and sources for GenAI model context.
projectContext() - Method in class org.machanism.machai.bindex.builder.MavenBindexBuilder: Provides prompts for Maven project sources and manifest to GenAI context.
projectContext() - Method in class org.machanism.machai.bindex.builder.PythonBindexBuilder: Provides project manifest and main sources context to GenAIProvider for Bindex generation.
projectDir(File) - Method in class org.machanism.machai.bindex.ApplicationAssembly: Specifies the project directory for assembly operations.
projectDir(File) - Method in class org.machanism.machai.project.layout.ProjectLayout: Sets the current project directory (used by derived layout implementations).
ProjectLayout - Class in org.machanism.machai.project.layout: Abstract base class for project layout structures.
ProjectLayout() - Constructor for class org.machanism.machai.project.layout.ProjectLayout
ProjectLayoutManager - Class in org.machanism.machai.project: Manages detection and instantiation of specific ProjectLayout implementations based on the structure of a given project directory.
ProjectLayoutManager() - Constructor for class org.machanism.machai.project.ProjectLayoutManager
ProjectProcessor - Class in org.machanism.machai.project: Abstract base class for processing project structures and modules.
ProjectProcessor() - Constructor for class org.machanism.machai.project.ProjectProcessor
PythonBindexBuilder - Class in org.machanism.machai.bindex.builder: PythonBindexBuilder provides project context and manifest aggregation for Python (pyproject.toml) projects.
PythonBindexBuilder(ProjectLayout) - Constructor for class org.machanism.machai.bindex.builder.PythonBindexBuilder: Constructs a PythonBindexBuilder for Python projects with pyproject.toml.
PythonProjectLayout - Class in org.machanism.machai.project.layout: Project layout implementation for Python-based projects.
PythonProjectLayout() - Constructor for class org.machanism.machai.project.layout.PythonProjectLayout

R

removeNotImportantData(Model) - Method in class org.machanism.machai.bindex.builder.MavenBindexBuilder: Removes unimportant fields from a Maven Model before sending as context to GenAIProvider.

S

scanFolder(File) - Method in class org.machanism.machai.project.ProjectProcessor: Scans the main project directory, detects modules, and processes them.
serviceLocator() - Static method in class org.machanism.machai.project.layout.PomReader: Configures a Maven ServiceLocator with repository and transporter services.
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Author
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Bindex
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Classification
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Constructor
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Coordinates
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Customization
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Example__1
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Example__2
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Example__3
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Example__4
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Example
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Feature
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Language
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Location
setAdditionalProperty(String, Object) - Method in class org.machanism.machai.schema.Stud
setArtifactId(String) - Method in class org.machanism.machai.schema.Coordinates: Name of the artifact within its group (e.g., artifactId in Maven).
setAuthors(List<Author>) - Method in class org.machanism.machai.schema.Bindex: (Required)
setClassification(Classification) - Method in class org.machanism.machai.schema.Bindex: Categorizes the artifact by type, domain, and supported languages.
setClassifier(String) - Method in class org.machanism.machai.schema.Coordinates: Optional classifier providing context (e.g., 'sources', 'javadoc').
setConstructors(List<Constructor>) - Method in class org.machanism.machai.schema.Bindex: This section should contain information about how the object (service) is created and how it is configured before use.
setCoordinates(Coordinates) - Method in class org.machanism.machai.schema.Location: Coordinates identifying the artifact within the repository.
setCustomizations(List<Customization>) - Method in class org.machanism.machai.schema.Bindex: Extension or customization points for developers to extend or modify the artifact's functionality.
setDependencies(List<String>) - Method in class org.machanism.machai.schema.Bindex: A list of artifact dependencies.
setDescription(String) - Method in class org.machanism.machai.schema.Bindex: A critical property for bindex.json that is used to generate embeddings for semantic search in assembling customer applications.
setDescription(String) - Method in class org.machanism.machai.schema.Constructor: Detailed explanation.
setDescription(String) - Method in class org.machanism.machai.schema.Customization: Detailed description of the extension or customization point.
setDescription(String) - Method in class org.machanism.machai.schema.Example__1: Detailed description of the example snippet.
setDescription(String) - Method in class org.machanism.machai.schema.Example__2: Detailed description of the example snippet.
setDescription(String) - Method in class org.machanism.machai.schema.Example__3: Detailed description of the example snippet.
setDescription(String) - Method in class org.machanism.machai.schema.Example: Detailed description of the example snippet.
setDescription(String) - Method in class org.machanism.machai.schema.Feature: Detailed explanation of the feature.
setDescription(String) - Method in class org.machanism.machai.schema.Stud: Summary of the purpose and intended use of this interface or abstract class.
setDomains(List<String>) - Method in class org.machanism.machai.schema.Classification: Application domains (e.g., Data Processing, Machine Learning).
setEmail(String) - Method in class org.machanism.machai.schema.Author: Email for support or queries.
setExamples(List<Example__1>) - Method in class org.machanism.machai.schema.Feature: Code examples for the feature.
setExamples(List<Example__2>) - Method in class org.machanism.machai.schema.Customization: Code examples for the feature.
setExamples(List<Example__3>) - Method in class org.machanism.machai.schema.Stud: Code examples for the feature.
setExamples(List<Example__4>) - Method in class org.machanism.machai.schema.Bindex: General usage examples for the artifact, containing any structured data to help LLMs understand how the library can be used.
setExamples(List<Example>) - Method in class org.machanism.machai.schema.Constructor: Code examples for the object creation.
setExtension(String) - Method in class org.machanism.machai.schema.Coordinates: File extension or type (e.g., JAR, WAR, tar.gz, whl).
setFeatures(List<Feature>) - Method in class org.machanism.machai.schema.Bindex: The primary functions or capabilities provided by the artifact.
setGroup(String) - Method in class org.machanism.machai.schema.Coordinates: Group or namespace of the artifact (e.g., Maven groupId).
setId(String) - Method in class org.machanism.machai.schema.Bindex: A unique identifier for the artifact.
setImplement(String) - Method in class org.machanism.machai.schema.Stud: Fully qualified name of the class in this artifact that implements or extends this stub.
setIntegrations(List<String>) - Method in class org.machanism.machai.schema.Classification: Names of external backing systems the library integrates with (e.g., commercetools, Adyen, Braintree), if supported.
setLanguages(List<Language>) - Method in class org.machanism.machai.schema.Classification: Programming languages supported.
setLayers(List<Layer>) - Method in class org.machanism.machai.schema.Classification: Defines which Clean Architecture layers the library belongs to.
setLicense(String) - Method in class org.machanism.machai.schema.Bindex: License type (e.g., MIT, Apache 2.0, etc.).
setLocation(Location) - Method in class org.machanism.machai.schema.Bindex: Details about the artifact's storage location, repository type, and metadata.
setName(String) - Method in class org.machanism.machai.schema.Author: Name of the author or organization.
setName(String) - Method in class org.machanism.machai.schema.Bindex: The full name of the artifact or library.
setName(String) - Method in class org.machanism.machai.schema.Customization: Name of the customization or extension point (e.g., class, interface, method).
setName(String) - Method in class org.machanism.machai.schema.Feature: Name of the function or constructor.
setName(String) - Method in class org.machanism.machai.schema.Language: The name of the programming language (e.g., Python, Java, C++) (Required)
setName(String) - Method in class org.machanism.machai.schema.Stud: Fully qualified name of the interface or abstract class, as exported in this artifact.
setPackage(String) - Method in class org.machanism.machai.schema.Constructor: Name of the package.
setPackage(String) - Method in class org.machanism.machai.schema.Customization: Name of the package.
setPackage(String) - Method in class org.machanism.machai.schema.Feature: Name of the package.
setPackage(String) - Method in class org.machanism.machai.schema.Stud: Name of the package.
setRepositoryType(String) - Method in class org.machanism.machai.schema.Location: Type of repository (e.g., Maven, NPM, Git, DockerHub, PyPI).
setRepositoryUrl(URI) - Method in class org.machanism.machai.schema.Location: URL of the repository hosting the artifact.
setScore(Double) - Method in class org.machanism.machai.bindex.Picker: Manually set minimum score for semantic vector search queries.
setSignature(String) - Method in class org.machanism.machai.schema.Constructor: The complete method signature, where all parameter and exception types are fully qualified with their package names (e.g., 'java.util.Listinvalid input: '<'java.lang.String> methodName(java.lang.String param) throws java.io.IOException').
setSignature(String) - Method in class org.machanism.machai.schema.Feature: The complete method signature, where all parameter and exception types are fully qualified with their package names (e.g., 'java.util.Listinvalid input: '<'java.lang.String> methodName(java.lang.String param) throws java.io.IOException').
setSnippet(String) - Method in class org.machanism.machai.schema.Example__1: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
setSnippet(String) - Method in class org.machanism.machai.schema.Example__2: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
setSnippet(String) - Method in class org.machanism.machai.schema.Example__3: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
setSnippet(String) - Method in class org.machanism.machai.schema.Example: A code example snippet where all types (classes, interfaces, exceptions, etc.) are fully qualified with their package names.
setStuds(List<Stud>) - Method in class org.machanism.machai.schema.Bindex: A list of interfaces or abstract classes defined in this artifact, intended for implementation or extension by other modules to support forking, plugin, or extension scenarios.
setTargetEnvironment(List<String>) - Method in class org.machanism.machai.schema.Classification: A property that defines the fundamental runtime or platform required for the library to function.
setType(String) - Method in class org.machanism.machai.schema.Classification: Type of the artifact (e.g., library, plugin, module).
setType(String) - Method in class org.machanism.machai.schema.Customization: Type of customization point (e.g., method, interface, configuration property).
setType(String) - Method in class org.machanism.machai.schema.Stud: Kind of stub: always 'interface' or 'abstract class' as provided by this artifact.
setUsageContext(List<String>) - Method in class org.machanism.machai.schema.Classification: Specifies the contexts or environments in which the library can be used.
setVersion(String) - Method in class org.machanism.machai.schema.Bindex: Version of the artifact (e.g., semantic versioning, tag, or hash).
setVersion(String) - Method in class org.machanism.machai.schema.Coordinates: Version of the artifact.
setVersion(String) - Method in class org.machanism.machai.schema.Language: The version of the programming language (e.g., 3.9.1, 11, 17) (Required)
setWebsite(URI) - Method in class org.machanism.machai.schema.Author: Link to the website or documentation.
Stud - Class in org.machanism.machai.schema
Stud() - Constructor for class org.machanism.machai.schema.Stud

T

toString() - Method in class org.machanism.machai.schema.Author
toString() - Method in class org.machanism.machai.schema.Bindex
toString() - Method in class org.machanism.machai.schema.Classification
toString() - Method in class org.machanism.machai.schema.Constructor
toString() - Method in class org.machanism.machai.schema.Coordinates
toString() - Method in class org.machanism.machai.schema.Customization
toString() - Method in class org.machanism.machai.schema.Example__1
toString() - Method in class org.machanism.machai.schema.Example__2
toString() - Method in class org.machanism.machai.schema.Example__3
toString() - Method in class org.machanism.machai.schema.Example__4
toString() - Method in class org.machanism.machai.schema.Example
toString() - Method in class org.machanism.machai.schema.Feature
toString() - Method in class org.machanism.machai.schema.Language
toString() - Method in enum class org.machanism.machai.schema.Layer
toString() - Method in class org.machanism.machai.schema.Location
toString() - Method in class org.machanism.machai.schema.Stud

U

update(boolean) - Method in class org.machanism.machai.bindex.BindexCreator: Toggles the update mode for Bindex creation, enabling file updates if set to true.
update(boolean) - Method in class org.machanism.machai.bindex.BindexRegister: Sets the update mode for registration, enabling overwrite if true.
UTILS - Enum constant in enum class org.machanism.machai.schema.Layer

V

value() - Method in enum class org.machanism.machai.schema.Layer
valueOf(String) - Static method in enum class org.machanism.machai.schema.Layer: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.machanism.machai.schema.Layer: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I J L M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values