com.day.cq.reporting

Interface ComponentProvider

public interface ComponentProvider

This interface provides means to provide components to a report (such as value resolvers, aggregates, etc.).

Method Summary

Modifier and Type	Method and Description
Aggregate	acquireAggregate(java.lang.String aggregateId) Acquires an Aggregate for the specified aggregate ID.
Filter	acquireFilter(java.lang.String filterId) Acquires a Filter for the specified filter ID.
ValueExtractor	acquireValueExtractor(java.lang.String extractorId) Acquires a ValueExtractor for the specified extractor ID.
ValueResolver	acquireValueResolver(java.lang.String resolverId) Acquires a ValueResolver for the specified resolver ID.
void	releaseAggregate(Aggregate aggregate) Releases the specified Aggregate.
void	releaseExtractor(ValueExtractor extractor) Releases the specified ValueExtractor.
void	releaseFilter(Filter filter) Releases the specified Filter.
void	releaseValueResolver(ValueResolver resolver) Releases the specified ValueResolver.

Method Detail

acquireValueResolver

ValueResolver acquireValueResolver(java.lang.String resolverId)

Acquires a ValueResolver for the specified resolver ID.

The resolver instance must be explicitly released using releaseValueResolver(ValueResolver).

Parameters:

resolverId - The resolver ID

Returns:

The corresponding ValueResolver; null if the resolver could not be instantiated

releaseValueResolver

void releaseValueResolver(ValueResolver resolver)

Releases the specified ValueResolver.

Parameters:

resolver - The resolver to release

acquireAggregate

Aggregate acquireAggregate(java.lang.String aggregateId)

Acquires an Aggregate for the specified aggregate ID.

The aggregate must be explicitly released using releaseAggregate(Aggregate).

Parameters:

aggregateId - The aggregate ID

Returns:

The corresponding Aggregate; null if the aggregate could not be instantiated

releaseAggregate

void releaseAggregate(Aggregate aggregate)

Releases the specified Aggregate.

Parameters:

aggregate - The aggregate to release

acquireValueExtractor

ValueExtractor acquireValueExtractor(java.lang.String extractorId)

Acquires a ValueExtractor for the specified extractor ID.

The extractor must be explicitly released using releaseExtractor(ValueExtractor).

Parameters:

extractorId - The extractor ID

Returns:

The corresponding ValueExtractor; null if the extractor could not be instantiated

releaseExtractor

void releaseExtractor(ValueExtractor extractor)

Releases the specified ValueExtractor.

Parameters:

extractor - The extractor to release

acquireFilter

Filter acquireFilter(java.lang.String filterId)

Acquires a Filter for the specified filter ID.

The filter must be explicitly released using releaseFilter(Filter).

Parameters:

filterId - The filter ID

Returns:

The corresponding Filter; null if the filter could not be instantiated

releaseFilter

void releaseFilter(Filter filter)

Releases the specified Filter.

Parameters:

filter - The filter to release