net.sf.mardao.core.dao

Interface Dao<T,ID extends Serializable>

Type Parameters:

T - The domain object type

ID - The domain object's simple key type

All Known Implementing Classes:

DaoImpl

public interface Dao<T,ID extends Serializable>

Author:

os

Method Summary

Modifier and Type	Method and Description
void	_setCreatedBy(T domain, String creator)
void	_setCreatedDate(T domain, Date date)
void	_setUpdatedBy(T domain, String updator)
void	_setUpdatedDate(T domain, Date date)
Object	beginTransaction() Starts a transaction and returns a generic reference
void	commitTransaction(Object transaction) Commits a transaction
int	count() Count all entities of this kind
T	createDomain(Map<String,String> properties)
T	createDomain(Object primaryKey)
T	createDomain(Object parentKey, ID simpleKey)
Filter	createEqualsFilter(String columnName, Object value)
Filter	createGreaterThanOrEqualFilter(String columnName, Object value)
Filter	createInFilter(String fieldName, Collection param)
boolean	delete(ID simpleKey)
boolean	delete(Object parentKey, ID simpleKey)
int	delete(Object parentKey, Iterable<ID> simpleKeys)
boolean	delete(T domain)
int	deleteAll()
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)
Collection<T>	findNearest(float lat, float lng, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, int offset, int limit, Filter... filters)
Class	getColumnClass(String columnName) Returns the class of the domain property for specified column
Collection<String>	getColumnNames()
String	getCreatedBy(T domain)
String	getCreatedByColumnName()
Date	getCreatedDate(T domain)
String	getCreatedDateColumnName()
T	getDomain(Future<?> future)
Map<String,Object>	getDomainProperties(Object domain)
DLocation	getGeoLocation(T domain)
String	getGeoLocationColumnName()
String	getKeyString(Object key)
Object	getParentKey(Map<String,String> properties)
Object	getParentKey(T domain)
Object	getParentKeyByPrimaryKey(Object primaryKey)
String	getParentKeyColumnName()
Object	getPrimaryKey(Object parentKey, ID simpleKey)
Object	getPrimaryKey(String keyString)
Object	getPrimaryKey(T domain)
String	getPrimaryKeyColumnName()
ID	getSimpleKey(Future<?> future)
ID	getSimpleKey(Map<String,String> properties)
ID	getSimpleKey(T domain)
ID	getSimpleKeyByPrimaryKey(Object primaryKey)
Collection<ID>	getSimpleKeys(Future<List<?>> futures)
Collection<ID>	getSimpleKeys(Iterable<T> domains)
String	getTableName()
String	getUpdatedBy(T domain)
String	getUpdatedByColumnName()
Date	getUpdatedDate(T domain)
String	getUpdatedDateColumnName()
Collection<ID>	persist(Iterable<T> domains)
ID	persist(T domain)
Future<List<?>>	persistForFuture(Iterable<T> domains)
Future<?>	persistForFuture(T domain)
Iterable<T>	queryAll()
Iterable<T>	queryAll(Object parentKey)
Iterable<ID>	queryAllKeys()
Iterable<ID>	queryAllKeys(Object parentKey)
TreeMap	queryByAncestorKey(Object ancestorKey)
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)
CursorPage<T>	queryPage(int pageSize, String cursorString)
CursorPage<T>	queryPage(int pageSize, String primaryOrderBy, boolean primaryIsAscending, String secondaryOrderBy, boolean secondaryIsAscending, String cursorString) Deprecated.
CursorPage<T>	queryPage(Object parentKey, int pageSize, String cursorString)
void	rollbackActiveTransaction(Object transaction) Rollbacks a transaction, if active
void	setParentKey(T domain, Object parentKey)
void	setSimpleKey(T domain, ID simpleKey)
void	update(Iterable<T> domains)
void	update(T domain)
CursorPage<ID>	whatsChanged(Date since, int pageSize, String cursorKey)
CursorPage<ID>	whatsChanged(Object parentKey, Date since, int pageSize, String cursorKey, Filter... filters) Deprecated.
CursorPage<ID>	whatsChanged(Object parentKey, Date since, String byUser, int pageSize, String cursorKey, Filter... filters)
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)

Method Detail

createDomain

T createDomain(Map<String,String> properties)

createDomain

T createDomain(Object primaryKey)

createDomain

T createDomain(Object parentKey,
               ID simpleKey)

createEqualsFilter

Filter createEqualsFilter(String columnName,
                          Object value)

createGreaterThanOrEqualFilter

Filter createGreaterThanOrEqualFilter(String columnName,
                                      Object value)

createInFilter

Filter createInFilter(String fieldName,
                      Collection param)

getColumnNames

Collection<String> getColumnNames()

getColumnClass

Class getColumnClass(String columnName)

Returns the class of the domain property for specified column

Parameters:

columnName -

Returns:

the class of the domain property

getDomainProperties

Map<String,Object> getDomainProperties(Object domain)

getDomain

T getDomain(Future<?> future)

getKeyString

String getKeyString(Object key)

getParentKeyColumnName

String getParentKeyColumnName()

getPrimaryKeyColumnName

String getPrimaryKeyColumnName()

getSimpleKey

ID getSimpleKey(Future<?> future)

getSimpleKeys

Collection<ID> getSimpleKeys(Future<List<?>> futures)

getSimpleKey

ID getSimpleKey(T domain)

getSimpleKey

ID getSimpleKey(Map<String,String> properties)

getSimpleKeyByPrimaryKey

ID getSimpleKeyByPrimaryKey(Object primaryKey)

getSimpleKeys

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

getParentKey

Object getParentKey(T domain)

getParentKey

Object getParentKey(Map<String,String> properties)

getParentKeyByPrimaryKey

Object getParentKeyByPrimaryKey(Object primaryKey)

getPrimaryKey

Object getPrimaryKey(String keyString)

getPrimaryKey

Object getPrimaryKey(T domain)

getPrimaryKey

Object getPrimaryKey(Object parentKey,
                     ID simpleKey)

getTableName

String getTableName()

setSimpleKey

void setSimpleKey(T domain,
                  ID simpleKey)

setParentKey

void setParentKey(T domain,
                  Object parentKey)

getCreatedByColumnName

String getCreatedByColumnName()

getCreatedDateColumnName

String getCreatedDateColumnName()

getUpdatedByColumnName

String getUpdatedByColumnName()

getUpdatedDateColumnName

String getUpdatedDateColumnName()

getGeoLocationColumnName

String getGeoLocationColumnName()

getCreatedBy

String getCreatedBy(T domain)

getCreatedDate

Date getCreatedDate(T domain)

getUpdatedBy

String getUpdatedBy(T domain)

getUpdatedDate

Date getUpdatedDate(T domain)

getGeoLocation

DLocation getGeoLocation(T domain)

_setCreatedBy

void _setCreatedBy(T domain,
                   String creator)

_setCreatedDate

void _setCreatedDate(T domain,
                     Date date)

_setUpdatedBy

void _setUpdatedBy(T domain,
                   String updator)

_setUpdatedDate

void _setUpdatedDate(T domain,
                     Date date)

count

int count()

Count all entities of this kind

delete

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

delete

boolean delete(Object parentKey,
               ID simpleKey)

delete

boolean delete(ID simpleKey)

delete

boolean delete(T domain)

deleteAll

int deleteAll()

findByPrimaryKey

T findByPrimaryKey(Object parentKey,
                   ID simpleKey)

findByPrimaryKey

T findByPrimaryKey(ID simpleKey)

findByPrimaryKey

T findByPrimaryKey(Object primaryKey)

findByPrimaryKeyForFuture

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

findByPrimaryKeyForFuture

Future<?> findByPrimaryKeyForFuture(ID simpleKey)

findByPrimaryKeyForFuture

Future<?> findByPrimaryKeyForFuture(Object primaryKey)

persist

ID persist(T domain)

persist

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

persistForFuture

Future<?> persistForFuture(T domain)

persistForFuture

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

queryAll

Iterable<T> queryAll()

queryAll

Iterable<T> queryAll(Object parentKey)

queryAllKeys

Iterable<ID> queryAllKeys()

queryAllKeys

Iterable<ID> queryAllKeys(Object parentKey)

queryByAncestorKey

TreeMap queryByAncestorKey(Object ancestorKey)

queryByPrimaryKeys

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

queryChunk

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

queryPage

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

queryPage

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

queryPage

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

Deprecated.

update

void update(Iterable<T> domains)

update

void update(T domain)

whatsChanged

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

whatsChanged

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

Deprecated.

whatsChanged

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

writeAsCsv

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

writeAsCsv

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

writeAsCsv

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

queryInGeobox

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

findNearest

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

beginTransaction

Object beginTransaction()

Starts a transaction and returns a generic reference

Returns:

a generic reference

Since:

2.3.1

commitTransaction

void commitTransaction(Object transaction)

Commits a transaction

Parameters:

transaction - a generic reference, as returned by beginTransaction

Since:

2.3.1

rollbackActiveTransaction

void rollbackActiveTransaction(Object transaction)

Rollbacks a transaction, if active

Parameters:

transaction - a generic reference, as returned by beginTransaction

Since:

2.3.1