Generischer OR-Mapper

1. Einleitung

• Verwaltung von Objekten,
• Verwaltung von Beziehungen zwischen Objekten (Komposition und Assoziation) und
• CRUD-Funktionen auf Objekte und Objektstrukturen.

2. Konfiguration des OR-Mappers

2.1. Grundlagen

• {ENVIRONMENT}_{NAMEAFFIX}_objects.ini
• {ENVIRONMENT}_{NAMEAFFIX}_relations.ini

2.2. Konfigurationsbeispiel

DEFAULT_guestbook_objects.ini

DEFAULT_guestbook_relations.ini

/apps/config/modules/myguestbook/sites/mysite

2.3. Aufbau der Objekt- und Beziehungsdefinition

2.3.1. Objektdefinition

[Application]
DisplayName = "VARCHAR(100)"

[User]
DisplayName = "VARCHAR(100)"
FirstName = "VARCHAR(100)"
LastName = "VARCHAR(100)"
EMail = "VARCHAR(100)"
Username = "VARCHAR(100)"
Password = "VARCHAR(100)"

[Group]
DisplayName = "VARCHAR(100)"

[Role]
DisplayName = "VARCHAR(100)"

• VARCHAR({LENGTH})
• TEXT
• DATE

2.3.2. Beziehungsdefinition

[Application2Group]
Type = "COMPOSITION"
SourceObject = "Application"
TargetObject = "Group"

[Group2User]
Type = "ASSOCIATION"
SourceObject = "Group"
TargetObject = "User"

[Role2User]
Type = "ASSOCIATION"
SourceObject = "Role"
TargetObject = "User"

[Application2User]
Type = "COMPOSITION"
SourceObject = "Application"
TargetObject = "User"

[Application2Role]
Type = "COMPOSITION"
SourceObject = "Application"
TargetObject = "Role"

3. Setup der Datenbank

• {ENVIRONMENT}: Umgebungsvariable der Applikation. Diese wird bei der Adressierung von Konfigurationsdateien verwendet und muss auf den Wert gesetzt werden, der auch in der Zielanwendung verwendet wird. Siehe hierzu Kapitel Konfiguration.
  
  
• {CONTEXT}: Context der Applikation. Dieser wird zur Addressierung der Konfigurationsdateien verwendet und muss auf den Wert gesetzt werden, der auch in der Zielanwendung verwendet wird. Siehe hierzu Kapitel Konfiguration.
  
  
• {CONFIG_NAMESPACE}: Namespace, unter dem die Konfigurationsdateien für den OR-Mapper liegen (siehe Kapitel 2.2).
  
  
• {CONFIG_NAME_AFFIX}: Namenszusatz der Konfigurationsdateien (siehe Kapitel 2.1).
  
  
• {CONNECTION_NAME}: Name der Datenbankverbindung, die für das Setup genutzt werden soll.
  
  

CREATE TABLE IF NOT EXISTS `ent_application` (
  `ApplicationID` TINYINT(5) NOT NULL auto_increment,
  `DisplayName` VARCHAR(100) character set utf8 NOT NULL default '',
  `CreationTimestamp` timestamp NOT NULL default CURRENT_TIMESTAMP,
  `ModificationTimestamp` timestamp NOT NULL default '0000-00-00 00:00:00',
  PRIMARY KEY (`ApplicationID`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

CREATE TABLE IF NOT EXISTS `ent_user` (
  `UserID` TINYINT(5) NOT NULL auto_increment,
  `DisplayName` VARCHAR(100) character set utf8 NOT NULL default '',
  `FirstName` VARCHAR(100) character set utf8 NOT NULL default '',
  `LastName` VARCHAR(100) character set utf8 NOT NULL default '',
  `EMail` VARCHAR(100) character set utf8 NOT NULL default '',
  `Username` VARCHAR(100) character set utf8 NOT NULL default '',
  `Password` VARCHAR(100) character set utf8 NOT NULL default '',
  `CreationTimestamp` timestamp NOT NULL default CURRENT_TIMESTAMP,
  `ModificationTimestamp` timestamp NOT NULL default '0000-00-00 00:00:00',
  PRIMARY KEY (`UserID`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

...

CREATE TABLE IF NOT EXISTS `cmp_application2user` (
  `CMPID` TINYINT(5) NOT NULL auto_increment,
  `ApplicationID` TINYINT(5) NOT NULL default '0',
  `UserID` TINYINT(5) NOT NULL default '0',
  PRIMARY KEY  (`CMPID`),
  KEY `JOININDEX` (`ApplicationID`,`UserID`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

CREATE TABLE IF NOT EXISTS `cmp_application2role` (
  `CMPID` TINYINT(5) NOT NULL auto_increment,
  `ApplicationID` TINYINT(5) NOT NULL default '0',
  `RoleID` TINYINT(5) NOT NULL default '0',
  PRIMARY KEY  (`CMPID`),
  KEY `JOININDEX` (`ApplicationID`,`RoleID`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

4. Verwendung des OR-Mappers

• loadObjectListByCriterion(): Läd eine Liste von Objekten an Hand eines Kriterien-Objekts.
  
  
• loadObjectByCriterion(): Läd ein Objekt an Hand eines Kriterien-Objekts.
  
  
• loadRelatedObjects(): Läd eine Liste von Objekten, die mit diesem über eine definierte Beziehung verknüpft sind.
  
  
• loadNotRelatedObjects(): Läd eine Liste von Objekten, die mit diesem über nicht über eine definierte Beziehung verknüpft sind.
  
  
• saveObject(): Speichert ein Objekt oder einen Objektbaum, der aus in Beziehung stehenden Domain-Objekten besteht.
  
  
• deleteObject(): Löscht ein Objekt. Dabei werden bestehende Assoziationen und Kompositionen aufgelöst.
  
  
• createAssociation(): Erzeugt eine Assoziation zwischen zwei Objekten.
  
  
• deleteAssociation(): Löscht die Assoziation zwischen zwei Objekten.
  
  
• isAssociated(): Prüft, ob eine Assiziation zwischen zwei Objekten besteht.
  
  
• loadObjectListByStatement(): Läd eine Liste von Objekten an Hand eines Statements.
  
  
• loadObjectListByTextStatement(): Läd eine Liste von Objekten an Hand eines übergebenen SQL-Statements.
  
  
• loadObjectListByIDs(): Läd eine Liste von Objekten an Hand eines übergebenen Arrays.
  
  
• loadObjectByStatement(): Läd ein Objekt an Hand eines Statements.
  
  
• loadObjectByTextStatement(): Läd eine Liste von Objekten an Hand eines übergebenen SQL-Statements.
  
  
• loadObjectByID(): Läd ein Objekt an Hand einer übergebenen ID.
  
  

4.1. Erzeugen einer Instanz

• {CONFIG_NAMESPACE}: Namespace, unter dem die Konfigurationsdateien für den OR-Mapper liegen (siehe Kapitel 2.2).
  
  
• {CONFIG_NAME_AFFIX}: Namenszusatz der Konfigurationsdateien (siehe Kapitel 2.1).
  
  
• {CONNECTION_NAME}: Name der Datenbankverbindung, die für das Setup genutzt werden soll.
  
  
• {SERVICE_OBJECT_TYPE}: Art der Instanziierung des Mappers. Gültige Werte sind "SINGLETON" und "SESSIONSINGLETON", Standard ist "SINGLETON".
  
  

4.2. Laden von Daten

4.2.1. Laden von Objekten

• loadObjectByCriterion()
• loadObjectByTextStatement()
• loadObjectByStatement()
• loadObjectByID()

SELECT * FROM ent_user WHERE UserID = '1';

4.2.2. Laden von Objekt-Listen

• loadObjectListByCriterion()
• loadObjectListByTextStatement()
• loadObjectListByStatement()
• loadObjectListByIDs()

SELECT * FROM ent_user WHERE DisplayName LIKE 'a%';

4.2.3. Nachladen von Beziehungsobjektlisten

• loadRelatedObjects()

4.2.4. Nachladen von "Nichtbeziehungsobjekten"

• loadNotRelatedObjects()

4.3. Speichern von Objekten

• saveObject()

4.4. Speichern von Objekt-Bäumen

5. Übersicht zum GenericCriterionObject

• Beziehungen:
  Das Hinzufügen von Beziehungen zum Kriterien-Objekt beschreiben, dass das zu ladende Objekt oder jedes Objekt der zu ladenden Liste in Beziehung zum Objekt des Kriteriums stehen muss. Wird wie im Beispiel eine Beziehung zum Objekt Application (Komposition) und zum Objekt Group (Assoziation) aufgebaut, ist das Ergebnis eine Liste von Objekten innerhalb einer Applikation, die in einer bestimmten Gruppe sind.
  Möchte der Entwickler alle Benutzer selektieren, die in einer Applikation enthalten sind, einer definierten Gruppe angehören und eine bestimmte Rolle zugewiesen haben, müssen drei Beziehungen gemäß der Beziehungskonfiguration zum Kriterium hinzugefügt werden.
  
  
• Sortierreihenfolge:
  Die Reihenfolge der Aufrufe entscheidet die Sortierung. Soll die Sortierung in einer anderen Reihenfolge vorgenommen werden, müssen die Sortierkriterien in der entsprechend anderen Abfolge hinzugefügt werden. Der Wert ASC steht für aufsteigende Sortierung, DESC für absteigende.
  
  

6. Erweiterung des Mapping- und Relation-Table

• addMappingConfiguration()
• addRelationConfiguration()

[Project]
DisplayName = "VARCHAR(100)"
Description = "TEXT"

[News]
DisplayName = "VARCHAR(100)"
Title = "VARCHAR(100)"
Content = "TEXT"

[Application2Project]
Type = "COMPOSITION"
SourceObject = "Application"
TargetObject = "Project"

[Project2News]
Type = "COMPOSITION"
SourceObject = "Project"
TargetObject = "News"

7. Anmerkungen

Kommentare