README

Very simple ORM layer, based on the Data Mapper pattern.

Some key design principles:

There are two types of classes: Mapper and Entity
Entities contain data; they have properties, may have formatting methods, validation, etc.
Mapper can read and write Entities from the database
There are two abstract classes AbstractMapper and AbstractMapperId that can be used to create you own Mappers quickly.
You can create any methods for Mapper, but typically we use save, delete, findByID, findByWhere, etc.

These are not rules, but things are very simple when it happens this way:

If you do things differently, existing abstract classes won't help you.

Entities just have some properties
Mappers extend AbstractMapper or AbstractMapperID and override methods mapperTableName, mapperEntityClass
In another override method createFieldMapping you have to describe mapping for all fields
For AbstractMapper subclasses you have to describe unique (key) fields in createFieldMappingUnique. Class AbstractMapperID already does this for id.
Implement a save, delete, find... methods annotated with your specific Entity types. You may use existing untyped* methods of parent classes.

readdle / fqorm