de.bsvrz.dav.daf.main
Interface Data

All Known Implementing Classes:
AbstractData, AbstractData.ArrayData, AbstractData.ListData, AbstractData.PlainData, AbstractData.StructuredData, AttributeBaseValueDataFactory.AttributeArrayAdapter, AttributeBaseValueDataFactory.AttributeArrayAdapter.ArrayItemData, AttributeBaseValueDataFactory.AttributeArrayAdapter.AttributeListArrayAdapter.AttributeListArrayItemData, AttributeBaseValueDataFactory.AttributeArrayAdapter.ByteArrayAdapter.ItemDataView, AttributeBaseValueDataFactory.AttributeArrayAdapter.DoubleArrayAdapter.ItemDataView, AttributeBaseValueDataFactory.AttributeArrayAdapter.FloatArrayAdapter.ItemDataView, AttributeBaseValueDataFactory.AttributeArrayAdapter.IntArrayAdapter.ItemDataView, AttributeBaseValueDataFactory.AttributeArrayAdapter.LongArrayAdapter.ItemDataView, AttributeBaseValueDataFactory.AttributeArrayAdapter.MillisTimeArrayAdapter.TimeArrayItemData, AttributeBaseValueDataFactory.AttributeArrayAdapter.ReferenceArrayAdapter.ReferenceArrayItemData, AttributeBaseValueDataFactory.AttributeArrayAdapter.SecondsTimeArrayAdapter.TimeArrayItemData, AttributeBaseValueDataFactory.AttributeArrayAdapter.ShortArrayAdapter.ItemDataView, AttributeBaseValueDataFactory.AttributeArrayAdapter.TextArrayAdapter.TextArrayItemData, AttributeBaseValueDataFactory.AttributeGroupAdapter, AttributeBaseValueDataFactory.AttributeListValueAdapter, AttributeBaseValueDataFactory.AttributeSetAdapter, AttributeBaseValueDataFactory.AttributeValueAdapter, ByteArrayArrayData, ByteArrayData, ByteArrayListArrayItemData, ByteArrayListData, ByteArrayPrimitiveArrayItemData, ByteArrayPrimitiveData, ByteArrayStructuredData

public interface 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.

Author:
Kappich Systemberatung

Nested Class Summary
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.
 
Method Summary
 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(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(String itemName)
          Bestimmt das Sub-Datum dieser Liste mit dem angegebenen Namen.
 String getName()
          Liefert den Namen eines Datums zurück.
 Data.ReferenceArray getReferenceArray(String itemName)
          Liefert eine Referenz-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.ReferenceValue getReferenceValue(String itemName)
          Liefert eine Referenz-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.NumberArray getScaledArray(String itemName)
          Liefert eine Skalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.NumberValue getScaledValue(String itemName)
          Liefert eine Skalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.TextArray getTextArray(String itemName)
          Liefert eine Text-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.TextValue getTextValue(String itemName)
          Liefert eine Text-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.TimeArray getTimeArray(String itemName)
          Liefert eine Time-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.TimeValue getTimeValue(String itemName)
          Liefert eine Zeit-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.NumberArray getUnscaledArray(String itemName)
          Liefert eine Unskalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.
 Data.NumberValue getUnscaledValue(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.
 boolean isPlain()
          Prüft, ob das Datum ein einfaches Datum ohne untergeordnete Sub-Daten ist.
 Iterator 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.
 String toString()
          Liefert eine textliche Darstellung des Datums mit Name und Wert.
 String valueToString()
          Liefert eine textliche Darstellung des Werts eines Datums zurück.
 

Method Detail

createModifiableCopy

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.

Returns:
Veränderbare Kopie des Datensatzes.
Throws:
IllegalStateException, - wenn das Data-Objekt keinen ganzen Datensatz enthält.

createUnmodifiableCopy

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.

Returns:
Nicht änderbare Kopie des Datensatzes.
Throws:
IllegalStateException, - wenn das Data-Objekt keinen ganzen Datensatz enthält.

getName

String getName()
Liefert den Namen eines Datums zurück.

Returns:
Name des Datums

valueToString

String valueToString()
Liefert eine textliche Darstellung des Werts eines Datums zurück.

Returns:
Wert des Datums

toString

String toString()
Liefert eine textliche Darstellung des Datums mit Name und Wert.

Overrides:
toString in class Object
Returns:
Name und Wert des Datums

getAttributeType

AttributeType getAttributeType()
Liefert den Attribut-Typ eines Datums zurück.

Returns:
Attribut-Typ des Datums

isDefined

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.

Returns:
true = Das Datum enthält gültige Werte und kann über den Datenverteiler verschickt werden; false = Das Datum enthält mindestens ein Attribut, das einen undefinierten Wert besitzt und kann somit nicht über den Datenverteiler verschickt werden

setToDefault

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.

See Also:
isDefined()

isList

boolean isList()
Prüft, ob das Datum eine Liste ist, d.h. aus Sub-Daten besteht.

Returns:
true, falls das Datum eine Liste ist, sonst false.

isArray

boolean isArray()
Prüft, ob das Datum ein Array ist.

Returns:
true, falls das Datum ein Array ist, sonst false.

isPlain

boolean isPlain()
Prüft, ob das Datum ein einfaches Datum ohne untergeordnete Sub-Daten ist.

Returns:
true, falls das Datum eine einfaches Datum ist, sonst false.

getItem

Data getItem(String itemName)
Bestimmt das Sub-Datum dieser Liste mit dem angegebenen Namen.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Gewünschtes Sub-Datum.

asTextValue

Data.TextValue asTextValue()
Liefert eine Text-Ansicht auf dieses einfache Datum zurück.

Returns:
Text-Ansicht des Datums.

getTextValue

Data.TextValue getTextValue(String itemName)
Liefert eine Text-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Text-Ansicht des Sub-Datums.

asTimeValue

Data.TimeValue asTimeValue()
Liefert eine Zeit-Ansicht auf dieses einfache Datum zurück.

Returns:
Zeit-Ansicht des Datums.

getTimeValue

Data.TimeValue getTimeValue(String itemName)
Liefert eine Zeit-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Zeit-Ansicht des Sub-Datums.

asScaledValue

Data.NumberValue asScaledValue()
Liefert eine Skalierte-Ansicht auf dieses einfache Datum zurück.

Returns:
Skalierte-Ansicht des Datums.

getScaledValue

Data.NumberValue getScaledValue(String itemName)
Liefert eine Skalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Skalierte-Ansicht des Sub-Datums.

asUnscaledValue

Data.NumberValue asUnscaledValue()
Liefert eine Unskalierte-Ansicht auf dieses einfache Datum zurück.

Returns:
Unskalierte-Ansicht des Datums.

getUnscaledValue

Data.NumberValue getUnscaledValue(String itemName)
Liefert eine Unskalierte-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Unskalierte-Ansicht des Sub-Datums.

asReferenceValue

Data.ReferenceValue asReferenceValue()
Liefert eine Referenz-Ansicht auf dieses einfache Datum zurück.

Returns:
Referenz-Ansicht des Datums.

getReferenceValue

Data.ReferenceValue getReferenceValue(String itemName)
Liefert eine Referenz-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Referenz-Ansicht des Sub-Datums.

asArray

Data.Array asArray()
Liefert eine Array-Ansicht auf dieses Array zurück.

Returns:
Array-Ansicht des Datums.

getArray

Data.Array getArray(String itemName)
Liefert eine Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Array-Ansicht des Sub-Datums.

asTextArray

Data.TextArray asTextArray()
Liefert eine Text-Array-Ansicht auf dieses Array zurück.

Returns:
Text-Array-Ansicht des Datums.

getTextArray

Data.TextArray getTextArray(String itemName)
Liefert eine Text-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Text-Array-Ansicht des Sub-Datums.

asTimeArray

Data.TimeArray asTimeArray()
Liefert eine Time-Array-Ansicht auf dieses Array zurück.

Returns:
Time-Array-Ansicht des Datums.

getTimeArray

Data.TimeArray getTimeArray(String itemName)
Liefert eine Time-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Time-Array-Ansicht des Sub-Datums.

asScaledArray

Data.NumberArray asScaledArray()
Liefert eine Skalierte-Array-Ansicht auf dieses Array zurück.

Returns:
Skalierte-Array-Ansicht des Datums.

getScaledArray

Data.NumberArray getScaledArray(String itemName)
Liefert eine Skalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Skalierte-Array-Ansicht des Sub-Datums.

asUnscaledArray

Data.NumberArray asUnscaledArray()
Liefert eine Unskalierte-Array-Ansicht auf dieses Array zurück.

Returns:
Unskalierte-Array-Ansicht des Datums.

getUnscaledArray

Data.NumberArray getUnscaledArray(String itemName)
Liefert eine Unskalierte-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Unskalierte-Array-Ansicht des Sub-Datums.

asReferenceArray

Data.ReferenceArray asReferenceArray()
Liefert eine Referenz-Array-Ansicht auf dieses Array zurück.

Returns:
Referenz-Array-Ansicht des Datums.

getReferenceArray

Data.ReferenceArray getReferenceArray(String itemName)
Liefert eine Referenz-Array-Ansicht auf das Sub-Datum dieser Liste mit dem angegebenen Namen zurück.

Parameters:
itemName - Name des gewünschten Sub-Datums.
Returns:
Referenz-Array-Ansicht des Sub-Datums.

iterator

Iterator iterator()
Liefert einen Iterator zurück, der über die Sub-Daten dieser Liste oder die Element-Daten dieses Arrays iteriert.

Returns:
Iterator über die Sub-Daten dieser Liste oder die Element-Daten dieses Arrays.