Class BlobPart

java.lang.Object

uno.anahata.asi.agi.event.BasicPropertyChangeSource

uno.anahata.asi.agi.message.AbstractPart

uno.anahata.asi.agi.message.BlobPart

All Implemented Interfaces:

PropertyChangeSource, Rebindable

Direct Known Subclasses:

ModelBlobPart, UserBlobPart

public abstract class BlobPart
extends AbstractPart

An abstract base class for binary data parts, such as an image or a document. It can be created from raw bytes or directly from a file path, in which case it retains a reference to the source path for traceability.

Author:

anahata

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull byte[]	data	The raw binary data.
private final @NonNull String	mimeType	The MIME type of the data (e.g., "image/png", "application/pdf").
private Path	sourcePath	The original source path if this blob was created from a file.

Fields inherited from class BasicPropertyChangeSource

propertyChangeSupport

Modifier and Type	Field	Description
protected PropertyChangeSupport	propertyChangeSupport	Support for firing property change events.

Constructor Summary

Constructors

Modifier	Constructor	Description
	BlobPart(@NonNull AbstractMessage message, @NonNull String mimeType, @NonNull byte[] data)	Constructs a BlobPart from raw byte data and a specified MIME type.
protected	BlobPart(@NonNull AbstractMessage message, @NonNull String mimeType, @NonNull byte[] data, @NonNull Path sourcePath)	Internal constructor for BlobParts with a source path.

Method Summary

Modifier and Type	Method	Description
protected void	appendMetadata(StringBuilder sb)	Hook for subclasses to inject specialized metadata into the part header.
String	asText()	Returns the content of the part as a simple string.
protected void	calculateTokenCount()	Performs the lazy, model-specific token calculation for this part.
protected int	getDefaultMaxDepth()	Template method hook for subclasses to provide their specific default max depth policy.
String	getPrunedHint()	Returns a summarized string representation of the part's content to be used as a "Hint" when the part is effectively pruned.

Methods inherited from class AbstractPart

createMetadataHeader, getAgi, getAgiConfig, getEffectiveMaxDepth, getEffectiveTokenCount, getIdentityLabel, getMetadataTokenCount, getRemainingDepth, getTokenCount, isAuto, isEffectivelyPruned, isPinned, isPruned, remove, resetTokenCount, setExpanded, setPruningState, setPruningState, setTokenCount

Modifier and Type	Method	Description
String	createMetadataHeader()	Creates a standardized text header containing metadata for this part.
Agi	getAgi()	Gets the parent agi session.
AgiConfig	getAgiConfig()	Gets the agi configuration.
final int	getEffectiveMaxDepth()	The definitive method for resolving the max depth policy for this part.
int	getEffectiveTokenCount()	Calculates the total "effective" tokens contributed by this part.
protected String	getIdentityLabel()	Returns the identity label for the metadata header (e.g., "Part ID: 45").
int	getMetadataTokenCount()	Calculates the token count of the metadata header for this part.
int	getRemainingDepth()	Calculates the remaining depth before this part is auto-pruned.
int	getTokenCount()	Retrieves the cached token count for this part.
boolean	isAuto()	Checks if this part is managed automatically.
boolean	isEffectivelyPruned()	Calculates the EFFECTIVE pruned state of this part.
boolean	isPinned()	Checks if this part is explicitly pinned.
boolean	isPruned()	Checks if this part is explicitly pruned.
void	remove()	Removes this part from its parent message and severs the bidirectional link.
void	resetTokenCount()	Resets the cached token count, forcing a lazy, background recalculation on the next call to getTokenCount().
void	setExpanded(boolean expanded)	Sets the expanded state and fires a property change event.
void	setPruningState(PruningState pruningState)	Sets the pruning state of this part and fires a property change event.
void	setPruningState(PruningState pruningState, String reason)	Sets the pruning state of this part with an optional reason.
void	setTokenCount(int tokenCount)	Sets the token count and fires a property change event.

Methods inherited from class BasicPropertyChangeSource

addPropertyChangeListener, addPropertyChangeListener, rebind, removePropertyChangeListener, removePropertyChangeListener

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Adds a property change listener.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Adds a property change listener for a specific property.
void	rebind()	Re-initializes the transient PropertyChangeSupport after deserialization.
void	removePropertyChangeListener(PropertyChangeListener listener)	Removes a property change listener.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)	Removes a property change listener for a specific property.

Methods inherited from class Object

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

Methods inherited from interface PropertyChangeSource

getPropertyChangeSupport

Modifier and Type	Method	Description
PropertyChangeSupport	getPropertyChangeSupport()	Gets the PropertyChangeSupport instance for this object.

Field Details

mimeType

@NonNull
private final @NonNull String mimeType

The MIME type of the data (e.g., "image/png", "application/pdf").

data

@NonNull
private final @NonNull byte[] data

The raw binary data.

sourcePath

private Path sourcePath

The original source path if this blob was created from a file. Can be null.

Constructor Details

BlobPart

public BlobPart(@NonNull
 @NonNull AbstractMessage message,
 @NonNull
 @NonNull String mimeType,
 @NonNull
 @NonNull byte[] data)

Constructs a BlobPart from raw byte data and a specified MIME type.

Parameters:

message - The message this part belongs to.

mimeType - The MIME type.

data - The binary data.

BlobPart

protected BlobPart(@NonNull
 @NonNull AbstractMessage message,
 @NonNull
 @NonNull String mimeType,
 @NonNull
 @NonNull byte[] data,
 @NonNull
 @NonNull Path sourcePath)

Internal constructor for BlobParts with a source path.

Parameters:

message - The parent message.

mimeType - The MIME type.

data - The binary data.

sourcePath - The source file path.

Method Details

asText

public String asText()

Description copied from class: AbstractPart

Returns the content of the part as a simple string. This is implemented by subclasses.

Specified by:

asText in class AbstractPart

Returns:

The text representation of the part.

getPrunedHint

public String getPrunedHint()

Returns a summarized string representation of the part's content to be used as a "Hint" when the part is effectively pruned. Defaults to a formatted version of AbstractPart.asText(). Provides essential binary metadata (MIME and Size) when the content is pruned.

Overrides:

getPrunedHint in class AbstractPart

Returns:

The pruned hint string.

calculateTokenCount

protected void calculateTokenCount()

Performs the lazy, model-specific token calculation for this part. This is implemented by subclasses to perform the actual calculation.

Calculates the multimodal token count for this binary part using the active model.

Specified by:

calculateTokenCount in class AbstractPart

appendMetadata

protected void appendMetadata(StringBuilder sb)

Hook for subclasses to inject specialized metadata into the part header. Always includes the source path in the metadata header if available, ensuring semantic continuity even when pruned.

Overrides:

appendMetadata in class AbstractPart

Parameters:

sb - The StringBuilder building the header.

getDefaultMaxDepth

protected int getDefaultMaxDepth()

Description copied from class: AbstractPart

Template method hook for subclasses to provide their specific default max depth policy. This is the fallback value used when no explicit maxDepth is set on the instance.

Specified by:

getDefaultMaxDepth in class AbstractPart

Returns:

The default maximum depth for this part type.