de.bsvrz.buv.rw.basislib.interfaces.diagramme
Interface IDiagramm


public interface IDiagramm

Interface für die Datenübergabe an Diagramm-Plugin's.

Version:
$Revision: 1.1 $ / $Date: 2009/12/02 09:21:03 $ / ($Author: HofmannJ $)
Author:
Dambach-Werke GmbH, Thomas Drapp

Nested Class Summary
static class IDiagramm.BeschriftungsPosition
          Dieser Aufzählungstyp beschreibt die möglichen Positionen für die Beschriftung bei Diagrammen.
static class IDiagramm.DatenEinfuegeArt
          Dieser Aufzählungstyp beschreibt die möglichen EinfügeArten für Daten bei Diagrammen.
static class IDiagramm.SchriftAusrichtung
          Dieser Aufzählungstyp beschreibt die möglichen Schriftausrichtungen für die Beschriftung bei Diagrammen.
 
Field Summary
static int DIAGRAMMTYP_BALKEN
          Balken-Diagramm
static int DIAGRAMMTYP_BALKEN3D
          Balken-Diagramm 3D
static int DIAGRAMMTYP_FLAECHE
          Flächen-Diagramm
static int DIAGRAMMTYP_GESTAPELTE_BALKEN
          Gestapelte-Balken-Diagramm
static int DIAGRAMMTYP_GESTAPELTE_BALKEN3D
          Gestapelte-Balken-Diagramm 3D
static int DIAGRAMMTYP_GESTAPELTE_FLAECHEN
          Gestapelte-Flaechen-Diagramm
static int DIAGRAMMTYP_LINIEN
          Linien-Diagramm
static int DIAGRAMMTYP_PUNKT
          Punkt-Diagramm
static int DIAGRAMMTYP_TORTE
          Torten-Diagramm
static int DIAGRAMMTYP_TORTE3D
          Torten-Diagramm 3D
 
Method Summary
 void beschriftungHinzufuegen(java.lang.String text, int textHoehe, java.lang.String schriftArt, IDiagramm.SchriftAusrichtung schriftAusrichtung, IDiagramm.BeschriftungsPosition beschriftungsPosition)
          Hinzufügen einer Beschriftung zum Diagramm.
 void darstellen(int breite, int hoehe)
          Diagramm in der übergebenen Breite und Höhe darstellen.
 int datenHinzufuegen(int indexYAchse, int indexDatenReihe, int einfuegePosition, IDiagramm.DatenEinfuegeArt datenEinfuegeArt, double[] daten)
          Hinzufügen von Daten zu einer vorhandenen Datenreihe.
 int datenReiheHinzufuegen(int indexYAchse, double[] daten, long farbe, int diagrammTyp)
          Hinzufügen einer DatenReihe zu einer Y-Achse.
 void datenReiheSichtbarkeit(int indexDatenReihe, boolean sichtbarkeit)
          Steuerung der Sichtbarkeit einer Datenreihe.
 int xAchseHinzufuegen(java.lang.String bezeichnung, long anfangs, long ende, boolean datumsAngabe)
          Hinzufügen einer X-Achse zum Diagramm mit Anfangs- und Enddatum oder -zeit.
 int xAchseHinzufuegen(java.lang.String bezeichnung, java.lang.String[] beschriftung)
          Hinzufügen einer X-Achse zum Diagramm mit Beschriftungsfeld.
 int xAchseHinzufuegen(java.lang.String bezeichnung, stauma.dav.configuration.interfaces.SystemObject[] beschriftungsObjekte)
          Hinzufügen einer X-Achse zum Diagramm mit SystemObjekt-Feld, Methode getName() wird für die Beschriftung verwendet.
 int yAchseHinzufuegen(java.lang.String einheit, double minimalWert, double maximaleWert, double schrittWeite)
          Hinzufügen einer Y-Achse zum Diagramm.
 

Field Detail

DIAGRAMMTYP_LINIEN

static final int DIAGRAMMTYP_LINIEN
Linien-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_PUNKT

static final int DIAGRAMMTYP_PUNKT
Punkt-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_BALKEN

static final int DIAGRAMMTYP_BALKEN
Balken-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_GESTAPELTE_BALKEN

static final int DIAGRAMMTYP_GESTAPELTE_BALKEN
Gestapelte-Balken-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_BALKEN3D

static final int DIAGRAMMTYP_BALKEN3D
Balken-Diagramm 3D

See Also:
Constant Field Values

DIAGRAMMTYP_GESTAPELTE_BALKEN3D

static final int DIAGRAMMTYP_GESTAPELTE_BALKEN3D
Gestapelte-Balken-Diagramm 3D

See Also:
Constant Field Values

DIAGRAMMTYP_FLAECHE

static final int DIAGRAMMTYP_FLAECHE
Flächen-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_GESTAPELTE_FLAECHEN

static final int DIAGRAMMTYP_GESTAPELTE_FLAECHEN
Gestapelte-Flaechen-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_TORTE

static final int DIAGRAMMTYP_TORTE
Torten-Diagramm

See Also:
Constant Field Values

DIAGRAMMTYP_TORTE3D

static final int DIAGRAMMTYP_TORTE3D
Torten-Diagramm 3D

See Also:
Constant Field Values
Method Detail

xAchseHinzufuegen

int xAchseHinzufuegen(java.lang.String bezeichnung,
                      java.lang.String[] beschriftung)
Hinzufügen einer X-Achse zum Diagramm mit Beschriftungsfeld.

Parameters:
bezeichnung - Bezeichnung der Achse, wird im Diagramm ausgegeben.
beschriftung - Beschriftungsfeld mit Beschriftungen für alle X-Achsen-Positionen (abhängig von Anzahl diskrete Werte in DatenReihe).
Returns:
Index der Achse, -1, wenn Hinzufügen fehlgeschlagen.

xAchseHinzufuegen

int xAchseHinzufuegen(java.lang.String bezeichnung,
                      long anfangs,
                      long ende,
                      boolean datumsAngabe)
Hinzufügen einer X-Achse zum Diagramm mit Anfangs- und Enddatum oder -zeit.

Parameters:
bezeichnung - Bezeichnung der Achse, wird im Diagramm ausgegeben.
anfang - Zeit in Millisekunden für Anfand.
ende - Zeit in Millisekunden für Ende.
datumsAngabe - true für anfang und ende sind Datumsangabe, false für sind Zeitangabe.
Returns:
Index der Achse, -1, wenn Hinzufügen fehlgeschlagen.

xAchseHinzufuegen

int xAchseHinzufuegen(java.lang.String bezeichnung,
                      stauma.dav.configuration.interfaces.SystemObject[] beschriftungsObjekte)
Hinzufügen einer X-Achse zum Diagramm mit SystemObjekt-Feld, Methode getName() wird für die Beschriftung verwendet.

Parameters:
bezeichnung - Bezeichnung der Achse, wird im Diagramm ausgegeben.
beschriftungsObjekte - Feld mit Objekten für alle X-Achsen-Positionen (abhängig von Anzahl diskrete Werte in DatenReihe), die Methode getName() wird für die Beschriftung verwendet.
Returns:
Index der Achse, -1, wenn Hinzufügen fehlgeschlagen.

yAchseHinzufuegen

int yAchseHinzufuegen(java.lang.String einheit,
                      double minimalWert,
                      double maximaleWert,
                      double schrittWeite)
Hinzufügen einer Y-Achse zum Diagramm.

Parameters:
einheit - Einheit der Achse, wird im Diagramm in eckigen Klammern ("[" und "]") ausgegeben.
minimalWert - minimaler Wert dieser Achse.
maximaleWert - maximaler Wert dieser Achse.
schrittWeite - Schrittweite zwischen den Achsenbeschriftungen.
Returns:
Index der Achse (wird als Referenz für die Bezugnahme auf diese Achse benötigt), -1, wenn Hinzufügen fehlgeschlagen.

datenReiheHinzufuegen

int datenReiheHinzufuegen(int indexYAchse,
                          double[] daten,
                          long farbe,
                          int diagrammTyp)
Hinzufügen einer DatenReihe zu einer Y-Achse.

Parameters:
indexYAchse - Index der Y-Achse, an der die Datenreihe hinzugefügt wird (@see #yAchseHinzufuegen(String, double, double, double)).
daten - Feld mit den hinzuzufügenden Daten.
farbe - Farbe der Datenreihe im RGB-Format (Beispiel Rot = 0xff0000).
diagrammTyp - DiagrammTyp (@see Konstanten DIAGRAMMTYP_... oder erweiternder Wert für bei Konstanten unbekannten typ).
Returns:
Index der DatenReihe (wird als Referenz für die Bezugnahme auf diese Datenreihe benötigt), -1, wenn Hinzufügen fehlgeschlagen.

datenHinzufuegen

int datenHinzufuegen(int indexYAchse,
                     int indexDatenReihe,
                     int einfuegePosition,
                     IDiagramm.DatenEinfuegeArt datenEinfuegeArt,
                     double[] daten)
Hinzufügen von Daten zu einer vorhandenen Datenreihe.
Der Index der Y-Achse und der Index der Datenreihe wird für diese Aktion benötigt.

Parameters:
indexYAchse - Index der Y-Achse, an der die Datenreihe vorhanden ist (@see #yAchseHinzufuegen(String, double, double, double)).
indexDatenReihe - Index der vorhanden Datenreihe, an der die Daten hinzugefuegt werden (@see #datenReiheHinzufuegen()).
einfuegePosition - Position, vor bzw. hinter der die Daten eingefügt werden (-1 enspricht letzter Position, Position beginnt bei 0).
datenEinfuegeArt - Einfügeart mit der die Daten eingefügt werden.
daten - Feld mit den hinzuzufügenden Daten.
Returns:
Anzahl der in der Datenreihe nach dem Hinzufügen enthaltenen Daten, -1, wenn Hinzufügen fehlgeschlagen.

datenReiheSichtbarkeit

void datenReiheSichtbarkeit(int indexDatenReihe,
                            boolean sichtbarkeit)
Steuerung der Sichtbarkeit einer Datenreihe.

Parameters:
indexDatenReihe - Index der Datenreihe (@see #datenHinzufuegen(int, int, int, DatenEinfuegeArt, double[])).
sichtbarkeit - true wenn Datenreihe angezeigt werden soll, sonst false

beschriftungHinzufuegen

void beschriftungHinzufuegen(java.lang.String text,
                             int textHoehe,
                             java.lang.String schriftArt,
                             IDiagramm.SchriftAusrichtung schriftAusrichtung,
                             IDiagramm.BeschriftungsPosition beschriftungsPosition)
Hinzufügen einer Beschriftung zum Diagramm.

Parameters:
text - Beschriftungstext.
textHoehe - Texthöhe in Pixel.
schriftArt - Schriftart entsprechend Face Names.
schriftAusrichtung - Ausrichtung des Beschriftungstextes.
beschriftungsPosition - Position des Beschriftungstextes.

darstellen

void darstellen(int breite,
                int hoehe)
Diagramm in der übergebenen Breite und Höhe darstellen.

Parameters:
breite - Breite des Diagramms in Pixel.
hoehe - Höhe des Diagramms in Pixel.