|
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.Message
com.genesyslab.platform.reporting.protocol.statserver.events.EventStatisticProfile
public abstract class EventStatisticProfile
Returns information about the currently available statistical types, time profiles, time ranges, or filters.
Selected Properties:
Name | Description |
---|---|
ReferenceId | ReferenceId of the RequestGetStatisticProfile used to return the statistics profile. |
IntValue | Indicates whether the request is for information about statistical types, time profiles, time ranges, or filters. |
Profile | Gives the keys and values of the profiles requested in a RequestGetStatisticProfile . |
Tag | User reference ID. |
Name | Description |
---|---|
RequestGetStatisticProfile |
Requests information on the currently available statistical types, time profiles, time ranges, or filters. |
RequestGetStatisticProfile
.
The first is for TimeProfiles
and the second is for TimeRanges
. Note that the property names used by the Stat Server
are different from those used by Platform SDK. The table below gives naming equivalents for the most important properties.
'EventStatisticProfile' ('4')
message attributes:
REQ_ID [int] = 2
USER_REQ_ID [int] = -1
TM_SERVER [int] = 1252622269
TM_LENGTH [int] = 0
LONG_VALUE [int] = 1
XAB_PROFILE [bstr] = KVList:
'OneHour,Growing' [str] = "0:00 1:00 2:00 3:00 4:00 5:00 6:00 7:
00 8:00 9:00 10:00 11:00 12:00 13:00 14:00 15:00 16:00 17:00 18:00 19:00 20:00 2
1:00 22:00 23:00 "
'OneMinute,Growing' [str] = "0:00 0:01 0:02 0:03 0:04 0:05 0:06
0:07 0:08 0:09 0:10 0:11 0:12 0:13 0:14 0:15 0:16 0:17 0:18 0:19 0:20 0:21 0:22
.
.
.
23:46 23:47 23:48 23:49 23:50 23:51 23:52 23:53 23:54 23:55 23:56 23:57 23:58 2
3:59 "
'SlidingDay,Sliding' [str] = "86400:3600"
'SlidingHour,Sliding' [str] = "3600:600"
'Default, Growing' [str] = "0:00"
TimeRanges
'EventStatisticProfile' ('4')
message attributes:
REQ_ID [int] = 3
USER_REQ_ID [int] = -1
TM_SERVER [int] = 1252622270
TM_LENGTH [int] = 0
LONG_VALUE [int] = 3
XAB_PROFILE [bstr] = KVList:
'Range0-10' [str] = "00-10"
'Range0-120' [str] = "0-120"
'Range0-5' [str] = "00-05"
'Default' [str] = "0-20"
Selected Property Naming Equivalents for Stat Server and Platform SDK:
Stat Server Name | Platform SDK Name |
---|---|
REQ_ID | ReferenceId |
LONG_VALUE | IntValue |
XAB_PROFILE | Profile |
USER_REQ_ID | Tag |
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventStatisticProfile |
create()
Creates instance of EventStatisticProfile with no parameters set. |
static EventStatisticProfile |
create(java.lang.Integer tag,
java.lang.Integer timestamp,
java.lang.Integer intervalLength,
java.lang.Integer intValue,
java.lang.String stringValue,
KeyValueCollection profile)
Creates instance of EventStatisticProfile with all parameters set. |
static EventStatisticProfile |
create(java.lang.Integer timestamp,
java.lang.Integer intervalLength,
java.lang.Integer intValue,
KeyValueCollection profile)
Creates instance of EventStatisticProfile with required parameters set. |
abstract java.lang.Integer |
getIntervalLength()
Interval length for historical statistics. |
abstract java.lang.Integer |
getIntValue()
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract KeyValueCollection |
getProfile()
Gives the keys and values of the profiles requested in a RequestGetStatisticProfile. |
abstract java.lang.Integer |
getReferenceId()
A unique integer that is specified for identification of requested statistics. |
abstract java.lang.String |
getStringValue()
|
abstract java.lang.Integer |
getTag()
User reference ID. |
abstract java.lang.Integer |
getTimestamp()
|
abstract void |
setIntervalLength(int intervalLength)
Interval length for historical statistics. |
abstract void |
setIntervalLength(java.lang.Integer intervalLength)
Interval length for historical statistics. |
abstract void |
setIntValue(int intValue)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract void |
setIntValue(java.lang.Integer intValue)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile. |
abstract void |
setProfile(KeyValueCollection profile)
Gives the keys and values of the profiles requested in a RequestGetStatisticProfile. |
abstract void |
setReferenceId(int referenceId)
A unique integer that is specified for identification of requested statistics. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
A unique integer that is specified for identification of requested statistics. |
abstract void |
setStringValue(java.lang.String stringValue)
|
abstract void |
setTag(int tag)
User reference ID. |
abstract void |
setTag(java.lang.Integer tag)
User reference ID. |
abstract void |
setTimestamp(int timestamp)
|
abstract void |
setTimestamp(java.lang.Integer timestamp)
|
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription |
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 |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventStatisticProfile create()
public static EventStatisticProfile create(java.lang.Integer tag, java.lang.Integer timestamp, java.lang.Integer intervalLength, java.lang.Integer intValue, java.lang.String stringValue, KeyValueCollection profile)
tag
- Tagtimestamp
- TimestampintervalLength
- IntervalLengthintValue
- IntValuestringValue
- StringValueprofile
- Profile
public static EventStatisticProfile create(java.lang.Integer timestamp, java.lang.Integer intervalLength, java.lang.Integer intValue, KeyValueCollection profile)
timestamp
- TimestampintervalLength
- IntervalLengthintValue
- IntValueprofile
- Profile
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getTag()
public abstract void setTag(java.lang.Integer tag)
public abstract void setTag(int tag)
public abstract java.lang.Integer getTimestamp()
public abstract void setTimestamp(java.lang.Integer timestamp)
public abstract void setTimestamp(int timestamp)
public abstract java.lang.Integer getIntervalLength()
public abstract void setIntervalLength(java.lang.Integer intervalLength)
public abstract void setIntervalLength(int intervalLength)
public abstract java.lang.Integer getIntValue()
public abstract void setIntValue(java.lang.Integer intValue)
public abstract void setIntValue(int intValue)
public abstract java.lang.String getStringValue()
public abstract void setStringValue(java.lang.String stringValue)
public abstract KeyValueCollection getProfile()
public abstract void setProfile(KeyValueCollection profile)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |