|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.bonn.xulu.model.AbstractModelResource
public abstract class AbstractModelResource
Diese Klasse bildet eine abstrakte Basis-Implementierung fuer eine Modell-Ressource.
Die einzigen Methoden, die eine Unterklasse noch implementieren muss, sind
checkAndError(Object)
und checkTypeAndError(Object)
,
ueber die geprueft wird, ob ein Objekt fuer die Ressource zulaessig ist.
Details zur Funktionalitaet und Bestimmung dieser Klasse sind in
ModelResource
zu finden.
Field Summary | |
---|---|
protected int |
category
Speichert die Kategorie der Ressource (Default: ModelResource.CATEGORY_OTHER ) |
protected Object |
data
Speichert das Daten-Objekt der Ressource. |
protected String |
desc
Speichert die Beschreibung der Ressource. |
protected boolean |
nullable
Speichert, ob die Ressource unbelegt bleiben darf |
protected Class |
type
Speichert den Datentyp der Ressource. |
Fields inherited from interface edu.bonn.xulu.model.ModelResource |
---|
CATEGORY_INPUT, CATEGORY_OTHER, CATEGORY_OUTPUT, CATEGORY_TEMP |
Constructor Summary | |
---|---|
AbstractModelResource(int category,
String desc,
Class type,
boolean nullable)
Erzeugt eine leere Ressource. |
|
AbstractModelResource(int category,
String desc,
Object data,
boolean nullable)
Erzeugt Ressource und ordnet ihr ein konretes Datenobjekt zu. |
|
AbstractModelResource(String desc,
Class type,
boolean nullable)
Erzeugt eine leere Ressource. |
|
AbstractModelResource(String desc,
Object data,
boolean nullable)
Erzeugt Ressource und ordnet ihr ein konretes Datenobjekt zu. |
Method Summary | |
---|---|
boolean |
check()
Prueft das der Ressource zugeordnete Objekt auf Typ- und Wert-Konsistenz mit der Ressource. |
boolean |
check(Object data)
Prueft ein beliebiges Objekt auf Typ- und Wert-Konsistenz mit der Ressource. |
void |
checkAndError()
Prueft das der Ressource zugeordnete Objekt auf Typ- und Wert-Konsistenz mit der Ressource. |
abstract void |
checkAndError(Object data)
Prueft ein beliebiges Objekt auf Typ- und Wert-Konsistenz mit der Ressource. |
protected void |
checkCategory(int category)
Prueft, ob die angegebene Kategorie korrekt ist. |
boolean |
checkType(Object data)
Prueft ein beliebiges Objekt nur auf Typ-Vertraeglichkeit mit der Ressource. |
abstract void |
checkTypeAndError(Object data)
Prueft ein beliebiges Objekt nur auf Typ-Vertraeglichkeit mit der Ressource. |
int |
getCategory()
Liefert die Kategorie der Ressource. |
Object |
getData()
Liefert das Daten-Objekt der Ressource. |
String |
getDesc()
Liefert eine Beschreibung, worum es sich bei der Ressource handelt. |
Class |
getType()
Liefert den Datentyp der Ressource. |
boolean |
isCategory(int category)
Prueft, ob die Ressource einer bestimmten Kategorie zugeordnet ist. |
boolean |
isCategoryAll(int category)
Prueft, ob die Ressource einer bestimmten Kategorie-Kombination zugeordnet ist. |
boolean |
isNullable()
Gibt an, ob die Ressource opional ist (also unbelegt bleiben darf). |
void |
setCategory(int category)
Setzt die Kategorie der Ressource. |
void |
setData(Object data)
Ordnet der Ressource ein bestimmtes Datenobjekt zu. |
void |
setData(Object data,
boolean check)
Ordnet der Ressource ein bestimmtes Datenobjekt zu. |
void |
setDesc(String desc)
Setzt eine Beschreibung, worum es sich bei der Ressource handelt. |
void |
setNullable(boolean nullable)
Bestimmt, ob die Ressource opional ist (also unbelegt bleiben darf). |
protected void |
throwDataException(String expected)
Erzeugt und wirft eine XuluDataException mit der Beschreibung
"Resource 'resource_name': expected expected"
Der Ressourcenname wird automatisch ueber this.getDesc()
ermittelt. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Class type
protected Object data
protected String desc
protected boolean nullable
protected int category
ModelResource.CATEGORY_OTHER
)
Constructor Detail |
---|
public AbstractModelResource(int category, String desc, Class type, boolean nullable)
category
- Ordnet die Ressource in eine Kategorie ein (siehe
setCategory(int)
)desc
- Beschreibung der Ressourcetype
- Datentyp der Ressourcenullable
- gibt an, ob die Ressource unbelegt bleiben darf
XuluDataException
- falls der Datentyp null
ist.public AbstractModelResource(int category, String desc, Object data, boolean nullable)
category
- Ordnet die Ressource in eine Kategorie ein (siehe
setCategory(int)
)desc
- Beschreibung der Ressourcedata
- Daten-Objekt fuer die Ressourcenullable
- gibt an, ob die Ressource unbelegt bleiben darf
XuluDataException
- falls das Datenobjekt null
ist,
denn aus null
kann kein Datentyp ermittelt werdenpublic AbstractModelResource(String desc, Class type, boolean nullable)
desc
- Beschreibung der Ressourcetype
- Datentyp der Ressourcenullable
- gibt an, ob die Ressource unbelegt bleiben darf
XuluDataException
- falls der Datentyp null
ist.
IllegalArgumentException
- falls eine unbekannte Kategorie
angegeben wirdpublic AbstractModelResource(String desc, Object data, boolean nullable)
desc
- Beschreibung der Ressourcedata
- Daten-Objekt fuer die Ressourcenullable
- gibt an, ob die Ressource unbelegt bleiben darf
XuluDataException
- falls das Datenobjekt null
ist,
denn aus null
kann kein Datentyp ermittelt werden
IllegalArgumentException
- falls eine unbekannte Kategorie
angegeben wirdMethod Detail |
---|
protected void checkCategory(int category)
IllegalArgumentException
- falls eine unbekannte Kategorie
angegeben wirdpublic boolean isNullable()
isNullable
in interface ModelResource
public void setNullable(boolean nullable)
setNullable
in interface ModelResource
public int getCategory()
ModelResource.CATEGORY_OTHER
sein, oder eine logische
Oder-Verknuepfung der Konstanten ModelResource.CATEGORY_INPUT
,
ModelResource.CATEGORY_OUTPUT
und ModelResource.CATEGORY_TEMP
.
getCategory
in interface ModelResource
public void setCategory(int category)
ModelResource.CATEGORY_OTHER
sein, oder eine logische
Oder-Verknuepfung der Konstanten ModelResource.CATEGORY_INPUT
,
ModelResource.CATEGORY_OUTPUT
und ModelResource.CATEGORY_TEMP
.
setCategory
in interface ModelResource
IllegalArgumentException
- falls eine unbekannte Kategorie
angegeben wirdpublic boolean isCategory(int category)
true
wenn die Ressource einer
der angegebenen Kategorien zugeordnet ist (ODER).
isCategory
in interface ModelResource
category
- Oder-Verknuepfung von Kategorien
this.getCategory() == CATEGORY_OTHER && category == CATEGORY_OTHER ||
(this.getCategory() & category) > 0
public boolean isCategoryAll(int category)
true
wenn die Ressource allen
angegebenen Kategorien zugeordnet ist (UND).
isCategoryAll
in interface ModelResource
this.getCategory() == CATEGORY_OTHER && category == CATEGORY_OTHER ||
(this.getCategory() & category) == category
public boolean checkType(Object data)
checkType
in interface ModelResource
public abstract void checkTypeAndError(Object data) throws XuluDataException
checkTypeAndError
in interface ModelResource
XuluDataException
- falls der Objekt-Typ nicht mit der Ressourcen
vertraeglich istpublic boolean check(Object data)
check
in interface ModelResource
checkAndError(Object)
public abstract void checkAndError(Object data) throws XuluDataException
setData(Object)
aufgerufen.
checkAndError
in interface ModelResource
XuluDataException
- falls der Typ oder der Wert des zugeordneten
Objekts nicht mit der Ressource vertraeglich istpublic boolean check()
check
in interface ModelResource
checkAndError()
public void checkAndError() throws XuluDataException
checkAndError
in interface ModelResource
XuluDataException
- falls der Typ oder der Wert des zugeordneten
Objekts nicht mit der Ressource vertraeglich istcheckAndError(Object)
public Class getType()
getType
in interface ModelResource
public Object getData()
getData
in interface ModelResource
public String getDesc()
getDesc
in interface ModelResource
public void setDesc(String desc)
setDesc
in interface ModelResource
public void setData(Object data, boolean check)
setData
in interface ModelResource
data
- Daten-Objektcheck
- bestimmt, ob das Datenobjekt sofort auf Typ-Vertraeglichkeit
ueberprueft werden sollcheckAndError(Object)
public void setData(Object data) throws XuluDataException
setData
in interface ModelResource
data
- Daten-Objekt
XuluDataException
- falls das nicht mit dem Ressourcen-Typ
vertraeglich istcheckAndError(Object)
protected void throwDataException(String expected)
XuluDataException
mit der Beschreibung
this.getDesc()
ermittelt. Der erwartete Wert/Typ wird als Parameter uebergeben.
expected
- Bezeichnung des erwarteten Typ/Wert
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |