Method Detail

• clear

  void clear()

  Clears the record template, so it can be reused for another record. Obviously not thread-safe, but the DAOCache wasn't designed to be thread-safe.

• setAll

  boolean setAll(T target,
                 boolean checkValuesBeforeSetting)

  Assigns all values of this template to the 'target'. Does not call .save().

  Parameters:

  checkValuesBeforeSetting - if true, then we will call the getters to compare the value with what needs to be saved, before saving. If false, we'll call the setters straight away.

  Returns:

  true if a setter was called.

• getRecordMatcher

  Predicate<T> getRecordMatcher()

  Returns a predicate that can tell whether any record perfectly matches this template. Only fields "used for query" are compared.

• setPrimaryKey

  void setPrimaryKey(Consumer<T> callback)

  Use this method to set the primary key of the record - Those fields will be used in the queries for example. "Primary key" is the logical primary key which uniquely identify a record, not necessarily the technical PK. Return an object which implements all the Active Objects interface. Please cache this object, as calls are costly.

• fieldsToWriteIfNull

  T fieldsToWriteIfNull()

  Use this method to set the fields (other than primary key) that must be written in the DB if the previous value is null.

  Note that booleans cannot be set using this method, because they are always considered to be 'false' if null.

• fieldsToOverride

  T fieldsToOverride()

  Use this method to set the fields which must be written in all cases when calling create() or update().

• setFieldsIfNull

  void setFieldsIfNull(Consumer<T> callback)

  Use this method to set the "write" fields, i.e. once we've found a record with its primary key, all other fields will be written.

  The values will only be written if the field is null, or when using create().

  Note that booleans cannot be set using this method, because they are always considered to be 'false' if null.

  Don't forget to call createOrUpdate() or create() afterwards ;)

• setFieldsOverwrite

  void setFieldsOverwrite(Consumer<T> callback)

  Use this method to set the "write" fields, i.e. once we've found a record with its primary key, all other fields will be written.

  The values will always be overwritten.

  Don't forget to call createOrUpdate() or create() afterwards ;)

• getTableFields

  Map<String,Object> getTableFields()

  Return the list of field names (the column names in Active Objects) and values, in preparation for an AO Query.

• searchFirst

  T searchFirst()

  Convenience method to call DAOCache.searchFirst(com.playsql.utils.activeobjects.cache.RecordTemplate<T>)

• createOrUpdate

  T createOrUpdate()

  Convenience method to call DAOCache.createOrUpdate(com.playsql.utils.activeobjects.cache.RecordTemplate<T>)

• create

  T create()

  Convenience method to call DAOCache.create(com.playsql.utils.activeobjects.cache.RecordTemplate<T>)

  But realistically, if you are using the DAOCache, you rather want to call createOrUpdate().