de.ipcon.tools

Interface L10nPathCompilerI

All Known Implementing Classes:

BOT.BOClassesPathCompiler

public interface L10nPathCompilerI

Compiles contextual participants into ordered search paths for localization (L10n) resource resolution.

When resolving localized bundles, callers supply context objects ("participants") such as domain instances, UI models, or Class references. Implementations of this interface expand, reorder, or map those participants into concrete search tokens to establish deterministic lookup precedence.

Resolution Lifecycle

The localization lookup resolves resources in distinct phases:

1. Primary path elements (compileParticipantToPathElements(java.lang.Object)): Evaluated in array order. Typically yields structural tokens (such as Class instances) representing concrete classes, aspect layers, or entity hierarchies.
2. String participant processing (L10n#addStringParticipant): Deferred to the end of the primary lookup process. String tokens are processed after class-based tokens have been evaluated.
3. Trailing path elements (compileParticipantToTrailingPathElements(java.lang.Object)): Evaluated last as broad package-level fallbacks (e.g. module or framework base packages) once all primary elements have been exhausted without a hit.

Examples

• Contextual extraction (LesezeichenPathCompiler): Evaluates a bookmark instance (Lesezeichen) and returns the Class of its associated Business Object alongside the bookmark’s own class.
• Hierarchy expansion (BOT.BOClassesPathCompiler): Maps a single BO Class to the full inheritance, aspect, and module chain of the underlying entity, ensuring project overrides take precedence over generic module defaults.

Field Summary

Fields

Modifier and Type	Field and Description
static L10nPathCompilerI[]	EMPTY_ARRAY Reusable empty array constant to avoid allocation overhead.

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	compileParticipantToPathElements(java.lang.Object participant) Compiles the participant into an ordered sequence of primary lookup elements.
default java.lang.String[]	compileParticipantToTrailingPathElements(java.lang.Object participant) Compiles fallback trailing path elements for the participant.
boolean	isValidParticipant(java.lang.Object participant) Checks whether this compiler supports the given participant.

Field Detail

EMPTY_ARRAY

static final L10nPathCompilerI[] EMPTY_ARRAY

Reusable empty array constant to avoid allocation overhead.

Method Detail

isValidParticipant

boolean isValidParticipant(java.lang.Object participant)

Checks whether this compiler supports the given participant.

Parameters:

participant - The context object to validate (e.g. an instance or Class).

Returns:

true if this compiler can process the participant, false otherwise.

compileParticipantToPathElements

java.lang.Object[] compileParticipantToPathElements(java.lang.Object participant)

Compiles the participant into an ordered sequence of primary lookup elements.

The order of elements in the returned array is significant and determines localization lookup precedence (first match wins).

Type contract and string handling: The returned elements should generally not contain arbitrary String objects, as string processing occurs at the end of the primary lookup cycle in L10n#addStringParticipant. Instead, compilers should return structural tokens (typically Class objects). If an implementation does return String instances (e.g. precomputed fully qualified class/bundle names), they bypass class-level tokenization and are evaluated directly as path identifiers.

Parameters:

participant - The validated context object to compile.

Returns:

An ordered array of path elements (typically Class objects or precalculated path strings). Must return an empty array if no elements apply; never null.

compileParticipantToTrailingPathElements

default java.lang.String[] compileParticipantToTrailingPathElements(java.lang.Object participant)

Compiles fallback trailing path elements for the participant.

Trailing elements are checked only after all primary class-level and string-level elements have been evaluated without a hit. They define package-level fallback paths (e.g. "com.oashi.modules.erp.bo") rather than class-specific bundles.

Parameters:

participant - The validated context object.

Returns:

An array of trailing package search paths. Defaults to an empty array.