SpatialItemDaoBase (SIH-Adagio Core 3.3.1-rev-401 API)

java.lang.Object
- org.springframework.dao.support.DaoSupport
- - org.springframework.orm.hibernate3.support.HibernateDaoSupport
  - - fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDaoBase

All Implemented Interfaces:

SpatialItemDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

SpatialItemDaoImpl
```
public abstract class SpatialItemDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements SpatialItemDao
```
Base Spring DAO Class: is able to create, update, remove, load, and find objects of type fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem.

See Also:
SpatialItem

Field Summary
- Fields inherited from class org.springframework.dao.support.DaoSupport
  logger
- Fields inherited from interface fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao
  TRANSFORM_NONE

Constructor Summary

Constructors
Constructor and Description

SpatialItemDaoBase()

Constructors
Constructor and Description
`SpatialItemDaoBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`Collection<SpatialItem>`	`create(Collection<SpatialItem> entities)` Creates a new instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem and adds from the passed in `entities` collection
`Collection<?>`	`create(int transform, Collection<SpatialItem> entities)` Does the same thing as `SpatialItemDao.create(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)` with an additional flag called `transform`.
`SpatialItem`	`create(Integer objectId, SpatialItemType spatialItemType)` Creates a new `fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem` instance from only required properties (attributes and association ends) and adds it to the persistent store.
`SpatialItem`	`create(Integer objectId, Timestamp updateDate, Collection<SpatialItemLine> spatialItemLines, SpatialItemType spatialItemType, Collection<SpatialItemArea> spatialItemAreas, Collection<SpatialItem2Location> spatialItem2Locations, Collection<SpatialItemPoint> spatialItemPoints)` Creates a new `fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem` instance from all attributes and properties and adds it to the persistent store.
`Object`	`create(int transform, Integer objectId, SpatialItemType spatialItemType)` Does the same thing as `SpatialItemDao.create(java.lang.Integer,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType)` with an additional flag called `transform`.
`Object`	`create(int transform, Integer objectId, Timestamp updateDate, Collection<SpatialItemLine> spatialItemLines, SpatialItemType spatialItemType, Collection<SpatialItemArea> spatialItemAreas, Collection<SpatialItem2Location> spatialItem2Locations, Collection<SpatialItemPoint> spatialItemPoints)` Does the same thing as `#create(java.lang.Integer,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType,java.util.Collection,java.util.Collection,java.util.Collection)` with an additional flag called `transform`.
`Object`	`create(int transform, SpatialItem spatialItem)` Does the same thing as `SpatialItemDao.create(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)` with an additional flag called `transform`.
`SpatialItem`	`create(SpatialItem spatialItem)` Creates an instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem and adds it to the persistent store.
`protected Principal`	`getPrincipal()` Gets the current `principal` if one has been set, otherwise returns `null`.
`SpatialItem`	`load(Integer id)` Loads an instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem from the persistent store.
`Object`	`load(int transform, Integer id)` Does the same thing as `SpatialItemDao.load(java.lang.Integer)` with an additional flag called `transform`.
`Collection<SpatialItem>`	`loadAll()` Loads all entities of type `SpatialItem`.
`Collection<?>`	`loadAll(int transform)` Does the same thing as `SpatialItemDao.loadAll()` with an additional flag called `transform`.
`Collection<?>`	`loadAll(int pageNumber, int pageSize)` Does the same thing as `SpatialItemDao.loadAll()` with an additional two arguments called `pageNumber` and `pageSize`.
`Collection<?>`	`loadAll(int transform, int pageNumber, int pageSize)` Does the same thing as `SpatialItemDao.loadAll(int)` with an additional two arguments called `pageNumber` and `pageSize`.
`void`	`remove(Collection<SpatialItem> entities)` Removes all entities in the given `entities collection.`
`void`	`remove(Integer id)` Removes the instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem having the given `identifier` from the persistent store.
`void`	`remove(SpatialItem spatialItem)` Removes the instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem from the persistent store.
`PaginationResult`	`search(int transform, int pageNumber, int pageSize, Search search)` Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.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.adagio.core.dao.Search) but with an additional two flags called `pageNumber` and `pageSize`.
`Set<?>`	`search(int transform, Search search)` Does the same thing as `SpatialItemDao.search(fr.ifremer.adagio.core.dao.Search)` but with an additional flag called `transform`.
`Set<SpatialItem>`	`search(Search search)` Performs a search using the parameters specified in the given `search` object.
`protected SpatialItem`	`toEntity(Object[] row)`
`protected void`	`transformEntities(int transform, Collection<?> entities)` Transforms a collection of entities using the `transformEntity(int,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)` method.
`protected Object`	`transformEntity(int transform, SpatialItem 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.adagio.core.dao.referential.spatial.SpatialItemDao`, please note that the `SpatialItemDao.TRANSFORM_NONE` constant denotes no transformation, so the entity itself will be returned.
`void`	`update(Collection<SpatialItem> entities)` Updates all instances in the `entities` collection in the persistent store.
`void`	`update(SpatialItem spatialItem)` Updates the `spatialItem` instance in the persistent store.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport
checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport
afterPropertiesSet, initDao

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

- Constructor Detail
  - SpatialItemDaoBase
```
public SpatialItemDaoBase()
```
- Method Detail
  - load
```
public Object load(int transform,
          Integer id)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.load(java.lang.Integer) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Specified by:
    
    load in interface SpatialItemDao
    
    id - identifier of the entity to load
    
    Returns:
    either the entity or the object transformed from the entity.
    See Also:
    SpatialItemDao.load(int, java.lang.Integer)
  - load
```
public SpatialItem load(Integer id)
```
    Description copied from interface: SpatialItemDao
    
    Loads an instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem from the persistent store.
    
    Specified by:
    
    load in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.load(java.lang.Integer)
  - loadAll
```
public Collection<SpatialItem> loadAll()
```
    Description copied from interface: SpatialItemDao
    
    Loads all entities of type SpatialItem.
    
    Specified by:
    
    loadAll in interface SpatialItemDao
    
    Returns:
    the loaded entities.
    See Also:
    SpatialItemDao.loadAll()
  - loadAll
```
public Collection<?> loadAll(int transform)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Specified by:
    
    loadAll in interface SpatialItemDao
    
    Parameters:
    transform - the flag indicating what transformation to use.
    
    Returns:
    the loaded entities.
    See Also:
    SpatialItemDao.loadAll(int)
  - loadAll
```
public Collection<?> loadAll(int pageNumber,
                    int pageSize)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.loadAll() with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.
    
    Specified by:
    
    loadAll in interface SpatialItemDao
    
    Parameters:
    pageNumber - the page number to retrieve when paging results.
    pageSize - the size of the page to retrieve when paging results.
    
    Returns:
    the loaded entities.
    See Also:
    SpatialItemDao.loadAll(int, int)
  - loadAll
```
public Collection<?> loadAll(int transform,
                    int pageNumber,
                    int pageSize)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.loadAll(int) with an additional two arguments called pageNumber and pageSize. The pageNumber argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the page retrieved.
    
    Specified by:
    
    loadAll in interface SpatialItemDao
    
    Parameters:
    transform - the flag indicating what transformation to use.
    pageNumber - the page number to retrieve when paging results.
    pageSize - the size of the page to retrieve when paging results.
    
    Returns:
    the loaded entities.
    See Also:
    SpatialItemDao.loadAll(int, int, int)
  - create
```
public SpatialItem create(SpatialItem spatialItem)
```
    Description copied from interface: SpatialItemDao
    
    Creates an instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem and adds it to the persistent store.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.create(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)
  - create
```
public Object create(int transform,
            SpatialItem spatialItem)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.create(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.create(int transform, fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)
  - create
```
public Collection<SpatialItem> create(Collection<SpatialItem> entities)
```
    Description copied from interface: SpatialItemDao
    
    Creates a new instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem and adds from the passed in entities collection
    
    Specified by:
    
    create in interface SpatialItemDao
    
    Parameters:
    entities - the collection of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem instances to create.
    
    Returns:
    the created instances.
    See Also:
    fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao#create(java.util.Collection)
  - create
```
public Collection<?> create(int transform,
                   Collection<SpatialItem> entities)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.create(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao#create(int, java.util.Collection)
  - create
```
public SpatialItem create(Integer objectId,
                 Timestamp updateDate,
                 Collection<SpatialItemLine> spatialItemLines,
                 SpatialItemType spatialItemType,
                 Collection<SpatialItemArea> spatialItemAreas,
                 Collection<SpatialItem2Location> spatialItem2Locations,
                 Collection<SpatialItemPoint> spatialItemPoints)
```
    Description copied from interface: SpatialItemDao
    
    Creates a new fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem instance from all attributes and properties and adds it to the persistent store.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao#create(java.lang.Integer,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType,java.util.Collection,java.util.Collection,java.util.Collection)
  - create
```
public Object create(int transform,
            Integer objectId,
            Timestamp updateDate,
            Collection<SpatialItemLine> spatialItemLines,
            SpatialItemType spatialItemType,
            Collection<SpatialItemArea> spatialItemAreas,
            Collection<SpatialItem2Location> spatialItem2Locations,
            Collection<SpatialItemPoint> spatialItemPoints)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as #create(java.lang.Integer,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType,java.util.Collection,java.util.Collection,java.util.Collection) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao#create(int, java.lang.Integer,java.sql.Timestamp,java.util.Collection,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType,java.util.Collection,java.util.Collection,java.util.Collection)
  - create
```
public SpatialItem create(Integer objectId,
                 SpatialItemType spatialItemType)
```
    Description copied from interface: SpatialItemDao
    
    Creates a new fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem instance from only required properties (attributes and association ends) and adds it to the persistent store.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.create(java.lang.Integer,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType)
  - create
```
public Object create(int transform,
            Integer objectId,
            SpatialItemType spatialItemType)
```
    Description copied from interface: SpatialItemDao
    
    Does the same thing as SpatialItemDao.create(java.lang.Integer,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOTWILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.
    
    Specified by:
    
    create in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.create(int, java.lang.Integer,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemType)
  - update
```
public void update(SpatialItem spatialItem)
```
    Description copied from interface: SpatialItemDao
    
    Updates the spatialItem instance in the persistent store.
    
    Specified by:
    
    update in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.update(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)
  - update
```
public void update(Collection<SpatialItem> entities)
```
    Description copied from interface: SpatialItemDao
    
    Updates all instances in the entities collection in the persistent store.
    
    Specified by:
    
    update in interface SpatialItemDao
    
    See Also:
    fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao#update(java.util.Collection)
  - remove
```
public void remove(SpatialItem spatialItem)
```
    Description copied from interface: SpatialItemDao
    
    Removes the instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem from the persistent store.
    
    Specified by:
    
    remove in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.remove(fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem)
  - remove
```
public void remove(Integer id)
```
    Description copied from interface: SpatialItemDao
    
    Removes the instance of fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem having the given identifier from the persistent store.
    
    Specified by:
    
    remove in interface SpatialItemDao
    
    See Also:
    SpatialItemDao.remove(java.lang.Integer)
  - remove
```
public void remove(Collection<SpatialItem> entities)
```
    Description copied from interface: SpatialItemDao
    
    Removes all entities in the given entities collection.
    Specified by: remove in interface SpatialItemDao See Also: fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao#remove(java.util.Collection)
  transformEntity protected Object transformEntity(int transform, SpatialItem 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.adagio.core.dao.referential.spatial.SpatialItemDao, please note that the SpatialItemDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown SpatialItemDao.TRANSFORM_NONE is assumed. Parameters: transform - one of the constants declared in SpatialItemDao entity - an entity that was found Returns: the transformed entity (i.e. new value object, etc) See Also: transformEntities(int,java.util.Collection) transformEntities protected void transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem) method. This method does not instantiate a new collection. This method is to be used internally only. Parameters: transform - one of the constants declared in fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao entities - the collection of entities to transform See Also: transformEntity(int,fr.ifremer.adagio.core.dao.referential.spatial.SpatialItem) toEntity protected SpatialItem toEntity(Object[] row) getPrincipal protected Principal getPrincipal() Gets the current principal if one has been set, otherwise returns null. Returns: the current principal search public PaginationResult search(int transform, int pageNumber, int pageSize, Search search) Description copied from interface: SpatialItemDao Does the same thing as {@link #search(int, fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size. Specified by: search in interface SpatialItemDao Parameters: transform - the transformation flag. pageNumber - the page number in the data to retrieve pageSize - the size of the page to retrieve. search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search wrapped in a PaginationResult instance. See Also: SpatialItemDao.search(int, int, int, fr.ifremer.adagio.core.dao.Search) search public PaginationResult search(int pageNumber, int pageSize, Search search) Description copied from interface: SpatialItemDao Does the same thing as {@link #search(fr.ifremer.adagio.core.dao.Search) but with an additional two flags called pageNumber and pageSize. These flags allow you to limit your data to a specified page number and size. Specified by: search in interface SpatialItemDao Parameters: pageNumber - the page number in the data to retrieve pageSize - the size of the page to retrieve. search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search wrapped in a PaginationResult instance. See Also: SpatialItemDao.search(int, int, fr.ifremer.adagio.core.dao.Search) search public Set<?> search(int transform, Search search) Description copied from interface: SpatialItemDao Does the same thing as SpatialItemDao.search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform. If this flag is set to TRANSFORM_NONE then finder results will NOT be transformed during retrieval. If this flag is any of the other constants defined here then results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur. Specified by: search in interface SpatialItemDao Parameters: transform - the transformation flag. search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search. See Also: SpatialItemDao.search(int, fr.ifremer.adagio.core.dao.Search) search public Set<SpatialItem> search(Search search) Description copied from interface: SpatialItemDao Performs a search using the parameters specified in the given search object. Specified by: search in interface SpatialItemDao Parameters: search - the search object which provides the search parameters and pagination specification. Returns: any found results from the search. See Also: SpatialItemDao.search(fr.ifremer.adagio.core.dao.Search)

Class SpatialItemDaoBase

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

Fields inherited from interface fr.ifremer.adagio.core.dao.referential.spatial.SpatialItemDao

Constructor Summary

Method Summary

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

Methods inherited from class org.springframework.dao.support.DaoSupport

Methods inherited from class java.lang.Object

Constructor Detail

SpatialItemDaoBase

Method Detail

load

load

loadAll

loadAll

loadAll

loadAll

create

create

create

create

create

create

create

create

update

update

remove

remove

remove

transformEntity

transformEntities

toEntity

getPrincipal

search

search

search

search