net.sf.mardao.core.dao

Class DaoImpl<T,ID extends Serializable,P extends Serializable,CT,E,C extends Serializable>

java.lang.Object

net.sf.mardao.core.dao.DaoImpl<T,ID,P,CT,E,C>

Type Parameters:

T - domain object type

ID - domain object simple key type

P - domain object parent key type

CT - cursor type

E - database core entity type

C - database core key type

All Implemented Interfaces:

CsvConverter<T>, Dao<T,ID>

public abstract class DaoImpl<T,ID extends Serializable,P extends Serializable,CT,E,C extends Serializable>
extends Object
implements Dao<T,ID>, CsvConverter<T>

This is the base class for all implementations of the Dao Bean.

Author:

os

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUDIT_CURSOR_PREFIX
static String	COLUMN_NAME_GEOBOXES_DEFAULT Default name of the geoboxes column is "geoboxes"
protected static HashMap<String,DaoImpl>	DAO_MAP
protected DaoImpl	mardaoParentDao
protected boolean	memCacheAll Set this to true in DaoBean constructor, to enable the all-domains memCache
protected boolean	memCacheEntities Set this to true in DaoBean constructor, to enable the primaryKey-to-domain memCache
protected Class<T>	persistentClass mostly for logging
protected boolean	populateTotalSize Set this to false in DaoBean constructor, to disable the count() query for first page (cursorKey is null).
static String	PRINCIPAL_NAME_ANONYMOUS
protected static Runnable	RUNNABLE_VOID
protected Class<ID>	simpleIdClass To help converting keys

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DaoImpl(Class<T> domainType, Class<ID> simpleIdType)

Method Summary

Modifier and Type	Method and Description
void	_setCreatedBy(T domain, String creator) Default implementation is void, override for your creator field
void	_setCreatedDate(T domain, Date date) Default implementation is void, override for your creator field
void	_setUpdatedBy(T domain, String updator) Default implementation is void, override for your updator field
void	_setUpdatedDate(T domain, Date date) Default implementation is void, override for your updated field
protected Object	copyCorePropertyToDomain(String name, E core, T domain)
protected Object	copyDomainPropertyToCore(String name, T domain, E core)
Collection<ID>	coreKeysToSimpleKeys(Iterable<C> cores)
protected abstract P	coreKeyToParentKey(C core) Implemented in TypeDaoImpl
protected abstract ID	coreKeyToSimpleKey(C core) Implemented in TypeDaoImpl
Collection<ID>	coresToSimpleKeys(Iterable<E> cores)
T	coreToDomain(E core)
protected abstract P	coreToParentKey(E core) Implemented in TypeDaoImpl
protected abstract ID	coreToSimpleKey(E core) Implemented in TypeDaoImpl
int	count() Count all entities of this kind
protected abstract int	count(Object ancestorKey, Object simpleKey, Filter... filters)
protected abstract E	createCore(Object primaryKey)
protected abstract E	createCore(Object parentKey, ID simpleKey)
protected abstract C	createCoreKey(Object parentKey, ID simpleKey)
T	createDomain()
T	createDomain(Map<String,String> properties)
T	createDomain(Object primaryKey)
T	createDomain(Object parentKey, ID simpleKey)
protected abstract String	createMemCacheKey(Object parentKey, ID simpleKey)
protected String	createMemCacheKeyAll()
protected Collection<String>	createMemCacheKeys(Object parentKey, Iterable<ID> simpleKeys)
protected void	debug(String format, Object... args)
protected void	debug(String message, Throwable t)
boolean	delete(ID simpleKey)
int	delete(Iterable<T> domains)
boolean	delete(Object parentKey, ID simpleKey)
int	delete(Object parentKey, Iterable<ID> simpleKeys)
boolean	delete(T domain)
protected abstract int	doDelete(Iterable<T> domains) Implement / Override this in TypeDaoImpl.
protected abstract int	doDelete(Object parentKey, Iterable<ID> simpleKeys) Implement / Override this in TypeDaoImpl.
protected abstract T	doFindByPrimaryKey(Object parentKey, ID simpleKeys)
protected abstract Future<?>	doFindByPrimaryKeyForFuture(Object parentKey, ID simpleKeys)
CursorPage<ID>	domainPageToSimplePage(CursorPage<T> domainPage)
Collection<Serializable>	domainsToPrimaryKeys(Iterable<T> domains)
Collection<ID>	domainsToSimpleKeys(Iterable<T> domains)
E	domainToCore(T domain, Date currentDate)
protected abstract Future<?>	doPersistCoreForFuture(E core)
protected abstract Future<List<C>>	doPersistCoreForFuture(Iterable<E> entities)
protected Iterable<E>	doQueryByAncestorKey(C ancestorKey)
protected abstract Iterable<T>	doQueryByPrimaryKeys(Object parentKey, Iterable<ID> simpleKeys)
void	dropTable() For test purposes.
protected void	error(String format, Object... args)
protected void	error(String message, Throwable t)
static String	escapeCsv(Object s)
T	findByPrimaryKey(ID simpleKey)
T	findByPrimaryKey(Object primaryKey)
T	findByPrimaryKey(Object parentKey, ID simpleKey)
Future<?>	findByPrimaryKeyForFuture(ID simpleKey)
Future<?>	findByPrimaryKeyForFuture(Object primaryKey)
Future<?>	findByPrimaryKeyForFuture(Object parentKey, ID simpleKey)
Iterable<T>	findInGeobox(float lat, float lng, int bits, int limit, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Filter... filters)
Collection<T>	findNearest(float lat, float lng, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, int offset, int limit, Filter... filters)
protected abstract T	findUniqueBy(Filter... filters)
protected abstract ID	findUniqueKeyBy(Filter... filters)
protected List<String>	getBasicColumnNames() to list the property names for ManyToOne relations
protected T	getCachedByPrimaryKey(Object parentKey, ID simpleKey)
protected String	getCoreKind(E core)
protected abstract Object	getCoreProperty(E core, String name, Class domainPropertyClass) Implemented in TypeDaoImpl
String	getCreatedBy(T domain) Default implementation returns null, override for your creator field
String	getCreatedByColumnName() Default implementation returns null, override for your creator field
Date	getCreatedDate(T domain) Default implementation returns null, override for your created field
String	getCreatedDateColumnName() Default implementation returns null, override for your created field
Map<String,Object>	getCsvColumnValues(DaoImpl dao, String[] columns, T domain) Convert the specified domain object into column values.
T	getDomain(Future<?> future)
Map<String,Object>	getDomainProperties(Object domainObject)
protected Object	getDomainProperty(T domain, String name) Override in GeneratedDaoImpl
protected String	getGeoboxesColumnName() Override to return your desired column name
DLocation	getGeoLocation(T domain)
String	getGeoLocationColumnName() Override in GeneratedEntityDaoImpl
protected List<String>	getManyToOneColumnNames() to list the property names for ManyToOne relations
protected DaoImpl	getManyToOneDao(String columnName) to map the Daos for ManyToOne relations
protected net.sf.jsr107cache.Cache	getMemCache()
Object	getParentKey(Map<String,String> properties)
String	getParentKeyColumnName() Default implementation returns null, override for your hierarchy
Object	getPrimaryKey(Object parentKey, ID simpleKey)
static String	getPrincipalName()
ID	getSimpleKey(Future<?> future)
ID	getSimpleKey(Map<String,String> properties)
ID	getSimpleKeyByPrimaryKey(Object primaryKey)
Collection<ID>	getSimpleKeys(Future<List<?>> future)
Collection<ID>	getSimpleKeys(Iterable<T> domains)
String	getTableName()
String	getUpdatedBy(T domain) Default implementation returns null, override for your updator field
String	getUpdatedByColumnName() Default implementation returns null, override for your updator field
Date	getUpdatedDate(T domain) Default implementation returns null, override for your updated field
String	getUpdatedDateColumnName() Default implementation returns null, override for your updated field
protected void	info(String format, Object... args)
protected void	info(String message, Throwable t)
static Object	parseProperty(String value, Class clazz)
Collection<ID>	persist(Iterable<T> domains)
ID	persist(T domain)
protected abstract Collection<C>	persistCore(Iterable<E> itrbl) Implemented in TypeDaoImpl
Future<List<?>>	persistForFuture(Iterable<T> domains)
Future<?>	persistForFuture(T domain)
protected void	println(int priority, String format, Object... args) Override this method to do other than System.out.println()
protected void	printStackTrace(int priority, String message, Throwable t) Override this method to do other than System.out.println()
protected String	putCachedByPrimaryKey(Object parentKey, ID simpleKey, T domain)
Iterable<T>	queryAll()
Iterable<T>	queryAll(Object parentKey)
Iterable<ID>	queryAllKeys()
Iterable<ID>	queryAllKeys(Object parentKey)
TreeMap<C,Object>	queryByAncestorKey(Object ancestorKey) Retrieves the full ancestor tree for specified key.
Iterable<T>	queryByPrimaryKeys(Object parentKey, Iterable<ID> simpleKeys)
Iterable<T>	queryChunk(int offset, int limit, Object ancestorKey, Object primaryKey, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Filter... filters)
CursorPage<T>	queryInGeobox(float lat, float lng, int bits, int pageSize, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, String cursorString, Filter... filters)
protected abstract Iterable<T>	queryIterable(boolean keysOnly, int offset, int limit, Object ancestorKey, Object primaryKey, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Filter... filters) Implemented in TypeDaoImpl
protected abstract Iterable<ID>	queryIterableKeys(int offset, int limit, Object ancestorKey, Object primaryKey, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Filter... filters) Implemented in TypeDaoImpl
protected abstract CursorPage<T>	queryPage(boolean keysOnly, int pageSize, Object ancestorKey, Object primaryKey, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Collection<String> projections, String cursorString, Filter... filters) Implemented in TypeDaoImpl
protected CursorPage<T>	queryPage(boolean keysOnly, int pageSize, Object ancestorKey, Object primaryKey, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, String cursorString, Filter... filters)
CursorPage<T>	queryPage(int pageSize, String cursorString)
protected CursorPage<T>	queryPage(int pageSize, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Collection<String> projections, String cursorString)
CursorPage<T>	queryPage(int pageSize, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, String cursorString)
CursorPage<T>	queryPage(Object parentKey, int pageSize, String cursorString)
void	setBoxBits(Collection<Integer> boxBits)
protected abstract void	setCoreProperty(Object core, String name, Object value) Implemented in TypeDaoImpl
protected void	setDomainProperty(T domain, String name, Object value) Override in GeneratedDaoImpl
protected abstract void	setDomainStringProperty(T domain, String name, Map<String,String> properties)
protected void	setMapProperty(Map<String,Object> map, String name, Object value)
void	setMardaoParentDao(DaoImpl mardaoParentDao)
static void	setMemCacheConfig(Map memCacheConfig)
void	setParentKey(T domain, Object parentKey) Default implementation is void, override for your parent field
static void	setPrincipalName(String name)
void	update(Iterable<T> domains) Implemented with a call to persist(domains).
void	update(T domain) Implemented with a call to persist(domains).
protected void	updateGeoModel(T domain, E core) geoboxes are needed to findGeo the nearest entities before sorting them by distance
protected Collection<T>	updateMemCache(boolean remove, Iterable<T> domains)
protected void	updateMemCache(boolean remove, Map<String,T> domains)
protected void	updateMemCache(Collection<String> memCacheKeys)
protected Collection<T>	updateMemCacheAll(Iterable<T> domains)
protected void	warn(String format, Object... args)
protected void	warn(String message, Throwable t)
CursorPage<ID>	whatsChanged(Date since, int pageSize, String cursorKey) Returns IDs for changed (created/updated/deleted) entities.
CursorPage<ID>	whatsChanged(Object parentKey, Date since, int pageSize, String cursorKey, Filter... filters) Returns IDs for changed (created/updated/deleted) entities.
CursorPage<ID>	whatsChanged(Object parentKey, Date since, String byUser, int pageSize, String cursorKey, Filter... filters) Returns IDs for changed (created/updated/deleted) entities.
protected abstract CursorPage<ID>	whatsDeleted(Date since, String byUser, int pageSize, String cursorKey)
void	writeAsCsv(OutputStream out, String[] columns, CsvConverter<T> converter, Iterable<T> qi)
void	writeAsCsv(OutputStream out, String[] columns, CsvConverter<T> converter, Object ancestorKey, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, Filter... filters)
void	writeAsCsv(OutputStream out, String[] columns, Iterable<T> qi)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mardao.core.dao.Dao

beginTransaction, commitTransaction, createEqualsFilter, createGreaterThanOrEqualFilter, createInFilter, deleteAll, getColumnClass, getColumnNames, getKeyString, getParentKey, getParentKeyByPrimaryKey, getPrimaryKey, getPrimaryKey, getPrimaryKeyColumnName, getSimpleKey, rollbackActiveTransaction, setSimpleKey

Field Detail

PRINCIPAL_NAME_ANONYMOUS

public static final String PRINCIPAL_NAME_ANONYMOUS

See Also:

Constant Field Values

COLUMN_NAME_GEOBOXES_DEFAULT

public static final String COLUMN_NAME_GEOBOXES_DEFAULT

Default name of the geoboxes column is "geoboxes"

See Also:

Constant Field Values

AUDIT_CURSOR_PREFIX

protected static final String AUDIT_CURSOR_PREFIX

See Also:

Constant Field Values

persistentClass

protected final Class<T> persistentClass

mostly for logging

simpleIdClass

protected final Class<ID extends Serializable> simpleIdClass

To help converting keys

mardaoParentDao

protected DaoImpl mardaoParentDao

RUNNABLE_VOID

protected static final Runnable RUNNABLE_VOID

DAO_MAP

protected static final HashMap<String,DaoImpl> DAO_MAP

memCacheAll

protected boolean memCacheAll

Set this to true in DaoBean constructor, to enable the all-domains memCache

memCacheEntities

protected boolean memCacheEntities

Set this to true in DaoBean constructor, to enable the primaryKey-to-domain memCache

populateTotalSize

protected boolean populateTotalSize

Set this to false in DaoBean constructor, to disable the count() query for first page (cursorKey is null).

Constructor Detail

DaoImpl

protected DaoImpl(Class<T> domainType,
                  Class<ID> simpleIdType)

Method Detail

getBasicColumnNames

protected List<String> getBasicColumnNames()

to list the property names for ManyToOne relations

getManyToOneColumnNames

protected List<String> getManyToOneColumnNames()

to list the property names for ManyToOne relations

getManyToOneDao

protected DaoImpl getManyToOneDao(String columnName)

to map the Daos for ManyToOne relations

getTableName

public String getTableName()

Specified by:

getTableName in interface Dao<T,ID extends Serializable>

doDelete

protected abstract int doDelete(Object parentKey,
                                Iterable<ID> simpleKeys)

Implement / Override this in TypeDaoImpl. This method does not have to worry about invalidating the cache, that is done in delete(parentKey, simpleKeys)

Parameters:

parentKey -

simpleKeys -

Returns:

number of rows deleted (optional)

doDelete

protected abstract int doDelete(Iterable<T> domains)

Implement / Override this in TypeDaoImpl. This method does not have to worry about invalidating the cache, that is done in delete(domains)

Parameters:

domains -

Returns:

number of rows deleted (optional)

doFindByPrimaryKey

protected abstract T doFindByPrimaryKey(Object parentKey,
                                        ID simpleKeys)

doFindByPrimaryKeyForFuture

protected abstract Future<?> doFindByPrimaryKeyForFuture(Object parentKey,
                                                         ID simpleKeys)

doPersistCoreForFuture

protected abstract Future<List<C>> doPersistCoreForFuture(Iterable<E> entities)

doPersistCoreForFuture

protected abstract Future<?> doPersistCoreForFuture(E core)

doQueryByPrimaryKeys

protected abstract Iterable<T> doQueryByPrimaryKeys(Object parentKey,
                                                    Iterable<ID> simpleKeys)

findUniqueBy

protected abstract T findUniqueBy(Filter... filters)

findUniqueKeyBy

protected abstract ID findUniqueKeyBy(Filter... filters)

persistCore

protected abstract Collection<C> persistCore(Iterable<E> itrbl)

Implemented in TypeDaoImpl

queryPage

protected abstract CursorPage<T> queryPage(boolean keysOnly,
                                           int pageSize,
                                           Object ancestorKey,
                                           Object primaryKey,
                                           String primaryOrderBy,
                                           boolean primaryIsAscending,
                                           String secondaryOrderBy,
                                           boolean secondaryIsAscending,
                                           Collection<String> projections,
                                           String cursorString,
                                           Filter... filters)

Implemented in TypeDaoImpl

queryIterable

protected abstract Iterable<T> queryIterable(boolean keysOnly,
                                             int offset,
                                             int limit,
                                             Object ancestorKey,
                                             Object primaryKey,
                                             String primaryOrderBy,
                                             boolean primaryIsAscending,
                                             String secondaryOrderBy,
                                             boolean secondaryIsAscending,
                                             Filter... filters)

Implemented in TypeDaoImpl

queryIterableKeys

protected abstract Iterable<ID> queryIterableKeys(int offset,
                                                  int limit,
                                                  Object ancestorKey,
                                                  Object primaryKey,
                                                  String primaryOrderBy,
                                                  boolean primaryIsAscending,
                                                  String secondaryOrderBy,
                                                  boolean secondaryIsAscending,
                                                  Filter... filters)

Implemented in TypeDaoImpl

coreToSimpleKey

protected abstract ID coreToSimpleKey(E core)

Implemented in TypeDaoImpl

coreKeyToSimpleKey

protected abstract ID coreKeyToSimpleKey(C core)

Implemented in TypeDaoImpl

coreToParentKey

protected abstract P coreToParentKey(E core)

Implemented in TypeDaoImpl

coreKeyToParentKey

protected abstract P coreKeyToParentKey(C core)

Implemented in TypeDaoImpl

count

protected abstract int count(Object ancestorKey,
                             Object simpleKey,
                             Filter... filters)

createCore

protected abstract E createCore(Object primaryKey)

createCore

protected abstract E createCore(Object parentKey,
                                ID simpleKey)

createCoreKey

protected abstract C createCoreKey(Object parentKey,
                                   ID simpleKey)

createMemCacheKey

protected abstract String createMemCacheKey(Object parentKey,
                                            ID simpleKey)

getCoreProperty

protected abstract Object getCoreProperty(E core,
                                          String name,
                                          Class domainPropertyClass)

Implemented in TypeDaoImpl

setCoreProperty

protected abstract void setCoreProperty(Object core,
                                        String name,
                                        Object value)

Implemented in TypeDaoImpl

setDomainStringProperty

protected abstract void setDomainStringProperty(T domain,
                                                String name,
                                                Map<String,String> properties)

whatsDeleted

protected abstract CursorPage<ID> whatsDeleted(Date since,
                                               String byUser,
                                               int pageSize,
                                               String cursorKey)

println

protected void println(int priority,
                       String format,
                       Object... args)

Override this method to do other than System.out.println()

printStackTrace

protected void printStackTrace(int priority,
                               String message,
                               Throwable t)

Override this method to do other than System.out.println()

debug

protected void debug(String message,
                     Throwable t)

debug

protected void debug(String format,
                     Object... args)

error

protected void error(String message,
                     Throwable t)

error

protected void error(String format,
                     Object... args)

info

protected void info(String message,
                    Throwable t)

info

protected void info(String format,
                    Object... args)

warn

protected void warn(String message,
                    Throwable t)

warn

protected void warn(String format,
                    Object... args)

createDomain

public T createDomain(Map<String,String> properties)

Specified by:

createDomain in interface Dao<T,ID extends Serializable>

coreToDomain

public T coreToDomain(E core)

copyCorePropertyToDomain

protected Object copyCorePropertyToDomain(String name,
                                          E core,
                                          T domain)

copyDomainPropertyToCore

protected Object copyDomainPropertyToCore(String name,
                                          T domain,
                                          E core)

createDomain

public T createDomain()
               throws InstantiationException,
                      IllegalAccessException

Throws:

InstantiationException

IllegalAccessException

createDomain

public T createDomain(Object primaryKey)

Specified by:

createDomain in interface Dao<T,ID extends Serializable>

createDomain

public T createDomain(Object parentKey,
                      ID simpleKey)

Specified by:

createDomain in interface Dao<T,ID extends Serializable>

domainToCore

public E domainToCore(T domain,
                      Date currentDate)

doQueryByAncestorKey

protected Iterable<E> doQueryByAncestorKey(C ancestorKey)

getCoreKind

protected String getCoreKind(E core)

getDomainProperties

public Map<String,Object> getDomainProperties(Object domainObject)

Specified by:

getDomainProperties in interface Dao<T,ID extends Serializable>

domainsToPrimaryKeys

public Collection<Serializable> domainsToPrimaryKeys(Iterable<T> domains)

domainsToSimpleKeys

public Collection<ID> domainsToSimpleKeys(Iterable<T> domains)

domainPageToSimplePage

public CursorPage<ID> domainPageToSimplePage(CursorPage<T> domainPage)

dropTable

public void dropTable()

For test purposes. This implementation does nothing. Override to implement for persistence type.

coresToSimpleKeys

public Collection<ID> coresToSimpleKeys(Iterable<E> cores)

coreKeysToSimpleKeys

public Collection<ID> coreKeysToSimpleKeys(Iterable<C> cores)

getSimpleKeyByPrimaryKey

public ID getSimpleKeyByPrimaryKey(Object primaryKey)

Specified by:

getSimpleKeyByPrimaryKey in interface Dao<T,ID extends Serializable>

createMemCacheKeyAll

protected final String createMemCacheKeyAll()

createMemCacheKeys

protected final Collection<String> createMemCacheKeys(Object parentKey,
                                                      Iterable<ID> simpleKeys)

getDomainProperty

protected Object getDomainProperty(T domain,
                                   String name)

Override in GeneratedDaoImpl

getParentKey

public Object getParentKey(Map<String,String> properties)

Specified by:

getParentKey in interface Dao<T,ID extends Serializable>

getSimpleKey

public ID getSimpleKey(Map<String,String> properties)

Specified by:

getSimpleKey in interface Dao<T,ID extends Serializable>

getSimpleKeys

public Collection<ID> getSimpleKeys(Iterable<T> domains)

Specified by:

getSimpleKeys in interface Dao<T,ID extends Serializable>

getMemCache

protected net.sf.jsr107cache.Cache getMemCache()

updateMemCache

protected final void updateMemCache(Collection<String> memCacheKeys)

updateMemCache

protected final void updateMemCache(boolean remove,
                                    Map<String,T> domains)

updateMemCache

protected final Collection<T> updateMemCache(boolean remove,
                                             Iterable<T> domains)

updateMemCacheAll

protected final Collection<T> updateMemCacheAll(Iterable<T> domains)

getParentKeyColumnName

public String getParentKeyColumnName()

Default implementation returns null, override for your hierarchy

Specified by:

getParentKeyColumnName in interface Dao<T,ID extends Serializable>

getPrincipalName

public static String getPrincipalName()

setParentKey

public void setParentKey(T domain,
                         Object parentKey)

Default implementation is void, override for your parent field

Specified by:

setParentKey in interface Dao<T,ID extends Serializable>

getCreatedBy

public String getCreatedBy(T domain)

Default implementation returns null, override for your creator field

Specified by:

getCreatedBy in interface Dao<T,ID extends Serializable>

getCreatedByColumnName

public String getCreatedByColumnName()

Default implementation returns null, override for your creator field

Specified by:

getCreatedByColumnName in interface Dao<T,ID extends Serializable>

_setCreatedBy

public void _setCreatedBy(T domain,
                          String creator)

Default implementation is void, override for your creator field

Specified by:

_setCreatedBy in interface Dao<T,ID extends Serializable>

getUpdatedBy

public String getUpdatedBy(T domain)

Default implementation returns null, override for your updator field

Specified by:

getUpdatedBy in interface Dao<T,ID extends Serializable>

getUpdatedByColumnName

public String getUpdatedByColumnName()

Default implementation returns null, override for your updator field

Specified by:

getUpdatedByColumnName in interface Dao<T,ID extends Serializable>

_setUpdatedBy

public void _setUpdatedBy(T domain,
                          String updator)

Default implementation is void, override for your updator field

Specified by:

_setUpdatedBy in interface Dao<T,ID extends Serializable>

getCreatedDate

public Date getCreatedDate(T domain)

Default implementation returns null, override for your created field

Specified by:

getCreatedDate in interface Dao<T,ID extends Serializable>

getCreatedDateColumnName

public String getCreatedDateColumnName()

Default implementation returns null, override for your created field

Specified by:

getCreatedDateColumnName in interface Dao<T,ID extends Serializable>

_setCreatedDate

public void _setCreatedDate(T domain,
                            Date date)

Default implementation is void, override for your creator field

Specified by:

_setCreatedDate in interface Dao<T,ID extends Serializable>

getUpdatedDate

public Date getUpdatedDate(T domain)

Default implementation returns null, override for your updated field

Specified by:

getUpdatedDate in interface Dao<T,ID extends Serializable>

getUpdatedDateColumnName

public String getUpdatedDateColumnName()

Default implementation returns null, override for your updated field

Specified by:

getUpdatedDateColumnName in interface Dao<T,ID extends Serializable>

_setUpdatedDate

public void _setUpdatedDate(T domain,
                            Date date)

Default implementation is void, override for your updated field

Specified by:

_setUpdatedDate in interface Dao<T,ID extends Serializable>

getGeoboxesColumnName

protected String getGeoboxesColumnName()

Override to return your desired column name

Returns:

COLUMN_NAME_GEOBOXES_DEFAULT, i.e. "geoboxes"

getGeoLocationColumnName

public String getGeoLocationColumnName()

Override in GeneratedEntityDaoImpl

Specified by:

getGeoLocationColumnName in interface Dao<T,ID extends Serializable>

getGeoLocation

public DLocation getGeoLocation(T domain)

Specified by:

getGeoLocation in interface Dao<T,ID extends Serializable>

updateGeoModel

protected void updateGeoModel(T domain,
                              E core)
                       throws IllegalArgumentException

geoboxes are needed to findGeo the nearest entities before sorting them by distance

Throws:

IllegalArgumentException

count

public int count()

Description copied from interface: Dao

Count all entities of this kind

Specified by:

count in interface Dao<T,ID extends Serializable>

delete

public int delete(Object parentKey,
                  Iterable<ID> simpleKeys)

Specified by:

delete in interface Dao<T,ID extends Serializable>

delete

public int delete(Iterable<T> domains)

delete

public boolean delete(Object parentKey,
                      ID simpleKey)

Specified by:

delete in interface Dao<T,ID extends Serializable>

delete

public boolean delete(ID simpleKey)

Specified by:

delete in interface Dao<T,ID extends Serializable>

delete

public boolean delete(T domain)

Specified by:

delete in interface Dao<T,ID extends Serializable>

findByPrimaryKey

public T findByPrimaryKey(Object parentKey,
                          ID simpleKey)

Specified by:

findByPrimaryKey in interface Dao<T,ID extends Serializable>

findByPrimaryKey

public T findByPrimaryKey(ID simpleKey)

Specified by:

findByPrimaryKey in interface Dao<T,ID extends Serializable>

findByPrimaryKey

public T findByPrimaryKey(Object primaryKey)

Specified by:

findByPrimaryKey in interface Dao<T,ID extends Serializable>

findByPrimaryKeyForFuture

public Future<?> findByPrimaryKeyForFuture(Object parentKey,
                                           ID simpleKey)

Specified by:

findByPrimaryKeyForFuture in interface Dao<T,ID extends Serializable>

findByPrimaryKeyForFuture

public Future<?> findByPrimaryKeyForFuture(ID simpleKey)

Specified by:

findByPrimaryKeyForFuture in interface Dao<T,ID extends Serializable>

findByPrimaryKeyForFuture

public Future<?> findByPrimaryKeyForFuture(Object primaryKey)

Specified by:

findByPrimaryKeyForFuture in interface Dao<T,ID extends Serializable>

getCachedByPrimaryKey

protected T getCachedByPrimaryKey(Object parentKey,
                                  ID simpleKey)

putCachedByPrimaryKey

protected String putCachedByPrimaryKey(Object parentKey,
                                       ID simpleKey,
                                       T domain)

getDomain

public T getDomain(Future<?> future)

Specified by:

getDomain in interface Dao<T,ID extends Serializable>

getSimpleKey

public ID getSimpleKey(Future<?> future)

Specified by:

getSimpleKey in interface Dao<T,ID extends Serializable>

getSimpleKeys

public Collection<ID> getSimpleKeys(Future<List<?>> future)

Specified by:

getSimpleKeys in interface Dao<T,ID extends Serializable>

getPrimaryKey

public Object getPrimaryKey(Object parentKey,
                            ID simpleKey)

Specified by:

getPrimaryKey in interface Dao<T,ID extends Serializable>

persist

public Collection<ID> persist(Iterable<T> domains)

Specified by:

persist in interface Dao<T,ID extends Serializable>

persist

public ID persist(T domain)

Specified by:

persist in interface Dao<T,ID extends Serializable>

persistForFuture

public Future<?> persistForFuture(T domain)

Specified by:

persistForFuture in interface Dao<T,ID extends Serializable>

persistForFuture

public Future<List<?>> persistForFuture(Iterable<T> domains)

Specified by:

persistForFuture in interface Dao<T,ID extends Serializable>

queryAll

public Iterable<T> queryAll()

Specified by:

queryAll in interface Dao<T,ID extends Serializable>

queryAll

public Iterable<T> queryAll(Object parentKey)

Specified by:

queryAll in interface Dao<T,ID extends Serializable>

queryChunk

public Iterable<T> queryChunk(int offset,
                              int limit,
                              Object ancestorKey,
                              Object primaryKey,
                              String primaryOrderBy,
                              boolean primaryIsAscending,
                              String secondaryOrderBy,
                              boolean secondaryIsAscending,
                              Filter... filters)

Specified by:

queryChunk in interface Dao<T,ID extends Serializable>

queryAllKeys

public Iterable<ID> queryAllKeys()

Specified by:

queryAllKeys in interface Dao<T,ID extends Serializable>

queryAllKeys

public Iterable<ID> queryAllKeys(Object parentKey)

Specified by:

queryAllKeys in interface Dao<T,ID extends Serializable>

queryByAncestorKey

public TreeMap<C,Object> queryByAncestorKey(Object ancestorKey)

Retrieves the full ancestor tree for specified key.

Specified by:

queryByAncestorKey in interface Dao<T,ID extends Serializable>

Parameters:

ancestorKey -

Returns:

a map with Core Key as key, Domain object as value.

queryByPrimaryKeys

public Iterable<T> queryByPrimaryKeys(Object parentKey,
                                      Iterable<ID> simpleKeys)

Specified by:

queryByPrimaryKeys in interface Dao<T,ID extends Serializable>

queryPage

public CursorPage<T> queryPage(int pageSize,
                               String cursorString)

Specified by:

queryPage in interface Dao<T,ID extends Serializable>

queryPage

public CursorPage<T> queryPage(Object parentKey,
                               int pageSize,
                               String cursorString)

Specified by:

queryPage in interface Dao<T,ID extends Serializable>

queryPage

public CursorPage<T> queryPage(int pageSize,
                               String primaryOrderBy,
                               boolean primaryIsAscending,
                               String secondaryOrderBy,
                               boolean secondaryIsAscending,
                               String cursorString)

Specified by:

queryPage in interface Dao<T,ID extends Serializable>

queryPage

protected CursorPage<T> queryPage(int pageSize,
                                  String primaryOrderBy,
                                  boolean primaryIsAscending,
                                  String secondaryOrderBy,
                                  boolean secondaryIsAscending,
                                  Collection<String> projections,
                                  String cursorString)

queryPage

protected CursorPage<T> queryPage(boolean keysOnly,
                                  int pageSize,
                                  Object ancestorKey,
                                  Object primaryKey,
                                  String primaryOrderBy,
                                  boolean primaryIsAscending,
                                  String secondaryOrderBy,
                                  boolean secondaryIsAscending,
                                  String cursorString,
                                  Filter... filters)

queryInGeobox

public CursorPage<T> queryInGeobox(float lat,
                                   float lng,
                                   int bits,
                                   int pageSize,
                                   String primaryOrderBy,
                                   boolean primaryIsAscending,
                                   String secondaryOrderBy,
                                   boolean secondaryIsAscending,
                                   String cursorString,
                                   Filter... filters)

Specified by:

queryInGeobox in interface Dao<T,ID extends Serializable>

findInGeobox

public Iterable<T> findInGeobox(float lat,
                                float lng,
                                int bits,
                                int limit,
                                String primaryOrderBy,
                                boolean primaryIsAscending,
                                String secondaryOrderBy,
                                boolean secondaryIsAscending,
                                Filter... filters)

findNearest

public Collection<T> findNearest(float lat,
                                 float lng,
                                 String primaryOrderBy,
                                 boolean primaryIsAscending,
                                 String secondaryOrderBy,
                                 boolean secondaryIsAscending,
                                 int offset,
                                 int limit,
                                 Filter... filters)

Specified by:

findNearest in interface Dao<T,ID extends Serializable>

update

public void update(Iterable<T> domains)

Implemented with a call to persist(domains). Feel free to override.

Specified by:

update in interface Dao<T,ID extends Serializable>

Parameters:

domains -

update

public void update(T domain)

Implemented with a call to persist(domains). Feel free to override.

Specified by:

update in interface Dao<T,ID extends Serializable>

Parameters:

domain -

escapeCsv

public static String escapeCsv(Object s)

getCsvColumnValues

public Map<String,Object> getCsvColumnValues(DaoImpl dao,
                                             String[] columns,
                                             T domain)

Description copied from interface: CsvConverter

Convert the specified domain object into column values.

Specified by:

getCsvColumnValues in interface CsvConverter<T>

Returns:

a Map if to be written, null if to be skipped.

writeAsCsv

public void writeAsCsv(OutputStream out,
                       String[] columns,
                       CsvConverter<T> converter,
                       Object ancestorKey,
                       String primaryOrderBy,
                       boolean primaryIsAscending,
                       String secondaryOrderBy,
                       boolean secondaryIsAscending,
                       Filter... filters)

Specified by:

writeAsCsv in interface Dao<T,ID extends Serializable>

writeAsCsv

public void writeAsCsv(OutputStream out,
                       String[] columns,
                       Iterable<T> qi)

Specified by:

writeAsCsv in interface Dao<T,ID extends Serializable>

writeAsCsv

public void writeAsCsv(OutputStream out,
                       String[] columns,
                       CsvConverter<T> converter,
                       Iterable<T> qi)

Specified by:

writeAsCsv in interface Dao<T,ID extends Serializable>

whatsChanged

public CursorPage<ID> whatsChanged(Date since,
                                   int pageSize,
                                   String cursorKey)

Returns IDs for changed (created/updated/deleted) entities.

Specified by:

whatsChanged in interface Dao<T,ID extends Serializable>

Parameters:

since - return changes with updatedDate newer then this date

pageSize - size of the page to return

cursorKey - an optional cursor

Returns:

a list of ID of changed entities.

whatsChanged

public CursorPage<ID> whatsChanged(Object parentKey,
                                   Date since,
                                   int pageSize,
                                   String cursorKey,
                                   Filter... filters)

Returns IDs for changed (created/updated/deleted) entities.

Specified by:

whatsChanged in interface Dao<T,ID extends Serializable>

Parameters:

since - return changes with updatedDate newer then this date

pageSize - size of the page to return

cursorKey - an optional cursor

filters - additional filters (optional). These filters will only filter the results on create/updated entities, never deleted entities.

Returns:

a list of ID of changed entities.

whatsChanged

public CursorPage<ID> whatsChanged(Object parentKey,
                                   Date since,
                                   String byUser,
                                   int pageSize,
                                   String cursorKey,
                                   Filter... filters)

Returns IDs for changed (created/updated/deleted) entities.

Specified by:

whatsChanged in interface Dao<T,ID extends Serializable>

Parameters:

parentKey - parent key (optional)

since - return changes with updatedDate newer then this date

byUser - return changed with updatedBy equal to this user (optional) If no user is provided, changes for all users are returned (unless filters are used).

pageSize - size of the page to return

cursorKey - an optional cursor

filters - additional filters (optional). These filters will only filter the results on create/updated entities, never deleted entities.

Returns:

a list of ID of changed entities.

setDomainProperty

protected void setDomainProperty(T domain,
                                 String name,
                                 Object value)

Override in GeneratedDaoImpl

setMapProperty

protected void setMapProperty(Map<String,Object> map,
                              String name,
                              Object value)

parseProperty

public static Object parseProperty(String value,
                                   Class clazz)

setMardaoParentDao

public void setMardaoParentDao(DaoImpl mardaoParentDao)

setBoxBits

public void setBoxBits(Collection<Integer> boxBits)

setPrincipalName

public static void setPrincipalName(String name)

setMemCacheConfig

public static void setMemCacheConfig(Map memCacheConfig)