Package com.iknowbase.api.contentservices.query.dimension
Provides interfaces for creating and running dimensions queries.
The main workflow follows these steps:
- The infrastructure, using infrastructure magic, provides you with a ContentServicesEngine.
- The ContentServicesEngine provides you with a DimensionQueryService.
- To create a query, you first ask the DimensionQueryService for a DimensionQueryBuilder. You use fluent methods to configure the builder, and finally build a reusable DimensionQuery object.
- To run a query, you first ask the DimensionQuery for a DimensionQueryRunner. You use fluent methods to configure the runner, and finally use the run() method to get a DimensionQueryResult.
Example
public class QueryTest { private final DimensionQuery query; public QueryTest (DimensionQueryService dimensionQueryService) { query = dimensionQueryService.builder() .topLevels("IKB_ORG", "IKB_CUSTOMERS") .includingDimensionTypes() .build(); } public void runQuery(RepositoryClient client, int currentDimension) { DimensionQueryResult result = query.runner() .activeNode(currentDimension) .run(client); // Do something with result } }
-
Interface Summary Interface Description DimensionQuery A reusable dimension query specification.DimensionQueryBuilder A builder used to configure and build a newDimensionQuery
.DimensionQueryResult A result object returned from aContentQuery
.DimensionQueryRunner A one-time runner, used to execute a DimensionQuery.DimensionQueryService A service managing the creation and execution ofDimensionQuery
s.