Package 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 TypeMethodDescriptionacquireAggregate(String aggregateId) Acquires anAggregatefor the specified aggregate ID.acquireFilter(String filterId) Acquires aFilterfor the specified filter ID.acquireValueExtractor(String extractorId) Acquires aValueExtractorfor the specified extractor ID.acquireValueResolver(String resolverId) Acquires aValueResolverfor the specified resolver ID.voidreleaseAggregate(Aggregate aggregate) Releases the specifiedAggregate.voidreleaseExtractor(ValueExtractor extractor) Releases the specifiedValueExtractor.voidreleaseFilter(Filter filter) Releases the specifiedFilter.voidreleaseValueResolver(ValueResolver resolver) Releases the specifiedValueResolver.
-
Method Details
-
acquireValueResolver
Acquires a
ValueResolverfor the specified resolver ID.The resolver instance must be explicitly released using
releaseValueResolver(ValueResolver).- Parameters:
resolverId- The resolver ID- Returns:
- The corresponding
ValueResolver;nullif the resolver could not be instantiated
-
releaseValueResolver
Releases the specifiedValueResolver.- Parameters:
resolver- The resolver to release
-
acquireAggregate
Acquires an
Aggregatefor the specified aggregate ID.The aggregate must be explicitly released using
releaseAggregate(Aggregate).- Parameters:
aggregateId- The aggregate ID- Returns:
- The corresponding
Aggregate;nullif the aggregate could not be instantiated
-
releaseAggregate
Releases the specifiedAggregate.- Parameters:
aggregate- The aggregate to release
-
acquireValueExtractor
Acquires a
ValueExtractorfor the specified extractor ID.The extractor must be explicitly released using
releaseExtractor(ValueExtractor).- Parameters:
extractorId- The extractor ID- Returns:
- The corresponding
ValueExtractor;nullif the extractor could not be instantiated
-
releaseExtractor
Releases the specifiedValueExtractor.- Parameters:
extractor- The extractor to release
-
acquireFilter
Acquires a
Filterfor the specified filter ID.The filter must be explicitly released using
releaseFilter(Filter).- Parameters:
filterId- The filter ID- Returns:
- The corresponding
Filter;nullif the filter could not be instantiated
-
releaseFilter
Releases the specifiedFilter.- Parameters:
filter- The filter to release
-