|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.runtime.CompoundValue
com.genesyslab.platform.reporting.protocol.statserver.StatisticMetricEx
public abstract class StatisticMetricEx
Constructor Summary | |
---|---|
StatisticMetricEx()
|
Method Summary | |
---|---|
static StatisticMetricEx |
create()
Creates instance of StatisticMetricEx with no parameters set. |
static StatisticMetricEx |
create(StatisticCategory category,
ActionsMask mainMask,
ActionsMask relativeMask,
StatisticSubject subject)
Creates instance of StatisticMetricEx. |
static StatisticMetricEx |
create(StatisticCategory category,
ActionsMask mainMask,
ActionsMask relativeMask,
StatisticSubject subject,
StatisticInterval intervalType,
java.lang.Integer intervalLength,
java.lang.String dynamicTimeProfile,
java.lang.String dynamicFilter,
java.lang.Integer timeRangeLeft,
java.lang.Integer timeRangeRight,
java.lang.Integer timeRangeLeft2,
java.lang.Integer timeRangeRight2,
java.lang.String dynamicUserDataFormula,
java.lang.Boolean distinguishByConnId)
Creates instance of StatisticMetricEx. |
static StatisticMetricEx |
create(StatisticCategory category,
ActionsMask mainMask,
ActionsMask relativeMask,
StatisticSubject subject,
java.lang.String timeProfile,
java.lang.String filter)
Creates instance of StatisticMetricEx. |
static StatisticMetricEx |
create(StatisticCategory category,
ActionsMask mainMask,
ActionsMask relativeMask,
StatisticSubject subject,
java.lang.String timeProfile,
java.lang.String filter,
java.lang.Integer timeRangeLeft,
java.lang.Integer timeRangeRight,
java.lang.Integer timeRangeLeft2,
java.lang.Integer timeRangeRight2,
java.lang.String dynamicUserDataFormula,
java.lang.Boolean distinguishByConnId)
Creates instance of StatisticMetricEx. |
abstract StatisticCategory |
getCategory()
Specifies the algorithm used to calculate a particular statistic. |
abstract java.lang.Boolean |
getDistinguishByConnId()
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract java.lang.String |
getDynamicFilter()
|
abstract java.lang.String |
getDynamicTimeProfile()
|
abstract java.lang.String |
getDynamicUserDataFormula()
|
abstract java.lang.String |
getFilter()
The filter to be used for a statistic metric (See Reporting Technical Reference Guide for more information). |
abstract java.lang.Integer |
getIntervalLength()
Interval length for historical statistics. |
abstract StatisticInterval |
getIntervalType()
Type of interval being used to capture historical statistics. |
abstract ActionsMask |
getMainMask()
Specifies the set of actions or statuses Stat Server considers when calculating a statistic. |
abstract ActionsMask |
getRelativeMask()
A mask used for calculating statistics reflecting relative values, such as percentages and averages. |
abstract StatisticSubject |
getSubject()
Specifies the object type that will be considered as a source of statistical data. |
abstract java.lang.String |
getTimeProfile()
The time profile to be used for a statistic metric (See Reporting Technical Reference Guide for more information). |
abstract java.lang.Integer |
getTimeRangeLeft()
|
abstract java.lang.Integer |
getTimeRangeLeft2()
|
abstract java.lang.Integer |
getTimeRangeRight()
|
abstract java.lang.Integer |
getTimeRangeRight2()
|
abstract void |
setCategory(StatisticCategory category)
Specifies the algorithm used to calculate a particular statistic. |
abstract void |
setDistinguishByConnId(java.lang.Boolean distinguishByConnId)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract void |
setDynamicFilter(java.lang.String dynamicFilter)
|
abstract void |
setDynamicTimeProfile(java.lang.String dynamicTimeProfile)
|
abstract void |
setDynamicUserDataFormula(java.lang.String dynamicUserDataFormula)
|
abstract void |
setFilter(java.lang.String filter)
The filter to be used for a statistic metric (See Reporting Technical Reference Guide for more information). |
abstract void |
setIntervalLength(int intervalLength)
Interval length for historical statistics. |
abstract void |
setIntervalLength(java.lang.Integer intervalLength)
Interval length for historical statistics. |
abstract void |
setIntervalType(StatisticInterval intervalType)
Type of interval being used to capture historical statistics. |
abstract void |
setMainMask(ActionsMask mainMask)
Specifies the set of actions or statuses Stat Server considers when calculating a statistic. |
abstract void |
setRelativeMask(ActionsMask relativeMask)
A mask used for calculating statistics reflecting relative values, such as percentages and averages. |
abstract void |
setSubject(StatisticSubject subject)
Specifies the object type that will be considered as a source of statistical data. |
abstract void |
setTimeProfile(java.lang.String timeProfile)
The time profile to be used for a statistic metric (See Reporting Technical Reference Guide for more information). |
abstract void |
setTimeRangeLeft(int timeRangeLeft)
|
abstract void |
setTimeRangeLeft(java.lang.Integer timeRangeLeft)
|
abstract void |
setTimeRangeLeft2(int timeRangeLeft2)
|
abstract void |
setTimeRangeLeft2(java.lang.Integer timeRangeLeft2)
|
abstract void |
setTimeRangeRight(int timeRangeRight)
|
abstract void |
setTimeRangeRight(java.lang.Integer timeRangeRight)
|
abstract void |
setTimeRangeRight2(int timeRangeRight2)
|
abstract void |
setTimeRangeRight2(java.lang.Integer timeRangeRight2)
|
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue |
---|
getProtocolDescription |
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject |
---|
equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public StatisticMetricEx()
Method Detail |
---|
public static StatisticMetricEx create()
public static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject)
category
- CategorymainMask
- MainMaskrelativeMask
- RelativeMasksubject
- Subject
public static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject, java.lang.String timeProfile, java.lang.String filter)
category
- CategorymainMask
- MainMaskrelativeMask
- RelativeMasksubject
- SubjecttimeProfile
- TimeProfilefilter
- Filter
public static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject, java.lang.String timeProfile, java.lang.String filter, java.lang.Integer timeRangeLeft, java.lang.Integer timeRangeRight, java.lang.Integer timeRangeLeft2, java.lang.Integer timeRangeRight2, java.lang.String dynamicUserDataFormula, java.lang.Boolean distinguishByConnId)
category
- CategorymainMask
- MainMaskrelativeMask
- RelativeMasksubject
- SubjecttimeProfile
- TimeProfilefilter
- FiltertimeRangeLeft
- TimeRangeLefttimeRangeRight
- TimeRangeRighttimeRangeLeft2
- TimeRangeLeft2timeRangeRight2
- TimeRangeRight2dynamicUserDataFormula
- DynamicUserDataFormuladistinguishByConnId
- DistinguishByConnId
public static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject, StatisticInterval intervalType, java.lang.Integer intervalLength, java.lang.String dynamicTimeProfile, java.lang.String dynamicFilter, java.lang.Integer timeRangeLeft, java.lang.Integer timeRangeRight, java.lang.Integer timeRangeLeft2, java.lang.Integer timeRangeRight2, java.lang.String dynamicUserDataFormula, java.lang.Boolean distinguishByConnId)
category
- CategorymainMask
- MainMaskrelativeMask
- RelativeMasksubject
- SubjectintervalType
- IntervalTypeintervalLength
- IntervalLengthdynamicTimeProfile
- DynamicTimeProfiledynamicFilter
- DynamicFiltertimeRangeLeft
- TimeRangeLefttimeRangeRight
- TimeRangeRighttimeRangeLeft2
- TimeRangeLeft2timeRangeRight2
- TimeRangeRight2dynamicUserDataFormula
- DynamicUserDataFormuladistinguishByConnId
- DistinguishByConnId
public abstract StatisticCategory getCategory()
public abstract void setCategory(StatisticCategory category)
public abstract ActionsMask getMainMask()
public abstract void setMainMask(ActionsMask mainMask)
public abstract ActionsMask getRelativeMask()
public abstract void setRelativeMask(ActionsMask relativeMask)
public abstract StatisticSubject getSubject()
public abstract void setSubject(StatisticSubject subject)
public abstract java.lang.String getTimeProfile()
public abstract void setTimeProfile(java.lang.String timeProfile)
public abstract java.lang.String getFilter()
public abstract void setFilter(java.lang.String filter)
public abstract java.lang.Integer getTimeRangeLeft()
public abstract void setTimeRangeLeft(java.lang.Integer timeRangeLeft)
public abstract void setTimeRangeLeft(int timeRangeLeft)
public abstract java.lang.Integer getTimeRangeRight()
public abstract void setTimeRangeRight(java.lang.Integer timeRangeRight)
public abstract void setTimeRangeRight(int timeRangeRight)
public abstract java.lang.Integer getTimeRangeLeft2()
public abstract void setTimeRangeLeft2(java.lang.Integer timeRangeLeft2)
public abstract void setTimeRangeLeft2(int timeRangeLeft2)
public abstract java.lang.Integer getTimeRangeRight2()
public abstract void setTimeRangeRight2(java.lang.Integer timeRangeRight2)
public abstract void setTimeRangeRight2(int timeRangeRight2)
public abstract java.lang.String getDynamicUserDataFormula()
public abstract void setDynamicUserDataFormula(java.lang.String dynamicUserDataFormula)
public abstract java.lang.Boolean getDistinguishByConnId()
public abstract void setDistinguishByConnId(java.lang.Boolean distinguishByConnId)
public abstract StatisticInterval getIntervalType()
public abstract void setIntervalType(StatisticInterval intervalType)
public abstract java.lang.String getDynamicTimeProfile()
public abstract void setDynamicTimeProfile(java.lang.String dynamicTimeProfile)
public abstract java.lang.String getDynamicFilter()
public abstract void setDynamicFilter(java.lang.String dynamicFilter)
public abstract java.lang.Integer getIntervalLength()
public abstract void setIntervalLength(java.lang.Integer intervalLength)
public abstract void setIntervalLength(int intervalLength)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |