com.aspc.Admin.jmx

Class MetricChart

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Admin.jmx.MetricChart

All Implemented Interfaces:

SecondaryCacheGroup

public class MetricChart
extends DBObject

Charting of Performance Metric Data. Produces chart for every Metric Data or group of Metric Data.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

14 December 2007

Author:

angela

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Charting of Performance Metric Data.
static java.lang.String	DBCLASS_NAME Charting of Performance Metric Data.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
MetricChart(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static MetricChart	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
MetricChartFolder	findChartFolder(java.lang.String... args) Which tree folder this chart appears in.
MatrixChartTimeRange	findChartTimeRange(java.lang.String... args) Time range to display values in chart.
MatrixDataFilter	findDataFilter(java.lang.String... args) Filter to be used to filter the list of objects include in chart.
MatrixType	findDualMeasureType(java.lang.String... args) The secondary axis.
static MetricChart	findKey(DataSource ds, int key) Find the target for this class by the primary key
MatrixType	findMatrixType(java.lang.String... args) The chart's X axis name.
java.lang.String	getCalcTitle(java.lang.String... args)
int	getChart(java.lang.String... args)
MetricChartFolder	getChartFolder(java.lang.String... args)
MatrixChartTimeRange	getChartTimeRange(java.lang.String... args)
java.lang.String	getCountRange(java.lang.String... args)
MatrixDataFilter	getDataFilter(java.lang.String... args)
java.lang.String	getDataFilterParams(java.lang.String... args)
java.lang.String	getDataFormatterParams(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getDualDataFormatterParams(java.lang.String... args)
MatrixType	getDualMeasureType(java.lang.String... args)
java.lang.String	getFormatDataLabel(java.lang.String... args)
java.lang.String	getFormatDualDataLabel(java.lang.String... args)
int	getID(java.lang.String... args)
MatrixType	getMatrixType(java.lang.String... args)
java.lang.String	getPluginParams(java.lang.String... args)
int	getSeq(java.lang.String... args)
java.util.Date	getStartDate(java.lang.String... args)
java.lang.String	getTitle(java.lang.String... args)
java.lang.String	getTitleX(java.lang.String... args)
java.lang.String	getTitleY(java.lang.String... args)
java.lang.String	getTreeBranchLabel(java.lang.String... args)
boolean	hideLegend(java.lang.String... args)
boolean	isCountOnly(java.lang.String... args)
boolean	isDataGroup(java.lang.String... args)
boolean	isDataRange(java.lang.String... args)
boolean	isDualDataGroup(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
static DBQuery<MetricChart>	makeQuery(DataSource ds) Make a new QUERY for this class.
MetricChart	setChart(int value, java.lang.String... args)
MetricChart	setChartFolder(com.aspc.dal.admin.jmx.MetricChartFolder value, java.lang.String... args)
MetricChart	setChartTimeRange(com.aspc.dal.admin.jmx.MetricChartTimeRange value, java.lang.String... args)
MetricChart	setCountOnly(boolean value, java.lang.String... args)
MetricChart	setCountRange(java.lang.String value, java.lang.String... args)
MetricChart	setDataFilter(com.aspc.dal.admin.jmx.MetricDataFilter value, java.lang.String... args)
MetricChart	setDataFilterParams(java.lang.String value, java.lang.String... args)
MetricChart	setDataFormatterParams(java.lang.String value, java.lang.String... args)
MetricChart	setDataGroup(boolean value, java.lang.String... args)
MetricChart	setDataRange(boolean value, java.lang.String... args)
MetricChart	setDescription(java.lang.String value, java.lang.String... args)
MetricChart	setDualDataFormatterParams(java.lang.String value, java.lang.String... args)
MetricChart	setDualDataGroup(boolean value, java.lang.String... args)
MetricChart	setDualMeasureType(com.aspc.dal.admin.jmx.MetricType value, java.lang.String... args)
MetricChart	setFinalFg(boolean value, java.lang.String... args)
MetricChart	setFormatDataLabel(java.lang.String value, java.lang.String... args)
MetricChart	setFormatDualDataLabel(java.lang.String value, java.lang.String... args)
MetricChart	setHideLegend(boolean value, java.lang.String... args)
MetricChart	setID(int value, java.lang.String... args)
MetricChart	setMatrixType(com.aspc.dal.admin.jmx.MetricType value, java.lang.String... args)
MetricChart	setPluginParams(java.lang.String value, java.lang.String... args)
MetricChart	setSeq(int value, java.lang.String... args)
MetricChart	setStartDate(java.util.Date value, java.lang.String... args)
MetricChart	setTitle(java.lang.String value, java.lang.String... args)
MetricChart	setTitleX(java.lang.String value, java.lang.String... args)
MetricChart	setTitleY(java.lang.String value, java.lang.String... args)
MetricChart	setTreeBranchLabel(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Charting of Performance Metric Data. Produces chart for every Metric Data or group of Metric Data.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Charting of Performance Metric Data. Produces chart for every Metric Data or group of Metric Data.

Constructor Detail

MetricChart

public MetricChart(DBClass def,
                   DataSource dataSource)
            throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public MetricChart setID(int value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getCalcTitle

@CheckReturnValue
 @Nonnull
public java.lang.String getCalcTitle(java.lang.String... args)

getChart

@CheckReturnValue
public int getChart(java.lang.String... args)

setChart

@Nonnull
public MetricChart setChart(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getChartFolder

@CheckReturnValue
 @Nullable
public MetricChartFolder getChartFolder(java.lang.String... args)

findChartFolder

@CheckReturnValue
 @Nonnull
public final MetricChartFolder findChartFolder(java.lang.String... args)
                                                                    throws NotFoundException

Which tree folder this chart appears in.

--> MetricChartFolder (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

MetricChartFolder

Throws:

NotFoundException - MetricChartFolder was not found

setChartFolder

@Nonnull
public MetricChart setChartFolder(com.aspc.dal.admin.jmx.MetricChartFolder value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getChartTimeRange

@CheckReturnValue
 @Nullable
public MatrixChartTimeRange getChartTimeRange(java.lang.String... args)

findChartTimeRange

@CheckReturnValue
 @Nonnull
public final MatrixChartTimeRange findChartTimeRange(java.lang.String... args)
                                                                          throws NotFoundException

Time range to display values in chart. Could be, Min, Hour, Day, month, Year, etc..

--> MetricChartTimeRange (String, Searchable)

Parameters:

args - the optional arguments

Returns:

MetricChartTimeRange

Throws:

NotFoundException - MetricChartTimeRange was not found

setChartTimeRange

@Nonnull
public MetricChart setChartTimeRange(com.aspc.dal.admin.jmx.MetricChartTimeRange value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isCountOnly

@CheckReturnValue
public boolean isCountOnly(java.lang.String... args)

setCountOnly

@Nonnull
public MetricChart setCountOnly(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCountRange

@CheckReturnValue
 @Nonnull
public java.lang.String getCountRange(java.lang.String... args)

setCountRange

@Nonnull
public MetricChart setCountRange(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDataFilter

@CheckReturnValue
 @Nullable
public MatrixDataFilter getDataFilter(java.lang.String... args)

findDataFilter

@CheckReturnValue
 @Nonnull
public final MatrixDataFilter findDataFilter(java.lang.String... args)
                                                                  throws NotFoundException

Filter to be used to filter the list of objects include in chart.

--> MetricDataFilter (String, Searchable)

Parameters:

args - the optional arguments

Returns:

MetricDataFilter

Throws:

NotFoundException - MetricDataFilter was not found

setDataFilter

@Nonnull
public MetricChart setDataFilter(com.aspc.dal.admin.jmx.MetricDataFilter value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDataFilterParams

@CheckReturnValue
 @Nonnull
public java.lang.String getDataFilterParams(java.lang.String... args)

setDataFilterParams

@Nonnull
public MetricChart setDataFilterParams(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getDataFormatterParams

@CheckReturnValue
 @Nonnull
public java.lang.String getDataFormatterParams(java.lang.String... args)

setDataFormatterParams

@Nonnull
public MetricChart setDataFormatterParams(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

isDataGroup

@CheckReturnValue
public boolean isDataGroup(java.lang.String... args)

setDataGroup

@Nonnull
public MetricChart setDataGroup(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isDataRange

@CheckReturnValue
public boolean isDataRange(java.lang.String... args)

setDataRange

@Nonnull
public MetricChart setDataRange(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription(java.lang.String... args)

setDescription

@Nonnull
public MetricChart setDescription(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDualDataFormatterParams

@CheckReturnValue
 @Nonnull
public java.lang.String getDualDataFormatterParams(java.lang.String... args)

setDualDataFormatterParams

@Nonnull
public MetricChart setDualDataFormatterParams(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

isDualDataGroup

@CheckReturnValue
public boolean isDualDataGroup(java.lang.String... args)

setDualDataGroup

@Nonnull
public MetricChart setDualDataGroup(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDualMeasureType

@CheckReturnValue
 @Nullable
public MatrixType getDualMeasureType(java.lang.String... args)

findDualMeasureType

@CheckReturnValue
 @Nonnull
public final MatrixType findDualMeasureType(java.lang.String... args)
                                                                 throws NotFoundException

The secondary axis. This is used only when ChartType=DualAxis selected.

--> MetricType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

MetricType

Throws:

NotFoundException - MetricType was not found

setDualMeasureType

@Nonnull
public MetricChart setDualMeasureType(com.aspc.dal.admin.jmx.MetricType value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public MetricChart setFinalFg(boolean value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getFormatDataLabel

@CheckReturnValue
 @Nonnull
public java.lang.String getFormatDataLabel(java.lang.String... args)

setFormatDataLabel

@Nonnull
public MetricChart setFormatDataLabel(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getFormatDualDataLabel

@CheckReturnValue
 @Nonnull
public java.lang.String getFormatDualDataLabel(java.lang.String... args)

setFormatDualDataLabel

@Nonnull
public MetricChart setFormatDualDataLabel(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

hideLegend

@CheckReturnValue
public boolean hideLegend(java.lang.String... args)

setHideLegend

@Nonnull
public MetricChart setHideLegend(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getMatrixType

@CheckReturnValue
 @Nullable
public MatrixType getMatrixType(java.lang.String... args)

findMatrixType

@CheckReturnValue
 @Nonnull
public final MatrixType findMatrixType(java.lang.String... args)
                                                            throws NotFoundException

The chart's X axis name. Both of the matrixType and source fields are used to get the data for this chart.

--> MetricType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

MetricType

Throws:

NotFoundException - MetricType was not found

setMatrixType

@Nonnull
public MetricChart setMatrixType(com.aspc.dal.admin.jmx.MetricType value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getPluginParams

@CheckReturnValue
 @Nonnull
public java.lang.String getPluginParams(java.lang.String... args)

setPluginParams

@Nonnull
public MetricChart setPluginParams(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getSeq

@CheckReturnValue
public int getSeq(java.lang.String... args)

setSeq

@Nonnull
public MetricChart setSeq(int value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getStartDate

@CheckReturnValue
 @Nullable
public java.util.Date getStartDate(java.lang.String... args)

setStartDate

@Nonnull
public MetricChart setStartDate(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getTitle

@CheckReturnValue
 @Nonnull
public java.lang.String getTitle(java.lang.String... args)

setTitle

@Nonnull
public MetricChart setTitle(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getTitleX

@CheckReturnValue
 @Nonnull
public java.lang.String getTitleX(java.lang.String... args)

setTitleX

@Nonnull
public MetricChart setTitleX(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getTitleY

@CheckReturnValue
 @Nonnull
public java.lang.String getTitleY(java.lang.String... args)

setTitleY

@Nonnull
public MetricChart setTitleY(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getTreeBranchLabel

@CheckReturnValue
 @Nonnull
public java.lang.String getTreeBranchLabel(java.lang.String... args)

setTreeBranchLabel

@Nonnull
public MetricChart setTreeBranchLabel(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static MetricChart create(@Nonnull
                                                             MutableDataSource mds)
                                                      throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<MetricChart> makeQuery(@Nonnull
                                                                         DataSource ds)
                                                                  throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static MetricChart findKey(@Nonnull
                                                              DataSource ds,
                                                              int key)
                                                       throws NotFoundException,
                                                              java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value.

Throws:

java.lang.Exception - A serious problem