com.whizzosoftware.hobson.api.persist

Interface CollectionPersistenceContext

public interface CollectionPersistenceContext

A context used when persisting collections using the CollectionPersister class.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
void	addSetValue(java.lang.String key, java.lang.Object value) Adds a value to a set (creating it if it doesn't already exist).
void	close() Closes the context (and any underlying connections).
void	commit() Commits changes to maps.
java.util.Map<java.lang.String,java.lang.Object>	getMap(java.lang.String key) Retrieves a named map.
java.lang.Object	getMapValue(java.lang.String key, java.lang.String name) Retrieves a value from within a named map.
java.util.Set<java.lang.Object>	getSet(java.lang.String key) Retrieves a named set.
boolean	hasMap(java.lang.String key) Indicates whether a given named map exists.
boolean	hasSet(java.lang.String key) Indicates whether a given named set exists.
boolean	hasSetValue(java.lang.String key, java.lang.Object value) Indicates whether a named set contains a value.
void	remove(java.lang.String key) Removes a named map.
void	removeFromSet(java.lang.String key, java.lang.Object value) Removes a value from a named set.
void	setMap(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> map) Sets a named map.
void	setMapValue(java.lang.String key, java.lang.String name, java.lang.Object value) Sets a property within a named map.
void	setSet(java.lang.String key, java.util.Set<java.lang.Object> set)

Method Detail

addSetValue

void addSetValue(java.lang.String key,
                 java.lang.Object value)

Adds a value to a set (creating it if it doesn't already exist).

Parameters:

key - the key referencing the set

value - the value to add

getMap

java.util.Map<java.lang.String,java.lang.Object> getMap(java.lang.String key)

Retrieves a named map.

Parameters:

key - the map key

Returns:

a Map instance

getMapValue

java.lang.Object getMapValue(java.lang.String key,
                             java.lang.String name)

Retrieves a value from within a named map.

Parameters:

key - the map key

name - the name of the property to retrieve

Returns:

an Object (or null if the property doesn't exist)

getSet

java.util.Set<java.lang.Object> getSet(java.lang.String key)

Retrieves a named set.

Parameters:

key - the key referencing the set

Returns:

a Set instance

hasMap

boolean hasMap(java.lang.String key)

Indicates whether a given named map exists.

Parameters:

key - the key referencing the map

Returns:

a boolean

hasSet

boolean hasSet(java.lang.String key)

Indicates whether a given named set exists.

Parameters:

key - the key referencing the set

Returns:

a boolean

hasSetValue

boolean hasSetValue(java.lang.String key,
                    java.lang.Object value)

Indicates whether a named set contains a value.

Parameters:

key - the key referencing the set

value - the value to check for

Returns:

a boolean

setMap

void setMap(java.lang.String key,
            java.util.Map<java.lang.String,java.lang.Object> map)

Sets a named map.

Parameters:

key - the key referencing the map

map - the Map instance

setMapValue

void setMapValue(java.lang.String key,
                 java.lang.String name,
                 java.lang.Object value)

Sets a property within a named map.

Parameters:

key - the key referencing the map

name - the name to set

value - the value to set for the name

setSet

void setSet(java.lang.String key,
            java.util.Set<java.lang.Object> set)

remove

void remove(java.lang.String key)

Removes a named map.

Parameters:

key - the key referencing the map

removeFromSet

void removeFromSet(java.lang.String key,
                   java.lang.Object value)

Removes a value from a named set.

Parameters:

key - the key referencing the set

value - the value to remove

commit

void commit()

Commits changes to maps.

close

void close()

Closes the context (and any underlying connections).