fr.ifremer.adagio.core.dao.referential.location

Interface LocationAreaDao

All Known Implementing Classes:

LocationAreaDaoBase, LocationAreaDaoImpl

public interface LocationAreaDao

See Also:

LocationArea

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSFORM_NONE This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<LocationArea>	create(Collection<LocationArea> entities) Creates a new instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<LocationArea> entities) Does the same thing as create(fr.ifremer.adagio.core.dao.referential.location.LocationArea) with an additional flag called transform.
Object	create(int transform, LocationArea locationArea) Does the same thing as create(fr.ifremer.adagio.core.dao.referential.location.LocationArea) with an additional flag called transform.
Object	create(int transform, LocationClassification locationClassification, LocationLevel locationLevel, String name, String position, Status status) Does the same thing as create(fr.ifremer.adagio.core.dao.referential.location.LocationClassification,fr.ifremer.adagio.core.dao.referential.location.LocationLevel,java.lang.String,java.lang.String,fr.ifremer.adagio.core.dao.referential.Status) with an additional flag called transform.
Object	create(int transform, String label, String name, Timestamp updateDate, Float bathymetry, Short utFormat, Boolean daylightSavingTime, LocationLevel locationLevel, Status status, LocationClassification locationClassification, String position) Does the same thing as create(java.lang.String,java.lang.String,java.sql.Timestamp,java.lang.Float,java.lang.Short,java.lang.Boolean,fr.ifremer.adagio.core.dao.referential.location.LocationLevel,fr.ifremer.adagio.core.dao.referential.Status,fr.ifremer.adagio.core.dao.referential.location.LocationClassification,java.lang.String) with an additional flag called transform.
LocationArea	create(LocationArea locationArea) Creates an instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea and adds it to the persistent store.
LocationArea	create(LocationClassification locationClassification, LocationLevel locationLevel, String name, String position, Status status) Creates a new fr.ifremer.adagio.core.dao.referential.location.LocationArea instance from only required properties (attributes and association ends) and adds it to the persistent store.
LocationArea	create(String label, String name, Timestamp updateDate, Float bathymetry, Short utFormat, Boolean daylightSavingTime, LocationLevel locationLevel, Status status, LocationClassification locationClassification, String position) Creates a new fr.ifremer.adagio.core.dao.referential.location.LocationArea instance from all attributes and properties and adds it to the persistent store.
LocationArea	load(Integer id) Loads an instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea from the persistent store.
Object	load(int transform, Integer id) Does the same thing as load(java.lang.Integer) with an additional flag called transform.
Collection<LocationArea>	loadAll() Loads all entities of type LocationArea.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
Collection<?>	loadAll(int pageNumber, int pageSize) Does the same thing as loadAll() with an additional two arguments called pageNumber and pageSize.
Collection<?>	loadAll(int transform, int pageNumber, int pageSize) Does the same thing as loadAll(int) with an additional two arguments called pageNumber and pageSize.
void	remove(Collection<LocationArea> entities) Removes all entities in the given entities collection.
void	remove(Integer id) Removes the instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea having the given identifier from the persistent store.
void	remove(LocationArea locationArea) Removes the instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea 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 search(fr.ifremer.adagio.core.dao.Search) but with an additional flag called transform.
Set<LocationArea>	search(Search search) Performs a search using the parameters specified in the given search object.
void	update(Collection<LocationArea> entities) Updates all instances in the entities collection in the persistent store.
void	update(LocationArea locationArea) Updates the locationArea instance in the persistent store.

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:

Constant Field Values

Method Detail

load

LocationArea load(Integer id)

Loads an instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea from the persistent store.

load

Object load(int transform,
          Integer id)

Does the same thing as 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.

Parameters:

id - identifier of the entity to load

Returns:

either the entity or the object transformed from the entity.

loadAll

Collection<LocationArea> loadAll()

Loads all entities of type LocationArea.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int transform)

Does the same thing as 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.

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int pageNumber,
                    int pageSize)

Does the same thing as 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.

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.

loadAll

Collection<?> loadAll(int transform,
                    int pageNumber,
                    int pageSize)

Does the same thing as 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.

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.

create

LocationArea create(LocationArea locationArea)

Creates an instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea and adds it to the persistent store.

create

Object create(int transform,
            LocationArea locationArea)

Does the same thing as create(fr.ifremer.adagio.core.dao.referential.location.LocationArea) 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.

create

Collection<LocationArea> create(Collection<LocationArea> entities)

Creates a new instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea and adds from the passed in entities collection

Parameters:

entities - the collection of fr.ifremer.adagio.core.dao.referential.location.LocationArea instances to create.

Returns:

the created instances.

create

Collection<?> create(int transform,
                   Collection<LocationArea> entities)

Does the same thing as create(fr.ifremer.adagio.core.dao.referential.location.LocationArea) 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.

create

LocationArea create(String label,
                  String name,
                  Timestamp updateDate,
                  Float bathymetry,
                  Short utFormat,
                  Boolean daylightSavingTime,
                  LocationLevel locationLevel,
                  Status status,
                  LocationClassification locationClassification,
                  String position)

Creates a new fr.ifremer.adagio.core.dao.referential.location.LocationArea instance from all attributes and properties and adds it to the persistent store.

create

Object create(int transform,
            String label,
            String name,
            Timestamp updateDate,
            Float bathymetry,
            Short utFormat,
            Boolean daylightSavingTime,
            LocationLevel locationLevel,
            Status status,
            LocationClassification locationClassification,
            String position)

Does the same thing as create(java.lang.String,java.lang.String,java.sql.Timestamp,java.lang.Float,java.lang.Short,java.lang.Boolean,fr.ifremer.adagio.core.dao.referential.location.LocationLevel,fr.ifremer.adagio.core.dao.referential.Status,fr.ifremer.adagio.core.dao.referential.location.LocationClassification,java.lang.String) 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.

create

LocationArea create(LocationClassification locationClassification,
                  LocationLevel locationLevel,
                  String name,
                  String position,
                  Status status)

Creates a new fr.ifremer.adagio.core.dao.referential.location.LocationArea instance from only required properties (attributes and association ends) and adds it to the persistent store.

create

Object create(int transform,
            LocationClassification locationClassification,
            LocationLevel locationLevel,
            String name,
            String position,
            Status status)

Does the same thing as create(fr.ifremer.adagio.core.dao.referential.location.LocationClassification,fr.ifremer.adagio.core.dao.referential.location.LocationLevel,java.lang.String,java.lang.String,fr.ifremer.adagio.core.dao.referential.Status) 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.

update

void update(LocationArea locationArea)

Updates the locationArea instance in the persistent store.

update

void update(Collection<LocationArea> entities)

Updates all instances in the entities collection in the persistent store.

remove

void remove(LocationArea locationArea)

Removes the instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea from the persistent store.

remove

void remove(Integer id)

Removes the instance of fr.ifremer.adagio.core.dao.referential.location.LocationArea having the given identifier from the persistent store.

remove

void remove(Collection<LocationArea> entities)

Removes all entities in the given entities collection.

search

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. These flags allow you to limit your data to a specified page number and size.

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.

search

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. These flags allow you to limit your data to a specified page number and size.

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.

search

Set<?> search(int transform,
            Search search)

Does the same thing as 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.

Parameters:

transform - the transformation flag.

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.

search

Set<LocationArea> search(Search search)

Performs a search using the parameters specified in the given search object.

Parameters:

search - the search object which provides the search parameters and pagination specification.

Returns:

any found results from the search.