de.bsvrz.ars.export
Class ExportProfile

java.lang.Object
  extended by de.bsvrz.ars.export.ExportProfile

public class ExportProfile
extends java.lang.Object

Ein ExportProfil enthält alle Informationen, die für das Durchführen eines Exportes nötig sind. Die Daten werden nach und nach gesetzt. Außerdem bietet die Klasse Methoden an, mit der die Datenspezifikationen serialisiert/deserialisiert werden können.

Version:
$Revision: 1.1 $ / $Date: 2008/01/22 16:39:42 $ / ($Author: yvonnes $)
Author:
beck et al. projects GmbH, Phil Schrettenbrunner

Nested Class Summary
static class ExportProfile.Format
          Mögliche Formate
static class ExportProfile.Modus
          Mögliche Modi
 
Field Summary
static java.text.DateFormat dateFormat
          Datumsformatierer
static java.lang.String datePattern
          Das Pattern für Datenangaben als String
static ExportProfile SINGLETON_INSTANCE
          Singleton Instanz
 
Method Summary
 java.util.Collection getAllObjects()
          Liefert die Liste aller Objekte des DatenModels zurück (für die Auswahl)
 DataspecificationList getDataSpecificationList()
          Die DatenspezifikationsListe (vom User ausgewählte Objekt, mit Namen)
 ClientDavInterface getDavConnection()
          liefert das Verbindungsobjekt zurück
 ExportProfile.Format getFormat()
          Liefert das Format als Enum (@link Format) zurück
 long getFrom()
          Liefert den Anfangszeitpunkt als long-Wert
 java.lang.String getFromAsString()
          Liefert den Anfangszeitpunkt in textueller Form zum Darstellen für den User.
 ExportProfile.Modus getModus()
          Gibt an, ob der Export im GUI oder CMD Modus gestartet wurde
 java.lang.String getOutputFile()
          Liefert ein File-Objekt für die Output-Datei
 SqlProperties getSqlProperties()
           
 long getUntil()
          Liefert den Endzeitpunkt als long-Wert
 java.lang.String getUntilAsString()
          Liefert den Endzeitpunkt in textueller Form zum Darstellen für den User.
 boolean hasFrom()
          Prüft, ob ein Von-Zeitstempel gesetzt ist
 boolean hasUntil()
          Prüft, ob ein Bis-Zeitstempel gesetzt ist
 boolean isComplete()
          Überprüft, ob dieses Exportprofil vollständig ist.
 boolean loadAllObjects()
          Lädt alle verfügbaren Objekte.
 java.util.List<java.lang.String> loadDataspecificationFile(java.io.File dataSpezification)
          File-Objekt für die XML-Datei, die die Datenspezifikation enthält.
 java.util.List<java.lang.String> loadDataspecificationFile(java.lang.String dataSpezification)
          File-Objekt für die XML-Datei, die die Datenspezifikation enthält.
 boolean openGui()
          Gibt an, ob die GUI für die Eingabe weiterer Daten benötigt wird.
 void setDavConnection(ClientDavInterface connection)
          Gibt dem ExportProfil ein Objekt, über das auf den Datenverteiler zugegriffen werden kann
 void setFormat(ExportProfile.Format format)
          Setzt das Format (XML bzw.
 void setFormat(java.lang.String format)
          Setzt das Format (XML bzw.
 void setFrom(long from)
          Setzt die Anfangszeit
 void setFrom(java.lang.String from)
          Setzt die Anfangszeit
 void setModus(ExportProfile.Modus modus)
          Setz den Modus (CUI/CMD)
 void setOutputFile(java.io.File outputFile)
          Setzt die Ausgabedatei
 void setOutputFile(java.lang.String outputFile)
          Setzt die Ausgabedatei
 void setSqlProperties(SqlProperties p)
          SQL-Properties, wenn nicht der Default genommen werden soll
 void setUntil(long until)
          Setzt den Endzeitpunkt
 void setUntil(java.lang.String until)
          Setzt den Endzeitpunkt
 java.lang.String toString()
          Textuelle Repräsentation dieses Objekts
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

datePattern

public static final java.lang.String datePattern
Das Pattern für Datenangaben als String

See Also:
Constant Field Values

dateFormat

public static final java.text.DateFormat dateFormat
Datumsformatierer


SINGLETON_INSTANCE

public static final ExportProfile SINGLETON_INSTANCE
Singleton Instanz

Method Detail

setDavConnection

public void setDavConnection(ClientDavInterface connection)
Gibt dem ExportProfil ein Objekt, über das auf den Datenverteiler zugegriffen werden kann

Parameters:
connection -

getDavConnection

public ClientDavInterface getDavConnection()
liefert das Verbindungsobjekt zurück

Returns:
Verbindungsobjekt zum DaV

getAllObjects

public java.util.Collection getAllObjects()
Liefert die Liste aller Objekte des DatenModels zurück (für die Auswahl)

Returns:
Liste aller Objekte des DatenModels

getDataSpecificationList

public DataspecificationList getDataSpecificationList()
Die DatenspezifikationsListe (vom User ausgewählte Objekt, mit Namen)

Returns:
DatenspezifikationsListe

getFormat

public ExportProfile.Format getFormat()
Liefert das Format als Enum (@link Format) zurück

Returns:
das gewählte Format, ev null

getFrom

public long getFrom()
Liefert den Anfangszeitpunkt als long-Wert

Returns:
der Anfangszeitpunkt als long Wert, 0 wenn nicht gesetzt

getFromAsString

public java.lang.String getFromAsString()
Liefert den Anfangszeitpunkt in textueller Form zum Darstellen für den User.

Returns:
Anfangszeitpunkt, formatiert als String, oder leerer String, wenn nicht gesetzt

getOutputFile

public java.lang.String getOutputFile()
Liefert ein File-Objekt für die Output-Datei

Returns:
File-Objekt der Outputdatei

getSqlProperties

public SqlProperties getSqlProperties()

getModus

public ExportProfile.Modus getModus()
Gibt an, ob der Export im GUI oder CMD Modus gestartet wurde

Returns:
Modus

getUntil

public long getUntil()
Liefert den Endzeitpunkt als long-Wert

Returns:
der Endzeitpunkt als long Wert, 0 wenn nicht gesetzt

getUntilAsString

public java.lang.String getUntilAsString()
Liefert den Endzeitpunkt in textueller Form zum Darstellen für den User.

Returns:
Endzeitpunkt, formatiert als String, oder leerer String, wenn nicht gesetzt

hasFrom

public boolean hasFrom()
Prüft, ob ein Von-Zeitstempel gesetzt ist

Returns:
Wahr, wenn ein Von-Zeitstempel gesetzt ist

hasUntil

public boolean hasUntil()
Prüft, ob ein Bis-Zeitstempel gesetzt ist

Returns:
Wahr, wenn ein Bis-Zeitstempel gesetzt ist

loadAllObjects

public boolean loadAllObjects()
Lädt alle verfügbaren Objekte. Diese werden vorallem Benötigt, um die Listen der GUI zu füllen

Returns:
Wahr, wenn das Laden erfolgreich war

isComplete

public boolean isComplete()
Überprüft, ob dieses Exportprofil vollständig ist. Das heißt, es wird überprüft, ob alle Felder gesetzt sind. Es ist Aufgabe der Setter zu übeprüfen, dass die Daten in den Feldern semantisch korrekt sind.

Returns:
Liefert true zurück, wenn alle Informationen vorhanden sind, um einen Export durchzuführen

loadDataspecificationFile

public java.util.List<java.lang.String> loadDataspecificationFile(java.io.File dataSpezification)
                                                           throws java.io.FileNotFoundException,
                                                                  org.xml.sax.SAXException,
                                                                  java.io.IOException
File-Objekt für die XML-Datei, die die Datenspezifikation enthält. Diese Methode parst die Datei und erzeugt entsprechende Java-Objekte.

Parameters:
dataSpezification - Datei-Objekt
Returns:
List an Strings mit Fehlermeldung. Wenn die Liste leer ist, gab es keine Fehler
Throws:
java.io.FileNotFoundException - Wenn die Datei nicht gefunden wurde
org.xml.sax.SAXException - Jede Art von Perser Exception
java.io.IOException - Bei Zugriffsproblemen

loadDataspecificationFile

public java.util.List<java.lang.String> loadDataspecificationFile(java.lang.String dataSpezification)
                                                           throws java.io.FileNotFoundException,
                                                                  org.xml.sax.SAXException,
                                                                  java.io.IOException
File-Objekt für die XML-Datei, die die Datenspezifikation enthält.

Parameters:
dataSpezification - Dateiname als String
Returns:
List an Strings mit Fehlermeldung. Wenn die Liste leer ist, gab es keine Fehler
Throws:
java.io.FileNotFoundException - Wenn die Datei nicht gefunden wurde
org.xml.sax.SAXException - Jede Art von Perser Exception
java.io.IOException - Bei Zugriffsproblemen
See Also:
loadDataspecificationFile(File dataSpezification)

setFormat

public void setFormat(ExportProfile.Format format)
Setzt das Format (XML bzw. SQL) mit einem Wert aus

Parameters:
format - Das Format

setFormat

public void setFormat(java.lang.String format)
Setzt das Format (XML bzw. SQL) für den Export Der String ist Caseinsensitive.

Parameters:
format -

setFrom

public void setFrom(long from)
Setzt die Anfangszeit

Parameters:
from - Anfangszeit als long-Wert

setFrom

public void setFrom(java.lang.String from)
             throws java.text.ParseException
Setzt die Anfangszeit

Parameters:
from - Anfangszeit als String im Format TT.MM.JJJJ SS:MM:ss
Throws:
ParseException, - wenn der String nicht in ein Datum umgewandelt werden kann
java.text.ParseException

setOutputFile

public void setOutputFile(java.io.File outputFile)
Setzt die Ausgabedatei

Parameters:
outputFile - Ausgabedatei

setOutputFile

public void setOutputFile(java.lang.String outputFile)
Setzt die Ausgabedatei

Parameters:
outputFile - Ausgabedatei

setModus

public void setModus(ExportProfile.Modus modus)
Setz den Modus (CUI/CMD)

Parameters:
modus - Modus (CUI/CMD)

setSqlProperties

public void setSqlProperties(SqlProperties p)
SQL-Properties, wenn nicht der Default genommen werden soll


setUntil

public void setUntil(long until)
Setzt den Endzeitpunkt

Parameters:
until - Endzeitpunkt als long-Wert

setUntil

public void setUntil(java.lang.String until)
              throws java.text.ParseException
Setzt den Endzeitpunkt

Parameters:
until - Endzeitpunkt als String im Format TT.MM.JJJJ SS:MM:ss
Throws:
ParseException, - wenn der String nicht als Datum interpretiert werden kann
java.text.ParseException

toString

public java.lang.String toString()
Textuelle Repräsentation dieses Objekts

Overrides:
toString in class java.lang.Object
Returns:
String mit den wichtigsten Informationen, die in diesem Objekt gespeichert sind
See Also:
Object.toString()

openGui

public boolean openGui()
Gibt an, ob die GUI für die Eingabe weiterer Daten benötigt wird.

Returns:
Ob das GUI geöffnet werden muss oder nicht


Copyright © 2005-2008 beck et al. projects GmbH All Rights Reserved.