rrdService.util
Class GraphicPrint

java.lang.Object
  |
  +--rrdService.util.GraphicPrint
All Implemented Interfaces:
java.io.Serializable

public class GraphicPrint
extends java.lang.Object
implements java.io.Serializable

The class GraphicPrint Calculate the chosen consolidation function CF over the data-source variable vname and printf the result is printed into the graph below the legend. In the format string there should be a '%lf' or '%le' marker in the place where the number should be printed.

If an additional '%s' is found AFTER the marker, the value will be scaled and an appropriate SI magnitude unit will be printed in place of the '%s' marker. The scaling will take the '--base' argument into consideration!

If a '%S' is used instead of a '%s', then instead of calculating the appropriate SI magnitude unit for this value, the previously calculated SI magnitude unit will be used. This is useful if you want all the values in a PRINT statement to have the same SI magnitude unit. If there was no previous SI magnitude calculation made, then '%S' behaves like a '%s', unless the value is 0, in which case it does not remember a SI magnitude unit and a SI magnitude unit will only be calculated when the next '%s' is seen or the next '%S' for a non-zero value.

If you want to put a '%' into your PRINT string, use '%%' instead.

Version:
1.0 date : 15/07/2001
Author:
Damien Pellier
See Also:
GraphicPrint, RoundRobinGraphic, Serialized Form

Field Summary
private  ConsolidationFunction consolidationFunction
          consolidationFunction the consolidation function of this GraphicPrint
private  java.lang.String format
          format the format of text of this GraphicPrint
private  java.lang.String virtualName
          virtualName the virtual name for this GraphicPrint
 
Constructor Summary
GraphicPrint(java.lang.String virtualName, ConsolidationFunction consolidationFunction, java.lang.String format)
          Constructor of GraphicPrint
 
Method Summary
 ConsolidationFunction getConsolidationFunction()
          Returns the consolidation function of this GraphicPrint
 java.lang.String getFormat()
          Returns the format of text of this GraphicPrint
 java.lang.String getVirtualName()
          Retruns the virtual name for this GraphicPrint
 void setConsolidationFunction(ConsolidationFunction consolidationFunction)
          Replaces the consolidation function of this GraphicPrint
 void setFormat(java.lang.String format)
          Replaces the format of text of this GraphicPrint
 void setVirtualName(java.lang.String virtualName)
          Replaces the virtual name for this GraphicPrint
 java.lang.String toString()
          Returns a string representation of this GraphicPrint
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

consolidationFunction

private ConsolidationFunction consolidationFunction
consolidationFunction the consolidation function of this GraphicPrint

format

private java.lang.String format
format the format of text of this GraphicPrint

virtualName

private java.lang.String virtualName
virtualName the virtual name for this GraphicPrint
Constructor Detail

GraphicPrint

public GraphicPrint(java.lang.String virtualName,
                    ConsolidationFunction consolidationFunction,
                    java.lang.String format)
Constructor of GraphicPrint
Parameters:
virtualName - the virtual name for this GraphicPrint
consolidationFunction - the consolidation function of this GraphicPrint
format - the format of text of this GraphicPrint
Method Detail

getConsolidationFunction

public ConsolidationFunction getConsolidationFunction()
Returns the consolidation function of this GraphicPrint

getFormat

public java.lang.String getFormat()
Returns the format of text of this GraphicPrint

getVirtualName

public java.lang.String getVirtualName()
Retruns the virtual name for this GraphicPrint

setConsolidationFunction

public void setConsolidationFunction(ConsolidationFunction consolidationFunction)
Replaces the consolidation function of this GraphicPrint
Parameters:
consolidationFunction - the consolidation function of this GraphicPrint to set

setFormat

public void setFormat(java.lang.String format)
Replaces the format of text of this GraphicPrint
Parameters:
format - the format of text of this GraphicPrint

setVirtualName

public void setVirtualName(java.lang.String virtualName)
Replaces the virtual name for this GraphicPrint
Parameters:
virtualName - the virtual name for this GraphicPrint to set

toString

public java.lang.String toString()
Returns a string representation of this GraphicPrint
Overrides:
toString in class java.lang.Object

Copyright 1885-2001 FIRMENICH SA, Geneva

Submit a bug or feature
Copyright 1885-2001 FIRMENICH SA, Geneva,
All Rights Reserved.