com.avaje.ebean

Class Model

java.lang.Object

com.avaje.ebean.Model

public abstract class Model
extends Object

A MappedSuperclass base class that provides convenience methods for inserting, updating and deleting beans.

By having your entity beans extend this it provides a 'Active Record' style programming model for Ebean users.

Note that there is a avaje-ebeanorm-mocker project that enables you to use Mockito or similar tools to still mock out the underlying 'default EbeanServer' for testing purposes.

You may choose not use this Model mapped superclass if you don't like the 'Active Record' style or if you believe it 'pollutes' your entity beans.

You can use Dependency Injection like Guice or Spring to construct and wire a EbeanServer instance and have that same instance used with this Model and Finder. The way that works is that when the DI container creates the EbeanServer instance it can be registered with the Ebean singleton. In this way the EbeanServer instance can be injected as per normal Guice / Spring dependency injection and that same instance also used to support the Model and Finder active record style.

If you choose to use the Model mapped superclass you will probably also chose to additionally add a Model.Find as a public static field to complete the active record pattern and provide a relatively nice clean way to write queries.

Typical common @MappedSuperclass

    // Typically there is a common base model that has some
    // common properties like the ones below

    @MappedSuperclass
    public class BaseModel extends Model {

      @Id Long id;

      @Version Long version;

      @CreatedTimestamp Timestamp whenCreated;

      @UpdatedTimestamp Timestamp whenUpdated;

      ...

Extend the Model

    // Extend the mappedSuperclass

    @Entity @Table(name="oto_account")
    public class Customer extends BaseModel {

      // Add a static Find
      // ... with Long being the type of our @Id property.
      // ... Note the {} at the end as Find is an abstract class.

      public static final Find<Long,Account> find = new Find<Long,Account>(){};

      String name;
      ...
    }

Modal: save()

    // Active record style ... save(), delete() etc
    Customer customer = new Customer();
    customer.setName("AC234");

    // save() method inherited from Model
    customer.save();

Find byId

    // find byId
    Customer customer = Customer.find.byId(42);

Find where

    // find where ...
    List<Customer> customers =
        Customer.find
        .where().gt("startDate", lastMonth)
        .findList();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Model.Find<I,T> Helper object for performing queries.
static class	Model.Finder<I,T> A concrete implementation of Find.

Constructor Summary

Constructors

Constructor and Description
Model()

Method Summary

Modifier and Type	Method and Description
static EbeanServer	db() Return the underlying 'default' EbeanServer.
static EbeanServer	db(String server) Return a named EbeanServer that is typically different to the default server.
void	delete() Delete this entity.
void	delete(String server) Perform a delete using this entity against the specified server.
void	insert() Insert this entity.
void	insert(String server) Perform an insert using this entity against the specified server.
void	markAsDirty() Marks the entity bean as dirty.
void	markPropertyUnset(String propertyName) Mark the property as unset or 'not loaded'.
void	refresh() Refreshes this entity from the database.
void	save() Insert or update this entity depending on its state.
void	update() Update this entity.
void	update(String server) Perform an update using this entity against the specified server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Model

public Model()

Method Detail

db

public static EbeanServer db()

Return the underlying 'default' EbeanServer.

This provides full access to the API such as explicit transaction demarcation etc.

Example:

Transaction transaction = Customer.db().beginTransaction();
try {

  // turn off cascade persist for this transaction
  transaction.setPersistCascade(false);

  // extra control over jdbc batching for this transaction
  transaction.setBatchGetGeneratedKeys(false);
  transaction.setBatchMode(true);
  transaction.setBatchSize(20);

  Customer customer = new Customer();
  customer.setName("Roberto");
  customer.save();

  Customer otherCustomer = new Customer();
  otherCustomer.setName("Franko");
  otherCustomer.save();

  transaction.commit();

} finally {
  transaction.end();
}

db

public static EbeanServer db(String server)

Return a named EbeanServer that is typically different to the default server.

If you are using multiple databases then each database has a name and maps to a single EbeanServer. You can use this method to get an EbeanServer for another database.

Parameters:

server - The name of the EbeanServer. If this is null then the default EbeanServer is returned.

markAsDirty

public void markAsDirty()

Marks the entity bean as dirty.

This is used so that when a bean that is otherwise unmodified is updated the version property is updated.

An unmodified bean that is saved or updated is normally skipped and this marks the bean as dirty so that it is not skipped.

Customer customer = Customer.find.byId(id);

// mark the bean as dirty so that a save() or update() will
// increment the version property
customer.markAsDirty();
customer.save();

See Also:

EbeanServer.markAsDirty(Object)

markPropertyUnset

public void markPropertyUnset(String propertyName)

Mark the property as unset or 'not loaded'.

This would be used to specify a property that we did not wish to include in a stateless update.

  // populate an entity bean from JSON or whatever
  User user = ...;

  // mark the email property as 'unset' so that it is not
  // included in a 'stateless update'
  user.markPropertyUnset("email");

  user.update();

Parameters:

propertyName - the name of the property on the bean to be marked as 'unset'

save

public void save()

Insert or update this entity depending on its state.

Ebean will detect if this is a new bean or a previously fetched bean and perform either an insert or an update based on that.

See Also:

EbeanServer.save(Object)

update

public void update()

Update this entity.

See Also:

EbeanServer.update(Object)

insert

public void insert()

Insert this entity.

See Also:

EbeanServer.insert(Object)

delete

public void delete()

Delete this entity.

See Also:

EbeanServer.delete(Object)

update

public void update(String server)

Perform an update using this entity against the specified server.

insert

public void insert(String server)

Perform an insert using this entity against the specified server.

delete

public void delete(String server)

Perform a delete using this entity against the specified server.

refresh

public void refresh()

Refreshes this entity from the database.

See Also:

EbeanServer.refresh(Object)