Package de.willuhn.datasource.db
Class AbstractDBObject
java.lang.Object
java.rmi.server.RemoteObject
java.rmi.server.RemoteServer
java.rmi.server.UnicastRemoteObject
de.willuhn.datasource.db.AbstractDBObject
- All Implemented Interfaces:
GenericObject,Changeable,DBObject,Transactionable,Serializable,Remote
- Direct Known Subclasses:
AbstractDBObjectNode
Basisklasse fuer alle Business-Objekte
- Author:
- willuhn
- See Also:
-
Field Summary
Fields inherited from class java.rmi.server.RemoteObject
ref -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidFuegt dem Objekt einen Listener hinzu, der ausgeloest wird, wenn das Objekt gerade geloescht wurde.voidFuegt dem Objekt einen Listener hinzu, der ausgeloest wird, wenn das Objekt gespeichert wurde.final voidclear()Loescht alle Eigenschaften (incl.voiddelete()Loescht das Objekt aus der Datenbank.protected voidDiese Methode wird intern vor der Ausfuehrung von delete() aufgerufen.booleanequals(GenericObject other) Vergleicht dieses Objekt mit dem uebergebenen.getAttribute(String fieldName) Liefert den Wert des angegebenen Attributes.final String[]Liefert ein String-Array mit allen verfuegbaren Attribut-Namen.final StringgetAttributeType(String attributeName) Liefert den Attributtyp des uebergebenen Feldes.protected ClassgetForeignObject(String field) Prueft, ob das angegebene Feld ein Fremschluessel zu einer anderen Tabelle ist.final StringgetID()Liefert einen Identifier fuer dieses Objekt.protected StringLiefert den Namen der Spalte, in der sich der Primary-Key befindet.protected PreparedStatementLiefert das automatisch erzeugte SQL-Statement fuer ein Insert.getList()Liefert eine Liste aller Objekte des aktuellen Types.protected StringLiefert das automatisch erzeugte SQL-Statement fuer die Erzeugung einer Liste dieses Typs.protected StringLiefert das automatisch erzeugte SQL-Statement zum Laden des Objektes.abstract StringLiefert den Namen des Primaer-Attributes dieses Objektes.protected DBServiceImplLiefert den Service-Provider.protected abstract StringLiefert den Namen der repraesentierenden SQL-Tabelle.protected PreparedStatementLiefert das automatisch erzeugte SQL-Statement fuer ein Update.protected booleanPrueft, ob das Objekt seit dem Laden geaendert wurde.protected booleanhasChanged(String attribute) Prueft, ob sich der Wert des genannten Attributs seit dem Laden geaendert hat.protected voidinit()Holt sich die Meta-Daten der Tabelle und erzeugt die Properties.voidinsert()Speichert das Objekt explizit als neuen Datensatz in der Datenbank.protected voidDiese Methode wird intern vor der Ausfuehrung von insert() aufgerufen.final booleanPrueft, ob es sich um ein neues Objekt oder ein bereits in der Datenbank existierendes handelt.final voidLaedt die Eigenschaften des Datensatzes mit der angegebenen ID aus der Datenbank.voidUeberschreibt dieses Objekt mit den Attributen des uebergebenen.voidEntfernt den Listener wieder.voidEntfernt den Listener wieder.setAttribute(String fieldName, Object value) Speichert einen neuen Wert in den Properties und liefert den vorherigen zurueck.final voidSpeichert die uebergeben ID in diesem Objekt.protected voidsetService(DBServiceImpl service) Speichert den Service-Provider.voidstore()Speichert das Objekt in der Datenbank.final voidDamit kann man manuell eine Transaktion starten.final voidBeendet eine manuell gestartete Transaktion.final voidRollt die angefangene Transaktion manuell zurueck.protected voidDiese Methode wird intern vor der Ausfuehrung von update() aufgerufen.Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObjectMethods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
-
Constructor Details
-
AbstractDBObject
ct- Throws:
RemoteException
-
-
Method Details
-
setService
Speichert den Service-Provider.- Parameters:
service-- Throws:
Exception
-
getService
Liefert den Service-Provider.- Returns:
- Service.
-
init
Holt sich die Meta-Daten der Tabelle und erzeugt die Properties.- Throws:
SQLException- Wenn beim Laden der Meta-Daten ein Datenbank-Fehler auftrat.
-
load
Description copied from interface:DBObjectLaedt die Eigenschaften des Datensatzes mit der angegebenen ID aus der Datenbank.- Specified by:
loadin interfaceDBObject- Parameters:
id- ID des zu ladenden Objektes.- Throws:
RemoteException- im Fehlerfall.- See Also:
-
store
Description copied from interface:ChangeableSpeichert das Objekt in der Datenbank. Die Funktion prueft selbst, ob es sich um ein neues Objekt handelt und entscheidet, ob ein insert oder update durchgefuehrt werden muss.- Specified by:
storein interfaceChangeable- Throws:
RemoteException- im Fehlerfall.de.willuhn.util.ApplicationException- Wenn das Objekt nicht gespeichert werden darf. Der Grund hierfuer findet sich im Fehlertext der Exception.- See Also:
-
clear
Description copied from interface:ChangeableLoescht alle Eigenschaften (incl. ID) aus dem Objekt. Es kann nun erneut befuellt und als neues Objekt in der Datenbank gespeichert werden.- Specified by:
clearin interfaceChangeable- Throws:
RemoteException- im Fehlerfall.- See Also:
-
delete
Description copied from interface:ChangeableLoescht das Objekt aus der Datenbank.- Specified by:
deletein interfaceChangeable- Throws:
RemoteException- im Fehlerfall.de.willuhn.util.ApplicationException- Wenn das Objekt nicht geloescht werden darf. Der Grund hierfuer findet sich im Fehlertext der Exception.- See Also:
-
getID
Description copied from interface:GenericObjectLiefert einen Identifier fuer dieses Objekt. Dieser muss innerhalb des gesamten Systems/Services fuer diese Objektart eindeutig sein.- Specified by:
getIDin interfaceGenericObject- Returns:
- der Identifier des Objektes.
- Throws:
RemoteException- See Also:
-
setID
Speichert die uebergeben ID in diesem Objekt. Diese Funktion ist mit aeusserster Vorsicht zu geniessen. Sie wird z.Bsp. dann gebraucht, wenn ein Objekt von einer DB auf eine andere kopiert wird und dabei zwingend mit der ID der Ursprungs-Datenbank angelegt werden muss.- Parameters:
id-
-
getAttribute
Description copied from interface:DBObjectLiefert den Wert des angegebenen Attributes. Aber die Funktion ist richtig schlau ;) Sie checkt naemlich den Typ des Feldes in der Datenbank und liefert nicht nur einen String sondern den korrespondierenden Java-Typ. Insofern die Businessklasse die Funktion getForeignObject(String field) sinnvoll uberschrieben hat, liefert die Funktion bei Fremdschluesseln sogar gleich das entsprechende Objekt aus der Verknuepfungstabelle.- Specified by:
getAttributein interfaceDBObject- Specified by:
getAttributein interfaceGenericObject- Parameters:
fieldName- Name des Feldes.- Returns:
- Wert des Feldes.
- Throws:
RemoteException- im Fehlerfall.- See Also:
-
getAttributeType
Description copied from interface:DBObjectLiefert den Attributtyp des uebergebenen Feldes. Siehe DBObject.ATTRIBUTETYPE_*.- Specified by:
getAttributeTypein interfaceDBObject- Parameters:
attributeName- Name des Attributes.- Returns:
- Konstante fuer den Attributtyp. Siehe DBObject.ATTRIBUTETYPE_*.
- Throws:
RemoteException- im Fehlerfall.- See Also:
-
hasChanged
protected boolean hasChanged()Prueft, ob das Objekt seit dem Laden geaendert wurde.- Returns:
- true, wenn es geaendert wurde.
-
hasChanged
Prueft, ob sich der Wert des genannten Attributs seit dem Laden geaendert hat.- Parameters:
attribute- Name des Attributes.- Returns:
- true, wenn es sich geaendert hat.
-
setAttribute
Speichert einen neuen Wert in den Properties und liefert den vorherigen zurueck.- Parameters:
fieldName- Name des Feldes.value- neuer Wert des Feldes. Muss vom Typ String, Date, Timestamp, Double, Integer oder DBObject sein.
Ist der Parameter vom TypdbObjectnimmt die Funktion an, dass es sich um einen Fremdschluessel handelt und speichert automatisch statt des Objektes selbst nur dessen ID mittelsnew Integer(((DBObject)value).getID()).- Returns:
- vorheriger Wert des Feldes.
- Throws:
RemoteException
-
getAttributeNames
Description copied from interface:GenericObjectLiefert ein String-Array mit allen verfuegbaren Attribut-Namen.- Specified by:
getAttributeNamesin interfaceGenericObject- Returns:
- Liste aller Attribut-Namen.
- Throws:
RemoteException- See Also:
-
insert
Speichert das Objekt explizit als neuen Datensatz in der Datenbank. Die Funktion wird auch dann ein Insert versuchen, wenn das Objekt bereits eine ID besitzt. Das ist z.Bsp. sinnvoll, wenn das Objekt von einer Datenbank auf eine andere kopiert werden soll. Es kann jedoch durchaus fehlschlagen, wenn ein Objekt mit dieser ID bereits in der Datenbank existiert.- Throws:
RemoteException- Wenn beim Speichern Fehler aufgetreten sind.de.willuhn.util.ApplicationException- DurchinsertCheck()erzeugte Benutzerfehler.
-
getUpdateSQL
Liefert das automatisch erzeugte SQL-Statement fuer ein Update. Kann bei Bedarf ueberschrieben um ein vom dynamisch erzeugten abweichendes Statement f�r die Speicherung zu verwenden. Die Funktion darfzurueckliefern, wenn nichts zu aendern ist. - Returns:
- das erzeugte SQL-Statement.
- Throws:
RemoteException- wenn beim Erzugen des Statements ein Fehler auftrat.
-
getInsertSQL
Liefert das automatisch erzeugte SQL-Statement fuer ein Insert. Kann bei Bedarf ueberschrieben um ein vom dynamisch erzeugten abweichendes Statement fuer die Speicherung zu verwenden.- Returns:
- das erzeugte SQL-Statement.
- Throws:
RemoteException- Wenn beim Erzeugen des Statements ein Fehler auftrat.
-
getListQuery
Liefert das automatisch erzeugte SQL-Statement fuer die Erzeugung einer Liste dieses Typs. ACHTUNG: Das Statement muss ein Feld mit der Bezeichnung zurueckgeben, diegetIDFieldauch liefert, da das von DBIteratorImpl gelesen wird. Also z.Bsp. "select " + getIDField() + " from " + getTableName(). Kann bei Bedarf �berschrieben um ein abweichendes Statement zu verwenden. Die Funktion muss das Statement nur dewegen als String zurueckliefern, weil es typischerweise von DBIterator weiterverwendet wird und dort eventuell noch weitere Filterkriterien hinzugefuegt werden koennen muessen.- Returns:
- das erzeugte SQL-Statement.
-
getLoadQuery
Liefert das automatisch erzeugte SQL-Statement zum Laden des Objektes. Hierbei werden die Eigenschaften des Objektes geladen, dessen ID aktuell vongetID()geliefert wird. ACHTUNG: Das Statement muss alle Felder selecten (*). Also z.Bsp. "select * from " + getTableName() + " where " + getIDField() + " = " + getID(); Kann bei Bedarf �berschrieben um ein abweichendes Statement zu verwenden.- Returns:
- das erzeugte SQL-Statement.
- Throws:
RemoteException- Wenn beim Erzeugen des Statements ein Fehler auftrat.
-
isNewObject
Description copied from interface:ChangeablePrueft, ob es sich um ein neues Objekt oder ein bereits in der Datenbank existierendes handelt.- Specified by:
isNewObjectin interfaceChangeable- Returns:
- true, wenn es neu ist, andernfalls false.
- Throws:
RemoteException- im Fehlerfall.- See Also:
-
getIDField
Liefert den Namen der Spalte, in der sich der Primary-Key befindet. Default: "id".- Returns:
- Name der Spalte mit dem Primary-Key.
-
getTableName
Liefert den Namen der repraesentierenden SQL-Tabelle. Muss von allen abgeleiteten Klassen implementiert werden.- Returns:
- Name der repraesentierenden SQL-Tabelle.
-
getPrimaryAttribute
Description copied from interface:GenericObjectLiefert den Namen des Primaer-Attributes dieses Objektes. Hintergrund: Wenn man z.Bsp. in einer Select-Box nur einen Wert anzeigen kann, dann wird dieser genommen. Achtung: Die Funktion liefert nicht den Wert des Attributes sondern nur dessen Namen.- Specified by:
getPrimaryAttributein interfaceDBObject- Specified by:
getPrimaryAttributein interfaceGenericObject- Returns:
- Name des Primaer-Attributes.
- Throws:
RemoteException- im Fehlerfall.- See Also:
-
deleteCheck
protected void deleteCheck() throws de.willuhn.util.ApplicationExceptionDiese Methode wird intern vor der Ausfuehrung von delete() aufgerufen. Sie muss �berschrieben werden, damit das Fachobjekt vor dem Durchf�hren der L�schaktion Pr�fungen vornehmen kann. Z.Bsp. ob eventuell noch Abhaengigkeiten existieren und das Objekt daher nicht gel�scht werden kann.- Throws:
de.willuhn.util.ApplicationException- wenn das Objekt nicht gel�scht werden darf.
-
insertCheck
protected void insertCheck() throws de.willuhn.util.ApplicationExceptionDiese Methode wird intern vor der Ausfuehrung von insert() aufgerufen. Sie muss �berschrieben werden, damit das Fachobjekt vor dem Durchf�hren der Speicherung Pr�fungen vornehmen kann. Z.Bsp. ob alle Pflichtfelder ausgef�llt sind und korrekte Werte enthalten.- Throws:
de.willuhn.util.ApplicationException- wenn das Objekt nicht gespeichert werden darf.
-
updateCheck
protected void updateCheck() throws de.willuhn.util.ApplicationExceptionDiese Methode wird intern vor der Ausfuehrung von update() aufgerufen. Sie muss �berschrieben werden, damit das Fachobjekt vor dem Durchf�hren der Speicherung Pr�fungen vornehmen kann. Z.Bsp. ob alle Pflichtfelder ausgef�llt sind und korrekte Werte enthalten.- Throws:
de.willuhn.util.ApplicationException- wenn das Objekt nicht gespeichert werden darf.
-
getForeignObject
Prueft, ob das angegebene Feld ein Fremschluessel zu einer anderen Tabelle ist. Wenn das der Fall ist, liefert es die Klasse, die die Fremd-Tabelle abbildet. Andernfalls null.- Parameters:
field- das zu pruefende Feld.- Returns:
- Klasse (abgeleitet von DBObject) welche den Fremdschluessel abbildet oder null.
- Throws:
RemoteException- im Fehlerfall.
-
transactionBegin
Description copied from interface:TransactionableDamit kann man manuell eine Transaktion starten. Normalerweise wir bei store() oder delete() sofort bei Erfolg ein commit gemacht. Wenn man aber von aussen das Transaktionsverhalten beeinflussen will, kann man diese Methode aufrufen. Hat man dies getan, werden store() und delete() erst dann in der Datenbank ausgefuehrt, wenn man anschliessend transactionCommit() aufruft.- Specified by:
transactionBeginin interfaceTransactionable- Throws:
RemoteException- im Fehlerfall.- See Also:
-
transactionRollback
Description copied from interface:TransactionableRollt die angefangene Transaktion manuell zurueck.- Specified by:
transactionRollbackin interfaceTransactionable- Throws:
RemoteException- im Fehlerfall.- See Also:
-
transactionCommit
Description copied from interface:TransactionableBeendet eine manuell gestartete Transaktion. Wenn vorher keintransactionBegin()aufgerufen wurde, wird dieser Aufruf ignoriert.- Specified by:
transactionCommitin interfaceTransactionable- Throws:
RemoteException- im Fehlerfall.- See Also:
-
getList
Description copied from interface:DBObjectLiefert eine Liste aller Objekte des aktuellen Types.- Specified by:
getListin interfaceDBObject- Returns:
- Liste mit allen Objekten dieser Tabelle.
- Throws:
RemoteException- See Also:
-
overwrite
Description copied from interface:ChangeableUeberschreibt dieses Objekt mit den Attributen des uebergebenen. Dabei werden nur die Werte der Attribute ueberschrieben - nichts anderes. Also auch keine Meta-Daten oder aehnliches. Handelt es sich bei der Quelle um ein Objekt fremden Typs, wird nichts ueberschrieben. Hinweis: Es werden nur die Attribute ueberschrieben, es wird jedoch noch nicht gespeichert. Sollen die Aenderungen also dauerhaft uebernommen werden, muss anschliessend noch einstore()aufgerufen werden.- Specified by:
overwritein interfaceChangeable- Parameters:
object- das Objekt, welches als Quelle verwendet werden soll.- Throws:
RemoteException- im Fehlerfall.- See Also:
-
equals
Description copied from interface:DBObjectVergleicht dieses Objekt mit dem uebergebenen. Hinweis: Es wird nicht der Inhalt verglichen sondern nur die ID und der Typ.- Specified by:
equalsin interfaceDBObject- Specified by:
equalsin interfaceGenericObject- Parameters:
other- das zu vergleichende Objekt.- Returns:
- true, wenn sie vom gleichen Typ sind und die selbe ID haben.
- Throws:
RemoteException- See Also:
-
addDeleteListener
Description copied from interface:DBObjectFuegt dem Objekt einen Listener hinzu, der ausgeloest wird, wenn das Objekt gerade geloescht wurde. Hinweis: Das Event wird unmittelbar nach dem Loeschen ausgeloest, jedoch noch bevor die ID auf null gesetzt wurde.- Specified by:
addDeleteListenerin interfaceDBObject- Parameters:
l- der Listener.- Throws:
RemoteException- See Also:
-
addStoreListener
Description copied from interface:DBObjectFuegt dem Objekt einen Listener hinzu, der ausgeloest wird, wenn das Objekt gespeichert wurde. Hinweis: Das Event wird nach dem Speichern ausgeloest.- Specified by:
addStoreListenerin interfaceDBObject- Parameters:
l- der Listener.- Throws:
RemoteException- See Also:
-
removeDeleteListener
Description copied from interface:DBObjectEntfernt den Listener wieder.- Specified by:
removeDeleteListenerin interfaceDBObject- Parameters:
l- der Listener.- Throws:
RemoteException- See Also:
-
removeStoreListener
Description copied from interface:DBObjectEntfernt den Listener wieder.- Specified by:
removeStoreListenerin interfaceDBObject- Parameters:
l- der Listener.- Throws:
RemoteException- See Also:
-