Class MetricsQueryImpl
java.lang.Object
org.camunda.bpm.engine.impl.db.ListQueryParameterObject
org.camunda.bpm.engine.impl.metrics.MetricsQueryImpl
- All Implemented Interfaces:
Serializable
,Command<Object>
,MetricsQuery
public class MetricsQueryImpl
extends ListQueryParameterObject
implements Serializable, Command<Object>, MetricsQuery
- Author:
- Daniel Meyer
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
protected class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Boolean
Contains the command implementation which should be executed either metric sum or select metric grouped by time interval.protected CommandExecutor
static final int
static final long
protected Date
protected Long
protected Long
protected String
protected String
protected Date
protected Long
Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAggregate metrics by reportersRestrict to data collected before the given date (exclusive)execute
(CommandContext commandContext) int
getName()
interval()
Returns the metrics summed up and aggregated on a time interval.interval
(long interval) Returns the metrics summed up and aggregated on a time interval.limit
(int maxResults) Sets the limit row count of the result.offset
(int offset) Sets the offset of the returned results.Restrict to data collected by the reported with the given identifiervoid
setMaxResults
(int maxResults) Restrict to data collected after the given date (inclusive)long
sum()
Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setOrderingProperties, setParameter, setTenantCheck
-
Field Details
-
DEFAULT_LIMIT_SELECT_INTERVAL
public static final int DEFAULT_LIMIT_SELECT_INTERVAL- See Also:
-
DEFAULT_SELECT_INTERVAL
public static final long DEFAULT_SELECT_INTERVAL- See Also:
-
name
-
reporter
-
startDate
-
endDate
-
startDateMilliseconds
-
endDateMilliseconds
-
interval
-
aggregateByReporter
-
commandExecutor
-
callback
Contains the command implementation which should be executed either metric sum or select metric grouped by time interval. Note: this enables to quit with the enum distinction
-
-
Constructor Details
-
MetricsQueryImpl
-
-
Method Details
-
name
- Specified by:
name
in interfaceMetricsQuery
- Parameters:
name
- The name of the metrics to query for- See Also:
-
in Metrics for a list of names which can be used here.
-
reporter
Description copied from interface:MetricsQuery
Restrict to data collected by the reported with the given identifier- Specified by:
reporter
in interfaceMetricsQuery
-
startDate
Description copied from interface:MetricsQuery
Restrict to data collected after the given date (inclusive)- Specified by:
startDate
in interfaceMetricsQuery
-
endDate
Description copied from interface:MetricsQuery
Restrict to data collected before the given date (exclusive)- Specified by:
endDate
in interfaceMetricsQuery
-
interval
Description copied from interface:MetricsQuery
Returns the metrics summed up and aggregated on a time interval. Default interval is 900 (15 minutes). The list size has a maximum of 200 the maximum can be decreased with the MetricsQuery#limit method. Paging is enabled with the help of the offset.- Specified by:
interval
in interfaceMetricsQuery
- Returns:
- the aggregated metrics
-
interval
Description copied from interface:MetricsQuery
Returns the metrics summed up and aggregated on a time interval. The size of the interval is given via parameter. The time unit is seconds! The list size has a maximum of 200 the maximum can be decreased with the MetricsQuery#limit method. Paging is enabled with the help of the offset.- Specified by:
interval
in interfaceMetricsQuery
- Parameters:
interval
- The time interval on which the metrics should be aggregated. The time unit is seconds.- Returns:
- the aggregated metrics
-
sum
public long sum()- Specified by:
sum
in interfaceMetricsQuery
- Returns:
- the aggregated sum
-
execute
-
offset
Description copied from interface:MetricsQuery
Sets the offset of the returned results.- Specified by:
offset
in interfaceMetricsQuery
- Parameters:
offset
- indicates after which row the result begins- Returns:
- the adjusted MetricsQuery
-
limit
Description copied from interface:MetricsQuery
Sets the limit row count of the result. Can't be set larger than 200, since it is the maximum row count which should be returned.- Specified by:
limit
in interfaceMetricsQuery
- Parameters:
maxResults
- the new row limit of the result- Returns:
- the adjusted MetricsQuery
-
aggregateByReporter
Description copied from interface:MetricsQuery
Aggregate metrics by reporters- Specified by:
aggregateByReporter
in interfaceMetricsQuery
- Returns:
- the adjusted MetricsQuery
-
setMaxResults
public void setMaxResults(int maxResults) - Overrides:
setMaxResults
in classListQueryParameterObject
-
getStartDate
-
getEndDate
-
getStartDateMilliseconds
-
getEndDateMilliseconds
-
getName
-
getReporter
-
getInterval
-
getMaxResults
public int getMaxResults()- Overrides:
getMaxResults
in classListQueryParameterObject
-