public interface Data extends java.lang.Iterable<Data>
Schnittstelle zum generischen Zugriff auf Attributwerte in beliebig strukturierten Attributgruppen. Zum Erzeugen eines neuen Datensatzes kann die Methode ClientDavInterface.createData(de.bsvrz.dav.daf.main.config.AttributeGroup)
benutzt werden. Nach dem Empfang von Daten kann mit der Methode ResultData.getData()
der im Ergebnis enthaltene Datensatz abgefragt werden.
Modifier and Type | Interface and Description |
---|---|
static interface |
Data.Array
Interface-Klasse für die Array-Ansicht eines Datums.
|
static class |
Data.FormatException
Ausnahme, die ein fehlerhaften Zugriff oder eine nicht zugelassene Konvertierung von Elementen eines Datensatzes signalisiert.
|
static interface |
Data.NumberArray
Interface-Klasse für die Skalierte- und Unskalierte-Array-Ansicht eines Datums.
|
static interface |
Data.NumberValue
Interface-Klasse für die Skalierte- und Unskalierte-Ansicht eines Datums.
|
static interface |
Data.ReferenceArray
Interface-Klasse für die Referenz-Array-Ansicht eines Datums.
|
static interface |
Data.ReferenceValue
Interface-Klasse für die Referenz-Ansicht eines Datums.
|
static interface |
Data.TextArray
Interface-Klasse für die Text-Array-Ansicht eines Datums.
|
static interface |
Data.TextValue
Interface-Klasse für die Text-Ansicht eines Datums.
|
static interface |
Data.TimeArray
Interface-Klasse für die Zeit-Array-Ansicht eines Datums.
|
static interface |
Data.TimeValue
Interface-Klasse für die Zeit-Ansicht eines Datums.
|
Modifier and Type | Method and Description |
---|---|
Data.Array |
asArray()
Liefert eine Array-Ansicht auf dieses Array zurück.
|
Data.ReferenceArray |
asReferenceArray()
Liefert eine Referenz-Array-Ansicht auf dieses Array zurück.
|
Data.ReferenceValue |
asReferenceValue()
Liefert eine Referenz-Ansicht auf dieses einfache Datum zurück.
|
Data.NumberArray |
asScaledArray()
Liefert eine Skalierte-Array-Ansicht auf dieses Array zurück.
|
Data.NumberValue |
asScaledValue()
Liefert eine Skalierte-Ansicht auf dieses einfache Datum zurück.
|
Data.TextArray |
asTextArray()
Liefert eine Text-Array-Ansicht auf dieses Array zurück.
|
Data.TextValue |
asTextValue()
Liefert eine Text-Ansicht auf dieses einfache Datum zurück.
|
Data.TimeArray |
asTimeArray()
Liefert eine Time-Array-Ansicht auf dieses Array zurück.
|
Data.TimeValue |
asTimeValue()
Liefert eine Zeit-Ansicht auf dieses einfache Datum zurück.
|
Data.NumberArray |
asUnscaledArray()
Liefert eine Unskalierte-Array-Ansicht auf dieses Array zurück.
|
Data.NumberValue |
asUnscaledValue()
Liefert eine Unskalierte-Ansicht auf dieses einfache Datum zurück.
|
Data |
createModifiableCopy()
Liefert eine modifizierbare Kopie eines Datensatzes zurück.
|
Data |
createUnmodifiableCopy()
Liefert eine nicht modifizierbare Kopie eines Datensatzes zurück.
|
Data.Array |
getArray(java.lang.String itemName)
Liefert eine Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
AttributeType |
getAttributeType()
Liefert den Attribut-Typ eines Datums zurück.
|
Data |
getItem(java.lang.String itemName)
Bestimmt das Sub-Datum dieser Liste mit dem angegebenen Namen.
|
java.lang.String |
getName()
Liefert den Namen eines Datums zurück.
|
Data.ReferenceArray |
getReferenceArray(java.lang.String itemName)
Liefert eine Referenz-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.ReferenceValue |
getReferenceValue(java.lang.String itemName)
Liefert eine Referenz-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.NumberArray |
getScaledArray(java.lang.String itemName)
Liefert eine Skalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.NumberValue |
getScaledValue(java.lang.String itemName)
Liefert eine Skalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.TextArray |
getTextArray(java.lang.String itemName)
Liefert eine Text-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.TextValue |
getTextValue(java.lang.String itemName)
Liefert eine Text-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.TimeArray |
getTimeArray(java.lang.String itemName)
Liefert eine Time-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.TimeValue |
getTimeValue(java.lang.String itemName)
Liefert eine Zeit-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.NumberArray |
getUnscaledArray(java.lang.String itemName)
Liefert eine Unskalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
Data.NumberValue |
getUnscaledValue(java.lang.String itemName)
Liefert eine Unskalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
|
boolean |
isArray()
Prüft, ob das Datum ein Array ist.
|
boolean |
isDefined()
Prüft, ob das Datum über den Datenverteiler verschickt werden kann.
|
boolean |
isList()
Prüft, ob das Datum eine Liste ist, d.h. aus Sub-Daten besteht.
|
boolean |
isPlain()
Prüft, ob das Datum ein einfaches Datum ohne untergeordnete Sub-Daten ist.
|
java.util.Iterator<Data> |
iterator()
Liefert einen Iterator zurück, der über die Sub-Daten dieser Liste oder die Element-Daten dieses Arrays iteriert.
|
void |
setToDefault()
Setzt bei einem Datum alle Werte auf die definierte Default-Werte.
|
java.lang.String |
toString()
Liefert eine textliche Darstellung des Datums mit Name und Wert.
|
java.lang.String |
valueToString()
Liefert eine textliche Darstellung des Werts eines Datums zurück.
|
Data createModifiableCopy()
Liefert eine modifizierbare Kopie eines Datensatzes zurück. Diese Methode kann verwendet werden, um eine Kopie von einem empfangenen (nicht modifizierbaren) Datensatz zu erstellen und die Kopie mit eventuell veränderten Attributwerten wieder zu versenden. Die Methode funktioniert i.a. nur auf ganzen Datensätzen. Bei Data-Objekten, die nur Teile oder einzelne Attributwerte repräsentieren wird eine IllegalStateException generiert.
IllegalStateException,
- wenn das Data-Objekt keinen ganzen Datensatz enthält.Data createUnmodifiableCopy()
Liefert eine nicht modifizierbare Kopie eines Datensatzes zurück. Die Methode funktioniert i.a. nur auf ganzen Datensätzen. Bei Data-Objekten, die nur Teile oder einzelne Attributwerte repräsentieren wird eine IllegalStateException generiert.
IllegalStateException,
- wenn das Data-Objekt keinen ganzen Datensatz enthält.java.lang.String getName()
Liefert den Namen eines Datums zurück.
java.lang.String valueToString()
Liefert eine textliche Darstellung des Werts eines Datums zurück.
java.lang.String toString()
Liefert eine textliche Darstellung des Datums mit Name und Wert.
toString
in class java.lang.Object
AttributeType getAttributeType()
Liefert den Attribut-Typ eines Datums zurück.
boolean isDefined()
Prüft, ob das Datum über den Datenverteiler verschickt werden kann. Die Methode gibt true
zurück, wenn jedes Attribut einen Wert besitzt, der ungleich dem “undefiniert” Wert ist. Ist das Datum ein Array oder eine Liste, so wird jedes Element geprüft ob es einen gültigen Wert besitzt. Die Prüfung findet auf alle “Sub-Daten” des Datums statt.
void setToDefault()
Setzt bei einem Datum alle Werte auf die definierte Default-Werte. Wurde weder beim Attribut noch beim Attributtyp ein Default-Wert definiert so wird der “undefiniert” Wert gesetzt. Ist das Datum eine Liste oder ein Array, so wird bei jedem Element der Default-Wert gesetzt. Der Vorgang wird solange fortgesetzt, bis alle “Sub-Daten” mit einem Default-Wert/Undefiniert-Wert definiert sind.
isDefined()
boolean isList()
Prüft, ob das Datum eine Liste ist, d.h. aus Sub-Daten besteht.
true
, falls das Datum eine Liste ist, sonst false
.boolean isArray()
Prüft, ob das Datum ein Array ist.
true
, falls das Datum ein Array ist, sonst false
.boolean isPlain()
Prüft, ob das Datum ein einfaches Datum ohne untergeordnete Sub-Daten ist.
true
, falls das Datum eine einfaches Datum ist, sonst false
.Data getItem(java.lang.String itemName)
Bestimmt das Sub-Datum dieser Liste mit dem angegebenen Namen.
itemName
- Name des gewünschten Sub-Datums.Data.TextValue asTextValue()
Liefert eine Text-Ansicht auf dieses einfache Datum zurück.
Data.TextValue getTextValue(java.lang.String itemName)
Liefert eine Text-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.TimeValue asTimeValue()
Liefert eine Zeit-Ansicht auf dieses einfache Datum zurück.
Data.TimeValue getTimeValue(java.lang.String itemName)
Liefert eine Zeit-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.NumberValue asScaledValue()
Liefert eine Skalierte-Ansicht auf dieses einfache Datum zurück.
Data.NumberValue getScaledValue(java.lang.String itemName)
Liefert eine Skalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.NumberValue asUnscaledValue()
Liefert eine Unskalierte-Ansicht auf dieses einfache Datum zurück.
Data.NumberValue getUnscaledValue(java.lang.String itemName)
Liefert eine Unskalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.ReferenceValue asReferenceValue()
Liefert eine Referenz-Ansicht auf dieses einfache Datum zurück.
Data.ReferenceValue getReferenceValue(java.lang.String itemName)
Liefert eine Referenz-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.Array asArray()
Liefert eine Array-Ansicht auf dieses Array zurück.
Data.Array getArray(java.lang.String itemName)
Liefert eine Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.TextArray asTextArray()
Liefert eine Text-Array-Ansicht auf dieses Array zurück.
Data.TextArray getTextArray(java.lang.String itemName)
Liefert eine Text-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.TimeArray asTimeArray()
Liefert eine Time-Array-Ansicht auf dieses Array zurück.
Data.TimeArray getTimeArray(java.lang.String itemName)
Liefert eine Time-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.NumberArray asScaledArray()
Liefert eine Skalierte-Array-Ansicht auf dieses Array zurück.
Data.NumberArray getScaledArray(java.lang.String itemName)
Liefert eine Skalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.NumberArray asUnscaledArray()
Liefert eine Unskalierte-Array-Ansicht auf dieses Array zurück.
Data.NumberArray getUnscaledArray(java.lang.String itemName)
Liefert eine Unskalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.Data.ReferenceArray asReferenceArray()
Liefert eine Referenz-Array-Ansicht auf dieses Array zurück.
Data.ReferenceArray getReferenceArray(java.lang.String itemName)
Liefert eine Referenz-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
itemName
- Name des gewünschten Sub-Datums.java.util.Iterator<Data> iterator()
Liefert einen Iterator zurück, der über die Sub-Daten dieser Liste oder die Element-Daten dieses Arrays iteriert.
iterator
in interface java.lang.Iterable<Data>