fr.ifremer.allegro.referential.spatial
Interface SpatialItemDao

All Known Implementing Classes:

SpatialItemDaoBase, SpatialItemDaoImpl

public interface SpatialItemDao

See Also:

SpatialItem

Field Summary

static int	TRANSFORM_CLUSTERSPATIALITEM 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.
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.
static int	TRANSFORM_REMOTESPATIALITEMFULLVO 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.
static int	TRANSFORM_REMOTESPATIALITEMNATURALID 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

SpatialItem	clusterSpatialItemToEntity(ClusterSpatialItem clusterSpatialItem) Converts an instance of type ClusterSpatialItem to this DAO's entity.
void	clusterSpatialItemToEntity(ClusterSpatialItem source, SpatialItem target, boolean copyIfNull) Copies the fields of ClusterSpatialItem to the specified entity.
void	clusterSpatialItemToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type ClusterSpatialItem to this DAO's entity.
java.util.Collection	create(java.util.Collection entities) Creates a new instance of fr.ifremer.allegro.referential.spatial.SpatialItem and adds from the passed in entities collection
java.util.Collection	create(int transform, java.util.Collection entities) Does the same thing as create(fr.ifremer.allegro.referential.spatial.SpatialItem) with an additional flag called transform.
SpatialItem	create(java.lang.Integer objectId, SpatialItemType spatialItemType) Creates a new fr.ifremer.allegro.referential.spatial.SpatialItem instance from only required properties (attributes and association ends) and adds it to the persistent store.
SpatialItem	create(java.lang.Integer objectId, java.sql.Timestamp updateDate, java.util.Collection spatialItemLines, java.util.Collection spatialItemAreas, java.util.Collection spatialItemPoints, SpatialItemType spatialItemType, java.util.Collection spatialItem2Locations) Creates a new fr.ifremer.allegro.referential.spatial.SpatialItem instance from all attributes and properties and adds it to the persistent store.
java.lang.Object	create(int transform, java.lang.Integer objectId, SpatialItemType spatialItemType) Does the same thing as create(java.lang.Integer,fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional flag called transform.
java.lang.Object	create(int transform, java.lang.Integer objectId, java.sql.Timestamp updateDate, java.util.Collection spatialItemLines, java.util.Collection spatialItemAreas, java.util.Collection spatialItemPoints, SpatialItemType spatialItemType, java.util.Collection spatialItem2Locations) Does the same thing as create(java.lang.Integer,java.sql.Timestamp,java.util.Collection,java.util.Collection,java.util.Collection,fr.ifremer.allegro.referential.spatial.SpatialItemType,java.util.Collection) with an additional flag called transform.
java.lang.Object	create(int transform, SpatialItem spatialItem) Does the same thing as create(fr.ifremer.allegro.referential.spatial.SpatialItem) with an additional flag called transform.
SpatialItem	create(SpatialItem spatialItem) Creates an instance of fr.ifremer.allegro.referential.spatial.SpatialItem and adds it to the persistent store.
SpatialItem	createFromClusterSpatialItem(ClusterSpatialItem clusterSpatialItem)
SpatialItem	findSpatialItemById(java.lang.Integer id)
java.lang.Object	findSpatialItemById(int transform, java.lang.Integer id) Does the same thing as findSpatialItemById(java.lang.Integer) with an additional flag called transform.
java.lang.Object	findSpatialItemById(int transform, java.lang.String queryString, java.lang.Integer id) Does the same thing as findSpatialItemById(int, java.lang.Integer) with an additional argument called queryString.
SpatialItem	findSpatialItemById(java.lang.String queryString, java.lang.Integer id) Does the same thing as findSpatialItemById(java.lang.Integer) with an additional argument called queryString.
SpatialItem	findSpatialItemByNaturalId(java.lang.Integer id)
java.lang.Object	findSpatialItemByNaturalId(int transform, java.lang.Integer id) Does the same thing as findSpatialItemByNaturalId(java.lang.Integer) with an additional flag called transform.
java.lang.Object	findSpatialItemByNaturalId(int transform, java.lang.String queryString, java.lang.Integer id) Does the same thing as findSpatialItemByNaturalId(int, java.lang.Integer) with an additional argument called queryString.
SpatialItem	findSpatialItemByNaturalId(java.lang.String queryString, java.lang.Integer id) Does the same thing as findSpatialItemByNaturalId(java.lang.Integer) with an additional argument called queryString.
java.util.Collection	findSpatialItemBySpatialItemType(int transform, int pageNumber, int pageSize, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(int, fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findSpatialItemBySpatialItemType(int pageNumber, int pageSize, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findSpatialItemBySpatialItemType(int transform, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional flag called transform.
java.util.Collection	findSpatialItemBySpatialItemType(int transform, java.lang.String queryString, int pageNumber, int pageSize, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(int, String, fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findSpatialItemBySpatialItemType(int transform, java.lang.String queryString, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(int, fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional argument called queryString.
java.util.Collection	findSpatialItemBySpatialItemType(SpatialItemType spatialItemType)
java.util.Collection	findSpatialItemBySpatialItemType(java.lang.String queryString, int pageNumber, int pageSize, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(String, fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	findSpatialItemBySpatialItemType(java.lang.String queryString, SpatialItemType spatialItemType) Does the same thing as findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional argument called queryString.
ClusterSpatialItem[]	getAllClusterSpatialItemSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp, java.lang.Integer userId, java.lang.Integer[] registrationLocationIds, java.lang.Integer pageNumber, java.lang.Integer pageSize)
java.util.Collection	getAllSpatialItem()
java.util.Collection	getAllSpatialItem(int transform) Does the same thing as getAllSpatialItem() with an additional flag called transform.
java.util.Collection	getAllSpatialItem(int pageNumber, int pageSize) Does the same thing as getAllSpatialItem() with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItem(int transform, int pageNumber, int pageSize) Does the same thing as getAllSpatialItem(int) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItem(int transform, java.lang.String queryString) Does the same thing as getAllSpatialItem(int) with an additional argument called queryString.
java.util.Collection	getAllSpatialItem(int transform, java.lang.String queryString, int pageNumber, int pageSize) Does the same thing as getAllSpatialItem(int, String) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItem(java.lang.String queryString) Does the same thing as getAllSpatialItem() with an additional argument called queryString.
java.util.Collection	getAllSpatialItem(java.lang.String queryString, int pageNumber, int pageSize) Does the same thing as getAllSpatialItem(String) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItemSinceDateSynchro(int transform, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(int, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItemSinceDateSynchro(int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItemSinceDateSynchro(int transform, java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(int, String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItemSinceDateSynchro(int transform, java.lang.String queryString, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(int, java.sql.Timestamp) with an additional argument called queryString.
java.util.Collection	getAllSpatialItemSinceDateSynchro(int transform, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(java.sql.Timestamp) with an additional flag called transform.
java.util.Collection	getAllSpatialItemSinceDateSynchro(java.lang.String queryString, int pageNumber, int pageSize, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(String, java.sql.Timestamp) with an additional two arguments called pageNumber and pageSize.
java.util.Collection	getAllSpatialItemSinceDateSynchro(java.lang.String queryString, java.sql.Timestamp updateDate) Does the same thing as getAllSpatialItemSinceDateSynchro(java.sql.Timestamp) with an additional argument called queryString.
java.util.Collection	getAllSpatialItemSinceDateSynchro(java.sql.Timestamp updateDate)
SpatialItem	load(java.lang.Integer id) Loads an instance of fr.ifremer.allegro.referential.spatial.SpatialItem from the persistent store.
java.lang.Object	load(int transform, java.lang.Integer id) Does the same thing as load(java.lang.Integer) with an additional flag called transform.
java.util.Collection	loadAll() Loads all entities of type SpatialItem.
java.util.Collection	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
java.util.Collection	loadAll(int pageNumber, int pageSize) Does the same thing as 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 loadAll(int) with an additional two arguments called pageNumber and pageSize.
SpatialItem	remoteSpatialItemFullVOToEntity(RemoteSpatialItemFullVO remoteSpatialItemFullVO) Converts an instance of type RemoteSpatialItemFullVO to this DAO's entity.
void	remoteSpatialItemFullVOToEntity(RemoteSpatialItemFullVO source, SpatialItem target, boolean copyIfNull) Copies the fields of RemoteSpatialItemFullVO to the specified entity.
void	remoteSpatialItemFullVOToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type RemoteSpatialItemFullVO to this DAO's entity.
SpatialItem	remoteSpatialItemNaturalIdToEntity(RemoteSpatialItemNaturalId remoteSpatialItemNaturalId) Converts an instance of type RemoteSpatialItemNaturalId to this DAO's entity.
void	remoteSpatialItemNaturalIdToEntity(RemoteSpatialItemNaturalId source, SpatialItem target, boolean copyIfNull) Copies the fields of RemoteSpatialItemNaturalId to the specified entity.
void	remoteSpatialItemNaturalIdToEntityCollection(java.util.Collection instances) Converts a Collection of instances of type RemoteSpatialItemNaturalId 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.spatial.SpatialItem having the given identifier from the persistent store.
void	remove(SpatialItem spatialItem) Removes the instance of fr.ifremer.allegro.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.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 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.
ClusterSpatialItem	toClusterSpatialItem(SpatialItem entity) Converts this DAO's entity to an object of type ClusterSpatialItem.
void	toClusterSpatialItem(SpatialItem source, ClusterSpatialItem target) Copies the fields of the specified entity to the target value object.
ClusterSpatialItem[]	toClusterSpatialItemArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type ClusterSpatialItem.
void	toClusterSpatialItemCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type ClusterSpatialItem.
RemoteSpatialItemFullVO	toRemoteSpatialItemFullVO(SpatialItem entity) Converts this DAO's entity to an object of type RemoteSpatialItemFullVO.
void	toRemoteSpatialItemFullVO(SpatialItem source, RemoteSpatialItemFullVO target) Copies the fields of the specified entity to the target value object.
RemoteSpatialItemFullVO[]	toRemoteSpatialItemFullVOArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type RemoteSpatialItemFullVO.
void	toRemoteSpatialItemFullVOCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type RemoteSpatialItemFullVO.
RemoteSpatialItemNaturalId	toRemoteSpatialItemNaturalId(SpatialItem entity) Converts this DAO's entity to an object of type RemoteSpatialItemNaturalId.
void	toRemoteSpatialItemNaturalId(SpatialItem source, RemoteSpatialItemNaturalId target) Copies the fields of the specified entity to the target value object.
RemoteSpatialItemNaturalId[]	toRemoteSpatialItemNaturalIdArray(java.util.Collection entities) Converts this DAO's entity to an array of instances of type RemoteSpatialItemNaturalId.
void	toRemoteSpatialItemNaturalIdCollection(java.util.Collection entities) Converts this DAO's entity to a Collection of instances of type RemoteSpatialItemNaturalId.
void	update(java.util.Collection entities) Updates all instances in the entities collection in the persistent store.
void	update(SpatialItem spatialItem) Updates the spatialItem 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

TRANSFORM_REMOTESPATIALITEMFULLVO

static final int TRANSFORM_REMOTESPATIALITEMFULLVO

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 entities must be transformed into objects of type RemoteSpatialItemFullVO.

See Also:

Constant Field Values

TRANSFORM_REMOTESPATIALITEMNATURALID

static final int TRANSFORM_REMOTESPATIALITEMNATURALID

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 entities must be transformed into objects of type RemoteSpatialItemNaturalId.

See Also:

Constant Field Values

TRANSFORM_CLUSTERSPATIALITEM

static final int TRANSFORM_CLUSTERSPATIALITEM

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 entities must be transformed into objects of type ClusterSpatialItem.

See Also:

Constant Field Values

Method Detail

toRemoteSpatialItemFullVO

void toRemoteSpatialItemFullVO(SpatialItem source,
                               RemoteSpatialItemFullVO target)

Copies the fields of the specified entity to the target value object. This method is similar to toRemoteSpatialItemFullVO(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

toRemoteSpatialItemFullVO

RemoteSpatialItemFullVO toRemoteSpatialItemFullVO(SpatialItem entity)

Converts this DAO's entity to an object of type RemoteSpatialItemFullVO.

toRemoteSpatialItemFullVOCollection

void toRemoteSpatialItemFullVOCollection(java.util.Collection entities)

Converts this DAO's entity to a Collection of instances of type RemoteSpatialItemFullVO.

toRemoteSpatialItemFullVOArray

RemoteSpatialItemFullVO[] toRemoteSpatialItemFullVOArray(java.util.Collection entities)

Converts this DAO's entity to an array of instances of type RemoteSpatialItemFullVO.

remoteSpatialItemFullVOToEntity

void remoteSpatialItemFullVOToEntity(RemoteSpatialItemFullVO source,
                                     SpatialItem target,
                                     boolean copyIfNull)

Copies the fields of RemoteSpatialItemFullVO to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

remoteSpatialItemFullVOToEntity

SpatialItem remoteSpatialItemFullVOToEntity(RemoteSpatialItemFullVO remoteSpatialItemFullVO)

Converts an instance of type RemoteSpatialItemFullVO to this DAO's entity.

remoteSpatialItemFullVOToEntityCollection

void remoteSpatialItemFullVOToEntityCollection(java.util.Collection instances)

Converts a Collection of instances of type RemoteSpatialItemFullVO to this DAO's entity.

toRemoteSpatialItemNaturalId

void toRemoteSpatialItemNaturalId(SpatialItem source,
                                  RemoteSpatialItemNaturalId target)

Copies the fields of the specified entity to the target value object. This method is similar to toRemoteSpatialItemNaturalId(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

toRemoteSpatialItemNaturalId

RemoteSpatialItemNaturalId toRemoteSpatialItemNaturalId(SpatialItem entity)

Converts this DAO's entity to an object of type RemoteSpatialItemNaturalId.

toRemoteSpatialItemNaturalIdCollection

void toRemoteSpatialItemNaturalIdCollection(java.util.Collection entities)

Converts this DAO's entity to a Collection of instances of type RemoteSpatialItemNaturalId.

toRemoteSpatialItemNaturalIdArray

RemoteSpatialItemNaturalId[] toRemoteSpatialItemNaturalIdArray(java.util.Collection entities)

Converts this DAO's entity to an array of instances of type RemoteSpatialItemNaturalId.

remoteSpatialItemNaturalIdToEntity

void remoteSpatialItemNaturalIdToEntity(RemoteSpatialItemNaturalId source,
                                        SpatialItem target,
                                        boolean copyIfNull)

Copies the fields of RemoteSpatialItemNaturalId to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

remoteSpatialItemNaturalIdToEntity

SpatialItem remoteSpatialItemNaturalIdToEntity(RemoteSpatialItemNaturalId remoteSpatialItemNaturalId)

Converts an instance of type RemoteSpatialItemNaturalId to this DAO's entity.

remoteSpatialItemNaturalIdToEntityCollection

void remoteSpatialItemNaturalIdToEntityCollection(java.util.Collection instances)

Converts a Collection of instances of type RemoteSpatialItemNaturalId to this DAO's entity.

toClusterSpatialItem

void toClusterSpatialItem(SpatialItem source,
                          ClusterSpatialItem target)

Copies the fields of the specified entity to the target value object. This method is similar to toClusterSpatialItem(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

toClusterSpatialItem

ClusterSpatialItem toClusterSpatialItem(SpatialItem entity)

Converts this DAO's entity to an object of type ClusterSpatialItem.

toClusterSpatialItemCollection

void toClusterSpatialItemCollection(java.util.Collection entities)

Converts this DAO's entity to a Collection of instances of type ClusterSpatialItem.

toClusterSpatialItemArray

ClusterSpatialItem[] toClusterSpatialItemArray(java.util.Collection entities)

Converts this DAO's entity to an array of instances of type ClusterSpatialItem.

clusterSpatialItemToEntity

void clusterSpatialItemToEntity(ClusterSpatialItem source,
                                SpatialItem target,
                                boolean copyIfNull)

Copies the fields of ClusterSpatialItem to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.

clusterSpatialItemToEntity

SpatialItem clusterSpatialItemToEntity(ClusterSpatialItem clusterSpatialItem)

Converts an instance of type ClusterSpatialItem to this DAO's entity.

clusterSpatialItemToEntityCollection

void clusterSpatialItemToEntityCollection(java.util.Collection instances)

Converts a Collection of instances of type ClusterSpatialItem to this DAO's entity.

load

SpatialItem load(java.lang.Integer id)

Loads an instance of fr.ifremer.allegro.referential.spatial.SpatialItem from the persistent store.

load

java.lang.Object load(int transform,
                      java.lang.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

java.util.Collection loadAll()

Loads all entities of type SpatialItem.

Returns:

the loaded entities.

loadAll

java.util.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

java.util.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

java.util.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

SpatialItem create(SpatialItem spatialItem)

Creates an instance of fr.ifremer.allegro.referential.spatial.SpatialItem and adds it to the persistent store.

create

java.lang.Object create(int transform,
                        SpatialItem spatialItem)

Does the same thing as create(fr.ifremer.allegro.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.

create

java.util.Collection create(java.util.Collection entities)

Creates a new instance of fr.ifremer.allegro.referential.spatial.SpatialItem and adds from the passed in entities collection

Parameters:

entities - the collection of fr.ifremer.allegro.referential.spatial.SpatialItem instances to create.

Returns:

the created instances.

create

java.util.Collection create(int transform,
                            java.util.Collection entities)

Does the same thing as create(fr.ifremer.allegro.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.

create

SpatialItem create(java.lang.Integer objectId,
                   java.sql.Timestamp updateDate,
                   java.util.Collection spatialItemLines,
                   java.util.Collection spatialItemAreas,
                   java.util.Collection spatialItemPoints,
                   SpatialItemType spatialItemType,
                   java.util.Collection spatialItem2Locations)

Creates a new fr.ifremer.allegro.referential.spatial.SpatialItem instance from all attributes and properties and adds it to the persistent store.

create

java.lang.Object create(int transform,
                        java.lang.Integer objectId,
                        java.sql.Timestamp updateDate,
                        java.util.Collection spatialItemLines,
                        java.util.Collection spatialItemAreas,
                        java.util.Collection spatialItemPoints,
                        SpatialItemType spatialItemType,
                        java.util.Collection spatialItem2Locations)

Does the same thing as create(java.lang.Integer,java.sql.Timestamp,java.util.Collection,java.util.Collection,java.util.Collection,fr.ifremer.allegro.referential.spatial.SpatialItemType,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.

create

SpatialItem create(java.lang.Integer objectId,
                   SpatialItemType spatialItemType)

Creates a new fr.ifremer.allegro.referential.spatial.SpatialItem instance from only required properties (attributes and association ends) and adds it to the persistent store.

create

java.lang.Object create(int transform,
                        java.lang.Integer objectId,
                        SpatialItemType spatialItemType)

Does the same thing as create(java.lang.Integer,fr.ifremer.allegro.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.

update

void update(SpatialItem spatialItem)

Updates the spatialItem instance in the persistent store.

update

void update(java.util.Collection entities)

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

remove

void remove(SpatialItem spatialItem)

Removes the instance of fr.ifremer.allegro.referential.spatial.SpatialItem from the persistent store.

remove

void remove(java.lang.Integer id)

Removes the instance of fr.ifremer.allegro.referential.spatial.SpatialItem having the given identifier from the persistent store.

remove

void remove(java.util.Collection entities)

Removes all entities in the given entities collection.

getAllSpatialItem

java.util.Collection getAllSpatialItem()

getAllSpatialItem

java.util.Collection getAllSpatialItem(java.lang.String queryString)

Does the same thing as getAllSpatialItem() with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllSpatialItem().

getAllSpatialItem

java.util.Collection getAllSpatialItem(int pageNumber,
                                       int pageSize)

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

getAllSpatialItem

java.util.Collection getAllSpatialItem(java.lang.String queryString,
                                       int pageNumber,
                                       int pageSize)

Does the same thing as getAllSpatialItem(String) 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.

getAllSpatialItem

java.util.Collection getAllSpatialItem(int transform)

Does the same thing as getAllSpatialItem() 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 finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

getAllSpatialItem

java.util.Collection getAllSpatialItem(int transform,
                                       int pageNumber,
                                       int pageSize)

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

getAllSpatialItem

java.util.Collection getAllSpatialItem(int transform,
                                       java.lang.String queryString)

Does the same thing as getAllSpatialItem(int) with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllSpatialItem(int).

getAllSpatialItem

java.util.Collection getAllSpatialItem(int transform,
                                       java.lang.String queryString,
                                       int pageNumber,
                                       int pageSize)

Does the same thing as getAllSpatialItem(int, String) 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.

findSpatialItemById

SpatialItem findSpatialItemById(java.lang.Integer id)

findSpatialItemById

SpatialItem findSpatialItemById(java.lang.String queryString,
                                java.lang.Integer id)

Does the same thing as findSpatialItemById(java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findSpatialItemById(java.lang.Integer).

findSpatialItemById

java.lang.Object findSpatialItemById(int transform,
                                     java.lang.Integer id)

Does the same thing as findSpatialItemById(java.lang.Integer) 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 finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findSpatialItemById

java.lang.Object findSpatialItemById(int transform,
                                     java.lang.String queryString,
                                     java.lang.Integer id)

Does the same thing as findSpatialItemById(int, java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findSpatialItemById(int, java.lang.Integer id).

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(SpatialItemType spatialItemType)

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(java.lang.String queryString,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType).

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(int pageNumber,
                                                      int pageSize,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType) 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.

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(java.lang.String queryString,
                                                      int pageNumber,
                                                      int pageSize,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(String, fr.ifremer.allegro.referential.spatial.SpatialItemType) 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.

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(int transform,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(fr.ifremer.allegro.referential.spatial.SpatialItemType) 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 finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(int transform,
                                                      int pageNumber,
                                                      int pageSize,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(int, fr.ifremer.allegro.referential.spatial.SpatialItemType) 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.

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(int transform,
                                                      java.lang.String queryString,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(int, fr.ifremer.allegro.referential.spatial.SpatialItemType) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findSpatialItemBySpatialItemType(int, fr.ifremer.allegro.referential.spatial.SpatialItemType spatialItemType).

findSpatialItemBySpatialItemType

java.util.Collection findSpatialItemBySpatialItemType(int transform,
                                                      java.lang.String queryString,
                                                      int pageNumber,
                                                      int pageSize,
                                                      SpatialItemType spatialItemType)

Does the same thing as findSpatialItemBySpatialItemType(int, String, fr.ifremer.allegro.referential.spatial.SpatialItemType) 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.

findSpatialItemByNaturalId

SpatialItem findSpatialItemByNaturalId(java.lang.Integer id)

findSpatialItemByNaturalId

SpatialItem findSpatialItemByNaturalId(java.lang.String queryString,
                                       java.lang.Integer id)

Does the same thing as findSpatialItemByNaturalId(java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findSpatialItemByNaturalId(java.lang.Integer).

findSpatialItemByNaturalId

java.lang.Object findSpatialItemByNaturalId(int transform,
                                            java.lang.Integer id)

Does the same thing as findSpatialItemByNaturalId(java.lang.Integer) 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 finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

findSpatialItemByNaturalId

java.lang.Object findSpatialItemByNaturalId(int transform,
                                            java.lang.String queryString,
                                            java.lang.Integer id)

Does the same thing as findSpatialItemByNaturalId(int, java.lang.Integer) with an additional argument called queryString. This queryString argument allows you to override the query string defined in findSpatialItemByNaturalId(int, java.lang.Integer id).

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(java.sql.Timestamp updateDate)

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(java.lang.String queryString,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(java.sql.Timestamp) with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllSpatialItemSinceDateSynchro(java.sql.Timestamp).

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(int pageNumber,
                                                       int pageSize,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(java.sql.Timestamp) 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.

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(java.lang.String queryString,
                                                       int pageNumber,
                                                       int pageSize,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(String, java.sql.Timestamp) 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.

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(int transform,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(java.sql.Timestamp) 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 finder results WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(int transform,
                                                       int pageNumber,
                                                       int pageSize,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(int, java.sql.Timestamp) 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.

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(int transform,
                                                       java.lang.String queryString,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(int, java.sql.Timestamp) with an additional argument called queryString. This queryString argument allows you to override the query string defined in getAllSpatialItemSinceDateSynchro(int, java.sql.Timestamp updateDate).

getAllSpatialItemSinceDateSynchro

java.util.Collection getAllSpatialItemSinceDateSynchro(int transform,
                                                       java.lang.String queryString,
                                                       int pageNumber,
                                                       int pageSize,
                                                       java.sql.Timestamp updateDate)

Does the same thing as getAllSpatialItemSinceDateSynchro(int, String, java.sql.Timestamp) 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.

createFromClusterSpatialItem

SpatialItem createFromClusterSpatialItem(ClusterSpatialItem clusterSpatialItem)

getAllClusterSpatialItemSinceDateSynchro

ClusterSpatialItem[] getAllClusterSpatialItemSinceDateSynchro(java.sql.Timestamp synchronizationTimestamp,
                                                              java.lang.Integer userId,
                                                              java.lang.Integer[] registrationLocationIds,
                                                              java.lang.Integer pageNumber,
                                                              java.lang.Integer pageSize)

search

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. 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.allegro.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

java.util.Set search(int transform,
                     Search search)

Does the same thing as search(fr.ifremer.allegro.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

java.util.Set 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.