de.bsvrz.puk.config.configFile.fileaccess
Class SystemObjectInformation

java.lang.Object
  extended by de.bsvrz.puk.config.configFile.fileaccess.SystemObjectInformation
All Implemented Interfaces:
SystemObjectInformationInterface
Direct Known Subclasses:
ConfigurationObjectInformation, DynamicObjectInformation

public abstract class SystemObjectInformation
extends Object
implements SystemObjectInformationInterface

Author:
Kappich+Kniß Systemberatung Aachen (K2S), Achim Wullenkord (AW)

Constructor Summary
SystemObjectInformation(long id, String pid, long typeId, String name, ConfigAreaFile configAreaFile, boolean saveModifications)
           
 
Method Summary
 boolean equals(Object o)
           
 ConfigurationAreaFile getConfigurationAreaFile()
          Diese Methode gibt das Objekt zurück, das einen Konfigurationsbereich physisch auf einem Datenträger speichert.
 byte[] getConfigurationData(long attributeGroupUsageId)
          Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist.
 long[] getConfigurationsDataAttributeGroupUsageIds()
          Diese Methode gibt die Attributgruppenverwendungs-Id´s aller konfigurierenden Datensätze zurück, die an diesem Objekt mit SystemObjectInformationInterface.setConfigurationData(long, byte[]) abgelegt wurden.
 long getID()
          Diese Methode gibt die ID des Objekts zurück.
 String getName()
          Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String "" zurückgegeben.
 String getPid()
          Diese Methode gibt die Pid des Objekts zurück.
 Object getReference()
          Gibt ein Objekt zurück, das mit setReference(java.lang.Object) gesetzt wurde.
 long getTypeId()
          Diese Methode gibt den Typ des Objekts als ID zurück.
 int hashCode()
           
 void removeConfigurationData(long attributeGroupUsageId)
          Diese Methode entfernt einen konfigurierenden Datensatz, der mit SystemObjectInformationInterface.setConfigurationData(long, byte[]) hinzugefügt wurde.
 void saveObjectModificationsSystemObject()
          Diese Methode wird aufgerufen, wenn ein Objekt aus der Datei eingeladen wurde und im Konstruktor saveModifications == false übergeben wurde.
 void setConfigurationData(long attributeGroupUsageId, byte[] data)
          Diese Methode speichert einen konfigurierenden Datensatz am Objekt.
 void setName(String newName)
          Diese Methode legt den Namen eines Objekts fest, besitzt das Objekt bereits einen Namen, so wird dieser überschrieben.
 void setReference(Object newReference)
          Setzt ein Objekt, das mit getReference() angefordert werden kann
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SystemObjectInformation

public SystemObjectInformation(long id,
                               String pid,
                               long typeId,
                               String name,
                               ConfigAreaFile configAreaFile,
                               boolean saveModifications)
                        throws IllegalArgumentException
Parameters:
id - Id des Objekts
pid - Pid des Objekts, diese muss ISO-8859-1 konform sein
typeId - Tye des Objekts, der Type wird über die Id identifiziert
name - Name des Objekts, null wird als "" interpretiert
configAreaFile - Objekt, das die Datei verwaltet, in dem dieses Objekt gespeichert ist/wird
saveModifications - true = Das Objekt wird angelegt und in die Datei des Konfigurationsbereichs später gespeichert, werden Änderungen vorgenommen (Datensätze geändert, usw), so werden die Änderungen gespeichert; false = Das Objekt wird angelegt und nicht gespeichert (beim laden des Objekts aus der Datei wäre dies sinnvoll), auch Modifikationen am Objekt werden nicht gespeichert, damit gespeichert wird muss saveObjectModificationsSystemObject() aufgerufen werden
Throws:
IllegalArgumentException - Die Pid ist nicht ISO-8859-1 konform
Method Detail

saveObjectModificationsSystemObject

public void saveObjectModificationsSystemObject()
Diese Methode wird aufgerufen, wenn ein Objekt aus der Datei eingeladen wurde und im Konstruktor saveModifications == false übergeben wurde. Nach Aufruf dieser Methode, werden alle Änderungen wieder gespeichert. Wurde also saveModifications == false gesetzt, so muss diese Methode aufgerufen werden, damit neue Änderungen gespeichert werden.


getID

public long getID()
Description copied from interface: SystemObjectInformationInterface
Diese Methode gibt die ID des Objekts zurück.

Specified by:
getID in interface SystemObjectInformationInterface
Returns:
s.o.

getPid

public String getPid()
Description copied from interface: SystemObjectInformationInterface
Diese Methode gibt die Pid des Objekts zurück.

Specified by:
getPid in interface SystemObjectInformationInterface
Returns:
s.o.

getTypeId

public long getTypeId()
Description copied from interface: SystemObjectInformationInterface
Diese Methode gibt den Typ des Objekts als ID zurück.

Specified by:
getTypeId in interface SystemObjectInformationInterface
Returns:
ID, die den Typ des Objekts wiederspiegelt

getName

public String getName()
Description copied from interface: SystemObjectInformationInterface
Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String "" zurückgegeben.

Specified by:
getName in interface SystemObjectInformationInterface
Returns:
s.o.

setName

public void setName(String newName)
Description copied from interface: SystemObjectInformationInterface
Diese Methode legt den Namen eines Objekts fest, besitzt das Objekt bereits einen Namen, so wird dieser überschrieben.

Specified by:
setName in interface SystemObjectInformationInterface
Parameters:
newName - Neuer Name des Objekts

getConfigurationsDataAttributeGroupUsageIds

public long[] getConfigurationsDataAttributeGroupUsageIds()
Description copied from interface: SystemObjectInformationInterface
Diese Methode gibt die Attributgruppenverwendungs-Id´s aller konfigurierenden Datensätze zurück, die an diesem Objekt mit SystemObjectInformationInterface.setConfigurationData(long, byte[]) abgelegt wurden.

Specified by:
getConfigurationsDataAttributeGroupUsageIds in interface SystemObjectInformationInterface
Returns:
Wenn keine Id´s zur Verfügung stehen, wird ein leeres Array zurückgegeben

getConfigurationData

public byte[] getConfigurationData(long attributeGroupUsageId)
Description copied from interface: SystemObjectInformationInterface
Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist. Der Datensatz wird über die ID seiner Attributgruppenverwendung identifiziert.

Specified by:
getConfigurationData in interface SystemObjectInformationInterface
Parameters:
attributeGroupUsageId - ID der Attributgruppenverwendung des gewünschten konfigurierenden Datensatzes
Returns:
konfigurierender Datensatz, der am Objekt gespeichert ist

setConfigurationData

public void setConfigurationData(long attributeGroupUsageId,
                                 byte[] data)
Description copied from interface: SystemObjectInformationInterface
Diese Methode speichert einen konfigurierenden Datensatz am Objekt. Ist bereits ein Datensatz unter der attributeGroupUsageId gespeichert wird dieser überschrieben.

Specified by:
setConfigurationData in interface SystemObjectInformationInterface
Parameters:
attributeGroupUsageId - ID der Attributgruppenverwendung zu dem der konfigurierende Datensatz gehört
data - serialisierter Datensatz, siehe auch ConfigurationAreaFile.getSerializerVersion(). Das byte-Array kann die Länge 0 habe, das Objekt null ist verboten.

removeConfigurationData

public void removeConfigurationData(long attributeGroupUsageId)
Description copied from interface: SystemObjectInformationInterface
Diese Methode entfernt einen konfigurierenden Datensatz, der mit SystemObjectInformationInterface.setConfigurationData(long, byte[]) hinzugefügt wurde.

Specified by:
removeConfigurationData in interface SystemObjectInformationInterface
Parameters:
attributeGroupUsageId - Id der Attributgruppenverwendung zu dem der konfigurierende Datensatz gehört, der entfernt werden soll

getReference

public Object getReference()
Gibt ein Objekt zurück, das mit setReference(java.lang.Object) gesetzt wurde. Wurde noch kein Objekt gesetzt, wird null zurückgegeben

Returns:
Objektreferenz oder null

setReference

public void setReference(Object newReference)
Setzt ein Objekt, das mit getReference() angefordert werden kann

Parameters:
newReference - s.o.

getConfigurationAreaFile

public ConfigurationAreaFile getConfigurationAreaFile()
Diese Methode gibt das Objekt zurück, das einen Konfigurationsbereich physisch auf einem Datenträger speichert.

Returns:
s.o.

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object