ReferenceDocumentDaoBase (Allegro remote 3.0.1-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

fr.ifremer.allegro.referential.taxon
Class ReferenceDocumentDaoBase

java.lang.Object
  org.springframework.orm.hibernate3.support.HibernateDaoSupport
      fr.ifremer.allegro.referential.taxon.ReferenceDocumentDaoBase

All Implemented Interfaces:: ReferenceDocumentDao

Direct Known Subclasses:: ReferenceDocumentDaoImpl

public abstract class ReferenceDocumentDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements ReferenceDocumentDao
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements ReferenceDocumentDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type fr.ifremer.allegro.referential.taxon.ReferenceDocument.

See Also:: ReferenceDocument

Field Summary

Fields inherited from interface fr.ifremer.allegro.referential.taxon.ReferenceDocumentDao
`TRANSFORM_CLUSTERREFERENCEDOCUMENT, TRANSFORM_NONE, TRANSFORM_REMOTEREFERENCEDOCUMENTFULLVO, TRANSFORM_REMOTEREFERENCEDOCUMENTNATURALID`

Constructor Summary
`ReferenceDocumentDaoBase()`

Method Summary
`void`	`clusterReferenceDocumentToEntity(ClusterReferenceDocument source, ReferenceDocument target, boolean copyIfNull)` Copies the fields of `ClusterReferenceDocument` to the specified entity.
`void`	`clusterReferenceDocumentToEntityCollection(java.util.Collection instances)` Converts a Collection of instances of type `ClusterReferenceDocument` to this DAO's entity.
`java.util.Collection`	`create(java.util.Collection entities)` Creates a new instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument and adds from the passed in `entities` collection
`ReferenceDocument`	`create(java.util.Collection authors, java.util.Date creationDate, java.lang.String reference, Status status)` Creates a new `fr.ifremer.allegro.referential.taxon.ReferenceDocument` instance from only required properties (attributes and association ends) and adds it to the persistent store.
`java.util.Collection`	`create(int transform, java.util.Collection entities)` Does the same thing as `ReferenceDocumentDao.create(fr.ifremer.allegro.referential.taxon.ReferenceDocument)` with an additional flag called `transform`.
`java.lang.Object`	`create(int transform, java.util.Collection authors, java.util.Date creationDate, java.lang.String reference, Status status)` Does the same thing as `ReferenceDocumentDao.create(java.util.Collection,java.util.Date,java.lang.String,fr.ifremer.allegro.referential.Status)` with an additional flag called `transform`.
`java.lang.Object`	`create(int transform, ReferenceDocument referenceDocument)` Does the same thing as `ReferenceDocumentDao.create(fr.ifremer.allegro.referential.taxon.ReferenceDocument)` with an additional flag called `transform`.
`java.lang.Object`	`create(int transform, java.lang.String reference, java.util.Date publicationDate, java.lang.String comments, java.util.Date creationDate, java.sql.Timestamp updateDate, java.util.Collection authors, java.util.Collection taxonInformationHistories, Status status)` Does the same thing as `ReferenceDocumentDao.create(java.lang.String,java.util.Date,java.lang.String,java.util.Date,java.sql.Timestamp,java.util.Collection,java.util.Collection,fr.ifremer.allegro.referential.Status)` with an additional flag called `transform`.
`ReferenceDocument`	`create(ReferenceDocument referenceDocument)` Creates an instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument and adds it to the persistent store.
`ReferenceDocument`	`create(java.lang.String reference, java.util.Date publicationDate, java.lang.String comments, java.util.Date creationDate, java.sql.Timestamp updateDate, java.util.Collection authors, java.util.Collection taxonInformationHistories, Status status)` Creates a new `fr.ifremer.allegro.referential.taxon.ReferenceDocument` instance from all attributes and properties and adds it to the persistent store.
`ReferenceDocument`	`createFromClusterReferenceDocument(ClusterReferenceDocument clusterReferenceDocument)`
`ReferenceDocument`	`findReferenceDocumentById(java.lang.Integer id)`
`java.lang.Object`	`findReferenceDocumentById(int transform, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentById(java.lang.Integer)` with an additional flag called `transform`.
`java.lang.Object`	`findReferenceDocumentById(int transform, java.lang.String queryString, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentById(int, java.lang.Integer)` with an additional argument called `queryString`.
`ReferenceDocument`	`findReferenceDocumentById(java.lang.String queryString, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentById(java.lang.Integer)` with an additional argument called `queryString`.
`ReferenceDocument`	`findReferenceDocumentByNaturalId(java.lang.Integer id)`
`java.lang.Object`	`findReferenceDocumentByNaturalId(int transform, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByNaturalId(java.lang.Integer)` with an additional flag called `transform`.
`java.lang.Object`	`findReferenceDocumentByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByNaturalId(int, java.lang.Integer)` with an additional argument called `queryString`.
`ReferenceDocument`	`findReferenceDocumentByNaturalId(java.lang.String queryString, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByNaturalId(java.lang.Integer)` with an additional argument called `queryString`.
`java.util.Collection`	`findReferenceDocumentByStatus(int transform, int pageNumber, int pageSize, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(int, fr.ifremer.allegro.referential.Status)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`findReferenceDocumentByStatus(int pageNumber, int pageSize, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(fr.ifremer.allegro.referential.Status)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`findReferenceDocumentByStatus(int transform, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(fr.ifremer.allegro.referential.Status)` with an additional flag called `transform`.
`java.util.Collection`	`findReferenceDocumentByStatus(int transform, java.lang.String queryString, int pageNumber, int pageSize, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(int, String, fr.ifremer.allegro.referential.Status)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`findReferenceDocumentByStatus(int transform, java.lang.String queryString, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(int, fr.ifremer.allegro.referential.Status)` with an additional argument called `queryString`.
`java.util.Collection`	`findReferenceDocumentByStatus(Status status)`
`java.util.Collection`	`findReferenceDocumentByStatus(java.lang.String queryString, int pageNumber, int pageSize, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(String, fr.ifremer.allegro.referential.Status)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`findReferenceDocumentByStatus(java.lang.String queryString, Status status)` Does the same thing as `ReferenceDocumentDao.findReferenceDocumentByStatus(fr.ifremer.allegro.referential.Status)` with an additional argument called `queryString`.
`ClusterReferenceDocument[]`	`getAllClusterReferenceDocumentSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp, java.lang.Integer userId, java.lang.Integer[] registrationLocationIds, java.lang.Integer pageNumber, java.lang.Integer pageSize)`
`java.util.Collection`	`getAllReferenceDocument()`
`java.util.Collection`	`getAllReferenceDocument(int transform)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument()` with an additional flag called `transform`.
`java.util.Collection`	`getAllReferenceDocument(int pageNumber, int pageSize)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument()` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocument(int transform, int pageNumber, int pageSize)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument(int)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocument(int transform, java.lang.String queryString)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument(int)` with an additional argument called `queryString`.
`java.util.Collection`	`getAllReferenceDocument(int transform, java.lang.String queryString, int pageNumber, int pageSize)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument(int, String)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocument(java.lang.String queryString)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument()` with an additional argument called `queryString`.
`java.util.Collection`	`getAllReferenceDocument(java.lang.String queryString, int pageNumber, int pageSize)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocument(String)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(int transform, int pageNumber, int pageSize, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(int, java.sql.Timestamp)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(int pageNumber, int pageSize, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(int, String, java.sql.Timestamp)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(int transform, java.lang.String queryString, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(int, java.sql.Timestamp)` with an additional argument called `queryString`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(int transform, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp)` with an additional flag called `transform`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(String, java.sql.Timestamp)` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(java.lang.String queryString, java.sql.Timestamp updateDate)` Does the same thing as `ReferenceDocumentDao.getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp)` with an additional argument called `queryString`.
`java.util.Collection`	`getAllReferenceDocumentSinceDateSynchro(java.sql.Timestamp updateDate)`
`protected AuthorDao`	`getAuthorDao()` Gets the reference to `authorDao`.
`protected java.security.Principal`	`getPrincipal()` Gets the current `principal` if one has been set, otherwise returns `null`.
`protected StatusDao`	`getStatusDao()` Gets the reference to `statusDao`.
`protected TaxonInformationHistoryDao`	`getTaxonInformationHistoryDao()` Gets the reference to `taxonInformationHistoryDao`.
`protected abstract ReferenceDocument`	`handleCreateFromClusterReferenceDocument(ClusterReferenceDocument clusterReferenceDocument)` Performs the core logic for `createFromClusterReferenceDocument(fr.ifremer.allegro.referential.taxon.generic.cluster.ClusterReferenceDocument)`
`protected abstract ClusterReferenceDocument[]`	`handleGetAllClusterReferenceDocumentSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp, java.lang.Integer userId, java.lang.Integer[] registrationLocationIds, java.lang.Integer pageNumber, java.lang.Integer pageSize)` Performs the core logic for `getAllClusterReferenceDocumentSinceDateSynchro(java.sql.Timestamp, java.lang.Integer, java.lang.Integer[], java.lang.Integer, java.lang.Integer)`
`ReferenceDocument`	`load(java.lang.Integer id)` Loads an instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument from the persistent store.
`java.lang.Object`	`load(int transform, java.lang.Integer id)` Does the same thing as `ReferenceDocumentDao.load(java.lang.Integer)` with an additional flag called `transform`.
`java.util.Collection`	`loadAll()` Loads all entities of type `ReferenceDocument`.
`java.util.Collection`	`loadAll(int transform)` Does the same thing as `ReferenceDocumentDao.loadAll()` with an additional flag called `transform`.
`java.util.Collection`	`loadAll(int pageNumber, int pageSize)` Does the same thing as `ReferenceDocumentDao.loadAll()` with an additional two arguments called `pageNumber` and `pageSize`.
`java.util.Collection`	`loadAll(int transform, int pageNumber, int pageSize)` Does the same thing as `ReferenceDocumentDao.loadAll(int)` with an additional two arguments called `pageNumber` and `pageSize`.
`void`	`remoteReferenceDocumentFullVOToEntity(RemoteReferenceDocumentFullVO source, ReferenceDocument target, boolean copyIfNull)` Copies the fields of `RemoteReferenceDocumentFullVO` to the specified entity.
`void`	`remoteReferenceDocumentFullVOToEntityCollection(java.util.Collection instances)` Converts a Collection of instances of type `RemoteReferenceDocumentFullVO` to this DAO's entity.
`void`	`remoteReferenceDocumentNaturalIdToEntity(RemoteReferenceDocumentNaturalId source, ReferenceDocument target, boolean copyIfNull)` Copies the fields of `RemoteReferenceDocumentNaturalId` to the specified entity.
`void`	`remoteReferenceDocumentNaturalIdToEntityCollection(java.util.Collection instances)` Converts a Collection of instances of type `RemoteReferenceDocumentNaturalId` to this DAO's entity.
`void`	`remove(java.util.Collection entities)` Removes all entities in the given `entities collection.`
`void`	`remove(java.lang.Integer id)` Removes the instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument having the given `identifier` from the persistent store.
`void`	`remove(ReferenceDocument referenceDocument)` Removes the instance of fr.ifremer.allegro.referential.taxon.ReferenceDocument from the persistent store.
`PaginationResult`	`search(int transform, int pageNumber, int pageSize, Search search)` Does the same thing as {@link #search(int, fr.ifremer.allegro.Search) but with an additional two flags called `pageNumber` and `pageSize`.
`PaginationResult`	`search(int pageNumber, int pageSize, Search search)` Does the same thing as {@link #search(fr.ifremer.allegro.Search) but with an additional two flags called `pageNumber` and `pageSize`.
`java.util.Set`	`search(int transform, Search search)` Does the same thing as `ReferenceDocumentDao.search(fr.ifremer.allegro.Search)` but with an additional flag called `transform`.
`java.util.Set`	`search(Search search)` Performs a search using the parameters specified in the given `search` object.
`void`	`setAuthorDao(AuthorDao authorDao)` Sets the reference to `authorDao`.
`void`	`setStatusDao(StatusDao statusDao)` Sets the reference to `statusDao`.
`void`	`setTaxonInformationHistoryDao(TaxonInformationHistoryDao taxonInformationHistoryDao)` Sets the reference to `taxonInformationHistoryDao`.
`protected ClusterReferenceDocument`	`toClusterReferenceDocument(java.lang.Object[] row)` Default implementation for transforming the results of a report query into a value object.
`ClusterReferenceDocument`	`toClusterReferenceDocument(ReferenceDocument entity)` Converts this DAO's entity to an object of type `ClusterReferenceDocument`.
`void`	`toClusterReferenceDocument(ReferenceDocument source, ClusterReferenceDocument target)` Copies the fields of the specified entity to the target value object.
`ClusterReferenceDocument[]`	`toClusterReferenceDocumentArray(java.util.Collection entities)` Converts this DAO's entity to an array of instances of type `ClusterReferenceDocument`.
`void`	`toClusterReferenceDocumentCollection(java.util.Collection entities)` Converts this DAO's entity to a Collection of instances of type `ClusterReferenceDocument`.
`protected ReferenceDocument`	`toEntity(java.lang.Object[] row)`
`protected RemoteReferenceDocumentFullVO`	`toRemoteReferenceDocumentFullVO(java.lang.Object[] row)` Default implementation for transforming the results of a report query into a value object.
`RemoteReferenceDocumentFullVO`	`toRemoteReferenceDocumentFullVO(ReferenceDocument entity)` Converts this DAO's entity to an object of type `RemoteReferenceDocumentFullVO`.
`void`	`toRemoteReferenceDocumentFullVO(ReferenceDocument source, RemoteReferenceDocumentFullVO target)` Copies the fields of the specified entity to the target value object.
`RemoteReferenceDocumentFullVO[]`	`toRemoteReferenceDocumentFullVOArray(java.util.Collection entities)` Converts this DAO's entity to an array of instances of type `RemoteReferenceDocumentFullVO`.
`void`	`toRemoteReferenceDocumentFullVOCollection(java.util.Collection entities)` Converts this DAO's entity to a Collection of instances of type `RemoteReferenceDocumentFullVO`.
`protected RemoteReferenceDocumentNaturalId`	`toRemoteReferenceDocumentNaturalId(java.lang.Object[] row)` Default implementation for transforming the results of a report query into a value object.
`RemoteReferenceDocumentNaturalId`	`toRemoteReferenceDocumentNaturalId(ReferenceDocument entity)` Converts this DAO's entity to an object of type `RemoteReferenceDocumentNaturalId`.
`void`	`toRemoteReferenceDocumentNaturalId(ReferenceDocument source, RemoteReferenceDocumentNaturalId target)` Copies the fields of the specified entity to the target value object.
`RemoteReferenceDocumentNaturalId[]`	`toRemoteReferenceDocumentNaturalIdArray(java.util.Collection entities)` Converts this DAO's entity to an array of instances of type `RemoteReferenceDocumentNaturalId`.
`void`	`toRemoteReferenceDocumentNaturalIdCollection(java.util.Collection entities)` Converts this DAO's entity to a Collection of instances of type `RemoteReferenceDocumentNaturalId`.
`protected void`	`transformEntities(int transform, java.util.Collection entities)` Transforms a collection of entities using the `transformEntity(int,fr.ifremer.allegro.referential.taxon.ReferenceDocument)` method.
`protected java.lang.Object`	`transformEntity(int transform, ReferenceDocument entity)` Allows transformation of entities into value objects (or something else for that matter), when the `transform` flag is set to one of the constants defined in `fr.ifremer.allegro.referential.taxon.ReferenceDocumentDao`, please note that the `ReferenceDocumentDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`void`	`update(java.util.Collection entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(ReferenceDocument referenceDocument)` Updates the `referenceDocument` instance in the persistent store.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface fr.ifremer.allegro.referential.taxon.ReferenceDocumentDao
`clusterReferenceDocumentToEntity, remoteReferenceDocumentFullVOToEntity, remoteReferenceDocumentNaturalIdToEntity`

Constructor Detail

ReferenceDocumentDaoBase

public ReferenceDocumentDaoBase()

Method Detail

setStatusDao

public void setStatusDao(StatusDao statusDao)

Sets the reference to statusDao.

getStatusDao

protected StatusDao getStatusDao()

Gets the reference to statusDao.

setAuthorDao

public void setAuthorDao(AuthorDao authorDao)

Sets the reference to authorDao.

getAuthorDao

protected AuthorDao getAuthorDao()

Gets the reference to authorDao.

setTaxonInformationHistoryDao

public void setTaxonInformationHistoryDao(TaxonInformationHistoryDao taxonInformationHistoryDao)

Sets the reference to taxonInformationHistoryDao.

getTaxonInformationHistoryDao

protected TaxonInformationHistoryDao getTaxonInformationHistoryDao()

Gets the reference to taxonInformationHistoryDao.