Regain 2.1.0-STABLE API

net.sf.regain.crawler
Class Profiler

java.lang.Object
  extended by net.sf.regain.crawler.Profiler

public class Profiler
extends Object

Misst die Zeit und den Datendurchsatz für einen Verarbeitungsschritt.

Author:
Til Schneider, www.murfman.de

Field Summary
private  int mAbortedMeasureCount
          Die Anzahl der abgebrochenen Messungen.
private static org.apache.log4j.Logger mLog
          The logger for this class
private  int mMeasureCount
          Die Anzahl der Messungen.
private  long mMeasureStart
          Die Zeit, zu der die laufende Messung begonnen hat.
private  String mName
          Der Name.
private static List<Profiler> mProfilerList
          Eine Liste mit allen erzeugten Profilern.
private  long mTotalBytes
          Die kummulierte Datenmenge.
private  long mTotalTime
          Die kummulierte Gesamtzeit.
private  String mUnit
          Der Einheit, die gemessen wird.
 
Constructor Summary
Profiler(String name, String unit)
          Erzeugt eine neue Profiler-Instanz und registriert sie bei der Profiler-Liste.
 
Method Summary
 void abortMeasuring()
          Bricht eine Messung ab.
private  void appendLabel(StringBuffer buffer, String label, int minLabelLength)
          F�gt bei einem StringBuffer eine Beschriftung hinzu.
static void clearRegisteredProfilers()
          Clears the registered profilers.
 int getAbortedMeasureCount()
          Gets the number of aborted measures.
 long getCurrentMeasuringTime()
          Gets the current time of the measuring running now.
 int getMeasureCount()
          Gets the number of measures.
static String getProfilerResults()
          Gibt die Resultate saemtlicher genutzter Profiler zurück.
private static void registerProfiler(Profiler profiler)
          Registriert einen Profiler.
 void startMeasuring()
          Startet eine Messung.
 void stopMeasuring(long bytes)
          Stoppt eine Messung.
 String toString()
          Gibt das Resultat der Messungen als String zurück.
 boolean wasUsed()
          Gibt zurück, ob dieser Profiler genutzt wurde.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

mLog

private static org.apache.log4j.Logger mLog
The logger for this class


mProfilerList

private static List<Profiler> mProfilerList
Eine Liste mit allen erzeugten Profilern.


mName

private String mName
Der Name.


mUnit

private String mUnit
Der Einheit, die gemessen wird.


mTotalTime

private long mTotalTime
Die kummulierte Gesamtzeit.


mTotalBytes

private long mTotalBytes
Die kummulierte Datenmenge.


mMeasureCount

private int mMeasureCount
Die Anzahl der Messungen.


mAbortedMeasureCount

private int mAbortedMeasureCount
Die Anzahl der abgebrochenen Messungen.


mMeasureStart

private long mMeasureStart
Die Zeit, zu der die laufende Messung begonnen hat. Ist -1, wenn keine Messung läuft.

Constructor Detail

Profiler

public Profiler(String name,
                String unit)
Erzeugt eine neue Profiler-Instanz und registriert sie bei der Profiler-Liste.

Parameters:
name - Der Name des Verarbeitungsschrittes, der mit diesem Profiler gemessen werden sollen.
unit - Die Bezeichnung der Dinge, die der Verarbeitungsschritt verarbeitet, z.B. documents.
Method Detail

getMeasureCount

public int getMeasureCount()
Gets the number of measures.

Returns:
The number of measures.

getAbortedMeasureCount

public int getAbortedMeasureCount()
Gets the number of aborted measures.

Returns:
The number of aborted measures.

getCurrentMeasuringTime

public long getCurrentMeasuringTime()
Gets the current time of the measuring running now.

Returns:
The current measuring time in milli seconds.

clearRegisteredProfilers

public static void clearRegisteredProfilers()
Clears the registered profilers.


registerProfiler

private static void registerProfiler(Profiler profiler)
Registriert einen Profiler.

Parameters:
profiler - Der zu registrierende Profiler.

startMeasuring

public void startMeasuring()
Startet eine Messung.


stopMeasuring

public void stopMeasuring(long bytes)
Stoppt eine Messung.

Parameters:
bytes - Die Anzahl der verarbeiteten Bytes.

abortMeasuring

public void abortMeasuring()
Bricht eine Messung ab. Eine Messung wird dann abgebrochen, wenn der Verarbeitungsschritt nicht korrekt verlaufen ist, z.B. weil eine Exception geworfen wurde.


toString

public String toString()
Gibt das Resultat der Messungen als String zurück.

Overrides:
toString in class Object
Returns:
Das Resultat der Messungen

appendLabel

private void appendLabel(StringBuffer buffer,
                         String label,
                         int minLabelLength)
F�gt bei einem StringBuffer eine Beschriftung hinzu. Dabei werden so viele Leerzeichen angeh�ngt, dass alle Beschriftungen auf selber H�he enden.

Parameters:
buffer - Der StringBuffer bei dem die Beschriftung hinzugef�gt werden soll.
label - Die Beschriftung, die hinzugef�gt werden soll.
minLabelLength - Die minimale L�nge der Beschriftung. (Der Rest wird mit Leerzeichen aufgef�llt).

wasUsed

public boolean wasUsed()
Gibt zurück, ob dieser Profiler genutzt wurde. Das ist der Fall, wenn mindestens eine Messung durchgef�hrt wurde.

Returns:
Ob dieser Profiler genutzt wurde.

getProfilerResults

public static String getProfilerResults()
Gibt die Resultate saemtlicher genutzter Profiler zurück.

Returns:
Die Resultate saemtlicher genutzter Profiler.

Regain 2.1.0-STABLE API

Regain 2.1.0-STABLE, Copyright (C) 2004-2010 Til Schneider, www.murfman.de, Thomas Tesche, www.clustersystems.info