de.bsvrz.pat.sysbed.plugins.api.settings
Class SettingsData

java.lang.Object
  extended by de.bsvrz.pat.sysbed.plugins.api.settings.SettingsData

public class SettingsData
extends Object

Diese Klasse dient dazu, die Einstellungen eines Dialogs zu speichern. Ein Dialog ist Bestandteil eines Moduls. Die zu jedem Modul gehörende Datenidentifikation (Attributgruppe, Aspekt und Objekte), die Klasse des benutzten Moduls und der Name des Moduls werden in einem Objekt dieser Klasse gespeichert. Zusätzlich können die Parameter eines Dialogs als Key/Value-Paare übergeben werden. Der Einstellung kann ein Name zugewiesen werden.

Author:
Kappich Systemberatung

Field Summary
private  Aspect _aspect
          der Aspekt der Datenidentifikation
private  AttributeGroup _attributeGroup
          die Attributgruppe der Datenidentifikation
private  boolean _isValid
          speichert, ob es sich um eine gültige Einstellung handelt, oder nicht
private  List<KeyValueObject> _keyValueList
          speichert die Key/Value-Objekte
private  Class _moduleClass
          die Klasse des Moduls
private  String _moduleName
          Name des Moduls, welche den Dialog darstellt
private  List<SystemObject> _objects
          die Objekte der Datenidentifikation
private  List<SystemObjectType> _objectTypes
          die Objekttypen der Datenidentifikation
private  int _simulationVariant
          speichert die Simulationsvariante der Datenidentifikation
private  String _title
          Name der Einstellung
private  String _treePath
          speichert den Pfad im Baum, der zur Datenidentifikation gehört
 
Constructor Summary
SettingsData()
          Der Standardkonstruktor erstellt ein Objekt der Klasse SettingsData.
SettingsData(List<SystemObjectType> objectTypes, AttributeGroup attributeGroup, Aspect aspect, List<SystemObject> objects)
          Konstruktor.
SettingsData(String moduleName, Class moduleClass, List<SystemObjectType> objectTypes, AttributeGroup attributeGroup, Aspect aspect, List<SystemObject> objects)
          Konstruktor.
 
Method Summary
 void addKeyValueObject(KeyValueObject keyValueObject)
          Fügt ein Key/Value-Paar den Einstellungen hinzu.
 Aspect getAspect()
          Gibt den Aspekt zurück.
 AttributeGroup getAttributeGroup()
          Gibt die Attributgruppe zurück.
 List<KeyValueObject> getKeyValueList()
          Gibt die Key/Value-Paare zurück.
 Class getModuleClass()
          Gibt die Klasse des Moduls zurück.
 String getModuleName()
          Gibt den Namen des Moduls zurück.
 List<SystemObject> getObjects()
          Gibt die Objekte zurück.
 List<SystemObjectType> getObjectTypes()
          Gibt die Objekttypen zurück.
 int getSimulationVariant()
          Gibt die Simulationsvariante der Datenidentifikation zurück.
 String getTitle()
          Gibt den Namen / Titel der Einstellung zurück.
 String getTreePath()
          Gibt den Pfad im Baum zurück, welcher angewählt war, als die Datenidentifikation ausgewählt worden ist.
 boolean isValid()
          Gibt zurück, ob es sich um eine gültige Einstellung handelt, oder nicht.
 void setAspect(Aspect aspect)
          Setzt den Aspekt.
 void setAttributeGroup(AttributeGroup attributeGroup)
          Setzt die Attributgruppe.
 void setKeyValueList(List<KeyValueObject> keyValueList)
          Setzt die Key/Value-Paare.
 void setModuleClass(Class moduleClass)
          Setzt die Klasse des Moduls.
 void setModuleName(String moduleName)
          Setzt den Namen des Moduls.
 void setObjects(List<SystemObject> objects)
          Setzt die Liste der Systemobjekte.
 void setObjectTypes(List<SystemObjectType> objectTypes)
          Setzt die Liste der Objekttypen.
 void setSimulationVariant(int simulationVariant)
          Setzt die Simulationsvariante der Datenidentifikation.
 void setTitle(String title)
          Setzt den Namen / Titel der Einstellung.
 void setTreePath(String treePath)
          Übergibt den Pfad im Baum, welcher angewählt war, als die Datenidentifikation ausgewählt wurde.
 void setValid(boolean valid)
          Setzt die Gültigkeit der Einstellung.
 String toString()
          Gibt eine String-Repräsentation dieses Objekts zurück.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_title

private String _title
Name der Einstellung


_moduleName

private String _moduleName
Name des Moduls, welche den Dialog darstellt


_moduleClass

private Class _moduleClass
die Klasse des Moduls


_attributeGroup

private AttributeGroup _attributeGroup
die Attributgruppe der Datenidentifikation


_aspect

private Aspect _aspect
der Aspekt der Datenidentifikation


_simulationVariant

private int _simulationVariant
speichert die Simulationsvariante der Datenidentifikation


_objects

private List<SystemObject> _objects
die Objekte der Datenidentifikation


_objectTypes

private List<SystemObjectType> _objectTypes
die Objekttypen der Datenidentifikation


_keyValueList

private List<KeyValueObject> _keyValueList
speichert die Key/Value-Objekte


_treePath

private String _treePath
speichert den Pfad im Baum, der zur Datenidentifikation gehört


_isValid

private boolean _isValid
speichert, ob es sich um eine gültige Einstellung handelt, oder nicht

Constructor Detail

SettingsData

public SettingsData()
Der Standardkonstruktor erstellt ein Objekt der Klasse SettingsData.


SettingsData

public SettingsData(List<SystemObjectType> objectTypes,
                    AttributeGroup attributeGroup,
                    Aspect aspect,
                    List<SystemObject> objects)
Konstruktor. Ein Objekt wird angelegt, welches die übergebenen Daten speichert.

Parameters:
objectTypes - die Objekt-Typen
attributeGroup - die Attributgruppe
aspect - der Aspekt
objects - die Systemobjekte

SettingsData

public SettingsData(String moduleName,
                    Class moduleClass,
                    List<SystemObjectType> objectTypes,
                    AttributeGroup attributeGroup,
                    Aspect aspect,
                    List<SystemObject> objects)
Konstruktor. Benötigt wird der Modulname, die Klasse des Moduls und die Datenidentifikation, bestehend aus einer Attributgruppe, einem Aspekt und beliebig vielen Objekten. Ein Objekt wird angelegt, welches die übergebenen Daten speichert.

Parameters:
moduleName - der Name des Moduls
moduleClass - die Klasse des Moduls
objectTypes - die Objekt-Typen
attributeGroup - die Attributgruppe der Datenidentifikation
aspect - der Aspekt der Datenidentifikation
objects - die Objekte der Datenidentifikation
Method Detail

addKeyValueObject

public void addKeyValueObject(KeyValueObject keyValueObject)
Fügt ein Key/Value-Paar den Einstellungen hinzu.

Parameters:
keyValueObject - ein Key/Value-Paar

getAspect

public Aspect getAspect()
Gibt den Aspekt zurück.

Returns:
der Aspekt der Datenidentifikation

getAttributeGroup

public AttributeGroup getAttributeGroup()
Gibt die Attributgruppe zurück.

Returns:
die Attributgruppe der Datenidentifikation

getKeyValueList

public List<KeyValueObject> getKeyValueList()
Gibt die Key/Value-Paare zurück.

Returns:
die Key/Value-Paare

getModuleClass

public Class getModuleClass()
Gibt die Klasse des Moduls zurück.

Returns:
die Klasse des Moduls

getModuleName

public String getModuleName()
Gibt den Namen des Moduls zurück.

Returns:
Name des Moduls

getObjects

public List<SystemObject> getObjects()
Gibt die Objekte zurück.

Returns:
die Objekte der Datenidentifikation

getObjectTypes

public List<SystemObjectType> getObjectTypes()
Gibt die Objekttypen zurück.

Returns:
die Objekttypen

getSimulationVariant

public int getSimulationVariant()
Gibt die Simulationsvariante der Datenidentifikation zurück.

Returns:
die Simulationvariante

getTitle

public String getTitle()
Gibt den Namen / Titel der Einstellung zurück.

Returns:
Name der Einstellung

getTreePath

public String getTreePath()
Gibt den Pfad im Baum zurück, welcher angewählt war, als die Datenidentifikation ausgewählt worden ist.

Returns:
den Pfad im Baum

isValid

public boolean isValid()
Gibt zurück, ob es sich um eine gültige Einstellung handelt, oder nicht.

Returns:
ob die Einstellung gültig ist

setAspect

public void setAspect(Aspect aspect)
Setzt den Aspekt.

Parameters:
aspect - der Aspekt

setAttributeGroup

public void setAttributeGroup(AttributeGroup attributeGroup)
Setzt die Attributgruppe.

Parameters:
attributeGroup - die Attributgruppe

setKeyValueList

public void setKeyValueList(List<KeyValueObject> keyValueList)
Setzt die Key/Value-Paare.

Parameters:
keyValueList - eine Liste mit Key/Value-Paaren

setModuleClass

public void setModuleClass(Class moduleClass)
Setzt die Klasse des Moduls.

Parameters:
moduleClass - die Klasse des Moduls

setModuleName

public void setModuleName(String moduleName)
Setzt den Namen des Moduls.

Parameters:
moduleName - der Modulname

setObjects

public void setObjects(List<SystemObject> objects)
Setzt die Liste der Systemobjekte.

Parameters:
objects - Liste der Systemobjekte

setObjectTypes

public void setObjectTypes(List<SystemObjectType> objectTypes)
Setzt die Liste der Objekttypen.

Parameters:
objectTypes - Liste der Objekttypen

setSimulationVariant

public void setSimulationVariant(int simulationVariant)
Setzt die Simulationsvariante der Datenidentifikation.

Parameters:
simulationVariant - die Simulationsvariante der Datenidentifikation

setTitle

public void setTitle(String title)
Setzt den Namen / Titel der Einstellung.

Parameters:
title - der Name / Titel der Einstellung

setTreePath

public void setTreePath(String treePath)
Übergibt den Pfad im Baum, welcher angewählt war, als die Datenidentifikation ausgewählt wurde.

Parameters:
treePath - der Pfad im Baum

setValid

public void setValid(boolean valid)
Setzt die Gültigkeit der Einstellung. Ist die Einstellung ungültig, dann kann sie auch nicht gestartet werden.

Parameters:
valid - ob die Einstellung gültig ist

toString

public String toString()
Gibt eine String-Repräsentation dieses Objekts zurück.

Overrides:
toString in class Object
Returns:
String-Repräsentation dieses Objekts