|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataModel
Schnittstelle zum Zugriff auf Objekte und Eigenschaften eines Datenmodells. Der Zugriff auf die Objekte des Datenmodells wird in der Schnittstelle über
sogenannte Stellvertreterobjekte realisiert. Stellvertreterobjekte sind Objekte im Sinne der eingesetzten Programmiersprache und damit Elemente von Klassen.
System-Objekte und die zugehörigen Stellvertreterobjekte werden im Folgenden synonym verwendet. Die Klassen, die den Zugriff auf die Objekte ermöglichen,
können je nach Typ des jeweiligen Objekts unterschiedlich sein. Alle Objekte des Datenmodells müssen die Schnittstellenklasse für
System-Objekte
implementieren. Der Zugriff auf folgende Typen des Metamodells und des System-Datenmodells wird durch die jeweils angegebenen
Schnittstellenklassen ermöglicht.
Objekt-Typ | Schnittstellenklasse |
---|---|
typ.konfigurationsObjekt | ConfigurationObject |
typ.dynamischesObjekt | DynamicObject |
typ.typ | SystemObjectType ConfigurationObjectType |
typ.attributgruppe | AttributeGroup |
typ.aspekt | Aspect |
typ.attribut | Attribute |
typ.attributTyp | AttributeType |
typ.zeichenketteAttributTyp | StringAttributeType |
typ.ganzzahlAttributTyp | IntegerAttributeType |
typ.werteBereich | IntegerValueRange |
typ.werteZustand | IntegerValueState |
typ.kommazahlAttributTyp | DoubleAttributeType |
typ.zeitstempelAttributTyp | TimeAttributeType |
typ.objektReferenzAttributTyp | ReferenceAttributeType |
typ.attributListenDefinition | AttributeListDefinition |
typ.mengenVerwendung | ObjectSetUse |
typ.mengenTyp | ObjectSetType |
typ.konfigurationsVerantwortlicher | ConfigurationAuthority |
typ.konfigurationsMenge | NonMutableSet |
typ.dynamischeMenge | MutableSet |
typ.applikation | ClientApplication |
typ.datenverteiler | DavApplication |
Method Summary | |
---|---|
ConfigurationObject |
createConfigurationObject(ConfigurationObjectType type,
String pid,
String name,
List sets)
Deprecated. Objekte werden innerhalb eines Bereichs erstellt . |
DynamicObject |
createDynamicObject(SystemObjectType type,
String pid,
String name)
Deprecated. Objekte werden innerhalb eines Bereichs erzeugt . |
short |
getActiveVersion(ConfigurationArea configurationArea)
Gibt die aktive Version des angegebenen Konfigurationsbereichs zurück. |
Aspect |
getAspect(String pid)
Liefert den Aspekt mit der angegebenen PID zurück. |
AttributeGroup |
getAttributeGroup(String pid)
Liefert die Attributgruppe mit der angegebenen PID zurück. |
AttributeGroupUsage |
getAttributeGroupUsage(long usageIdentification)
Bestimmt die Attributgruppenverwendung mit der angegebenen Datenverteiler-Identifizierung. |
AttributeType |
getAttributeType(String pid)
Liefert den Attribut-Typ mit der angegebenen PID zurück. |
List<SystemObjectType> |
getBaseTypes()
Liefert die Basistypen, also die Typ-Objekte, die keinen anderen Typ erweitern, zurück. |
ConfigurationArea |
getConfigurationArea(String pid)
Liefert zu der angegebenen Pid den passenden Konfigurationsbereich. |
ConfigurationAuthority |
getConfigurationAuthority()
Liefert den lokalen Verantwortlichen der gesamten Konfiguration. |
String |
getConfigurationAuthorityPid()
Liefert die Pid des lokalen Verantwortlichen der gesamten Konfiguration. |
Data[] |
getConfigurationData(Collection<SystemObject> objects,
AttributeGroup atg)
Liefert die konfigurierenden Datensätze einer Attributgruppe für mehrere Objekte zurück. |
Data[] |
getConfigurationData(Collection<SystemObject> objects,
AttributeGroup atg,
Aspect asp)
Liefert die konfigurierenden Datensätze einer Attributgruppe und eines Aspekts für mehrere Objekte zurück. |
Data[] |
getConfigurationData(SystemObject[] objects,
AttributeGroup atg)
Liefert die konfigurierenden Datensätze einer Attributgruppe für mehrere Objekte zurück. |
Data[] |
getConfigurationData(SystemObject[] objects,
AttributeGroup atg,
Aspect asp)
Liefert die konfigurierenden Datensätze einer Attributgruppe und eines Aspekts für mehrere Objekte zurück. |
SystemObject |
getObject(long id)
Liefert das System-Objekt mit der angegebenen Objekt-ID zurück. |
SystemObject |
getObject(String pid)
Liefert das System-Objekt mit der angegebenen PID zurück. |
Collection<SystemObject> |
getObjects(Collection<ConfigurationArea> configurationAreas,
Collection<SystemObjectType> systemObjectTypes,
ObjectTimeSpecification objectTimeSpecification)
Gibt die Objekte zurück, die in einem der angegebenen Konfigurationsbereiche sind und deren Objekttyp in der angegebenen Objekttyp-Menge ist. |
Collection<SystemObject> |
getObjects(String pid,
long startTime,
long endTime)
Gibt die Objekte zurück, die zu der angegebenen Pid in dem angegebenen Zeitraum gültig waren. |
ObjectSetType |
getObjectSetType(String pid)
Liefert das Mengen-Typ-Objekt mit der angegebenen PID zurück. |
SystemObjectType |
getType(String pid)
Liefert das Typ-Objekt mit der angegebenen PID zurück. |
SystemObjectType |
getTypeTypeObject()
Liefert das Systemobjekt, das den Typ von Typobjekten darstellt. |
UserAdministration |
getUserAdministration()
Gibt ein Objekt zurück, mit dem die Benutzer der Konfiguration verwaltet werden können. |
Method Detail |
---|
Data[] getConfigurationData(Collection<SystemObject> objects, AttributeGroup atg)
asp.eigenschaften
angenommen.
Die zurückgelieferten Datensätze werden auch lokal zwischengespeichert und können mit der Methode SystemObject.getConfigurationData(de.bsvrz.dav.daf.main.config.AttributeGroup)
ohne weitere
Konfigurationsanfrage abgefragt werden. Die Methode kann somit zur Minimierung der Anzahl von Konfigurationsanfragen und den damit verbundenen
Verzögerungszeiten eingesetzt werden.
objects
- Systemobjekte
der gewünschten konfigurierenden Datensätze.atg
- Attributgruppe der gewünschten Datensätze.
objects
einen
korrespondierender konfigurierender Datensatz oder null
, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe-Aspekt
Kombination hat.Data[] getConfigurationData(Collection<SystemObject> objects, AttributeGroup atg, Aspect asp)
SystemObject.getConfigurationData(de.bsvrz.dav.daf.main.config.AttributeGroup)
ohne weitere Konfigurationsanfrage abgefragt werden. Die
Methode kann somit zur Minimierung der Anzahl von Konfigurationsanfragen und den damit verbundenen Verzögerungszeiten eingesetzt werden.
objects
- Liste der Systemobjekte
der gewünschten konfigurierenden Datensätze.atg
- Attributgruppe der gewünschten Datensätze.asp
- Aspekt der gewünschten Datensätze.
objects
einen
korrespondierender konfigurierender Datensatz oder null
, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe-Aspekt
Kombination hat.Data[] getConfigurationData(SystemObject[] objects, AttributeGroup atg)
asp.eigenschaften
angenommen.
Die zurückgelieferten Datensätze werden auch lokal zwischengespeichert und können mit der Methode SystemObject.getConfigurationData(de.bsvrz.dav.daf.main.config.AttributeGroup)
ohne weitere
Konfigurationsanfrage abgefragt werden. Die Methode kann somit zur Minimierung der Anzahl von Konfigurationsanfragen und den damit verbundenen
Verzögerungszeiten eingesetzt werden.
objects
- Array mit den Systemobjekten
der gewünschten konfigurierenden Datensätze.atg
- Attributgruppe der gewünschten Datensätze.
objects
einen
korrespondierender konfigurierender Datensatz oder null
, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe-Aspekt
Kombination hat.Data[] getConfigurationData(SystemObject[] objects, AttributeGroup atg, Aspect asp)
SystemObject.getConfigurationData(de.bsvrz.dav.daf.main.config.AttributeGroup)
ohne weitere Konfigurationsanfrage abgefragt werden. Die
Methode kann somit zur Minimierung der Anzahl von Konfigurationsanfragen und den damit verbundenen Verzögerungszeiten eingesetzt werden.
objects
- Array mit den Systemobjekten
der gewünschten konfigurierenden Datensätze.atg
- Attributgruppe der gewünschten Datensätze.asp
- Aspekt der gewünschten Datensätze.
objects
einen
korrespondierender konfigurierender Datensatz oder null
, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe-Aspekt
Kombination hat.short getActiveVersion(ConfigurationArea configurationArea)
configurationArea
- der Konfigurationsbereich
SystemObject getObject(String pid)
getObject
in interface ObjectLookup
pid
- Die permanente ID des System-Objekts
null
, wenn es kein Objekt mit der angegebenen PID gibt.DataModel
SystemObject getObject(long id)
getObject
in interface ObjectLookup
id
- Die Objekt-ID des System-Objekts
null
, wenn es kein Objekt mit der angegebenen ID gibt.DataModel
SystemObjectType getTypeTypeObject()
List<SystemObjectType> getBaseTypes()
SystemObjectType getType(String pid)
pid
- Die permanente ID des Typ-Objekts
null
, wenn es kein Objekt mit der angegebenen PID gibt.
IllegalArgumentException
- Wenn das Objekt mit der angegebenen Pid kein Typ-Objekt ist.ObjectSetType getObjectSetType(String pid)
pid
- Die permanente ID des Mengen-Typ-Objekts
null
, wenn es kein Objekt mit der angegebenen PID gibt.
IllegalArgumentException
- Wenn das Objekt mit der angegebenen Pid kein Mengen-Typ-Objekt ist.AttributeGroup getAttributeGroup(String pid)
pid
- Die permanente ID der Attributgruppe
null
, wenn es kein Objekt mit der gewünschten PID gibt.
IllegalArgumentException
- Wenn das Objekt mit der angegebenen Pid keine Attributgruppe ist.AttributeType getAttributeType(String pid)
pid
- Die permanente ID des Attribut-Typs
null
, wenn es kein Objekt mit der angegebenen PID gibt.
IllegalArgumentException
- Wenn das Objekt mit der angegebenen Pid kein Attributtyp ist.Aspect getAspect(String pid)
pid
- Die permanente ID des Aspekts.
null
, wenn es kein Objekt mit der gewünschten PID gibt.
IllegalArgumentException
- Wenn das Objekt mit der angegebenen Pid kein Aspekt ist.AttributeGroupUsage getAttributeGroupUsage(long usageIdentification)
usageIdentification
- Identifizierung dieser Attributgruppenverwendung bei der Kommunikation über den Datenverteiler.
null
, wenn es keine Attributgruppenverwendung mit der angegebenen
Identifizierung gibt.ConfigurationObject createConfigurationObject(ConfigurationObjectType type, String pid, String name, List sets) throws ConfigurationChangeException
erstellt
.
type
- Typ des neuen Objekts.pid
- PID des neuen Objekts.name
- Name des neuen Objekts.sets
- Liste der Mengen des neuen Objekts oder null
, wenn kein Mengen vergeben werden sollen.
ConfigurationChangeException
- Wenn das Objekt nicht erzeugt werden konnte.ConfigurationObject
,
SystemObject.isValid()
DynamicObject createDynamicObject(SystemObjectType type, String pid, String name) throws ConfigurationChangeException
erzeugt
.
type
- Typ des neuen Objektspid
- PID des neuen Objekts.name
- Name des neuen Objekts.
ConfigurationChangeException
- Wenn das Objekt nicht erzeugt werden konnte.SystemObject
,
SystemObject.isValid()
ConfigurationArea getConfigurationArea(String pid)
pid
- die Pid des Konfigurationsbereichs
ConfigurationAuthority getConfigurationAuthority()
String getConfigurationAuthorityPid()
Collection<SystemObject> getObjects(String pid, long startTime, long endTime)
pid
- die Pid der gewünschten ObjektestartTime
- der zu betachtende Startzeitpunkt des AnfragezeitraumsendTime
- der zu betrachtende Endzeitpunkt des Anfragezeitraums
Collection<SystemObject> getObjects(Collection<ConfigurationArea> configurationAreas, Collection<SystemObjectType> systemObjectTypes, ObjectTimeSpecification objectTimeSpecification)
configurationAreas
- Konfigurationsbereiche, die zu berücksichtigen sind. Wird null
übergeben, so gilt dies als Wildcard und alle
Konfigurationsbereiche werden betrachtet.systemObjectTypes
- Objekttypen, die zu berücksichtigen sind. Wird null
übergeben, so gilt dies als Wildcard und alle Objekttypen
werden betrachtet.objectTimeSpecification
- Gibt den Gültigkeitsbereich der geforderten Objekte an.
UserAdministration getUserAdministration()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |