com.neurosys.configs

Class AbstractConfigurationJPADaoImpl<C extends AbstractConfiguration>

java.lang.Object

com.neurosys.domain.GenericAware<T>

com.neurosys.dao.jpa.GenericDaoImpl<T>

com.neurosys.dao.jpa.AbstractQueryableDaoImpl<C>

com.neurosys.configs.AbstractConfigurationJPADaoImpl<C>

All Implemented Interfaces:

ConfigurationDao<String,String,C>, ConfigurationSource<String,String>, FreeQuery, GenericDao<C>, QueryableDao<C>, Serializable

Direct Known Subclasses:

ConfigurationJPADaoImpl

public abstract class AbstractConfigurationJPADaoImpl<C extends AbstractConfiguration>
extends AbstractQueryableDaoImpl<C>
implements ConfigurationDao<String,String,C>, Serializable

Abstract reusable AbstractConfiguration class for other modules to extend.

Tech Note:Configuration DAO may depend on the database configs, while database configs may depend on configs. Hence to break the cyclic dependency that may arise the EntityManager maybe null and hence checked for in some methods.

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields inherited from class com.neurosys.dao.jpa.GenericDaoImpl

em

Fields inherited from class com.neurosys.domain.GenericAware

ct, t

Fields inherited from interface com.neurosys.configs.ConfigurationSource

NAMESPACE_DELIM

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationJPADaoImpl()

Method Summary

Modifier and Type	Method and Description
void	delete(C config) Remove a configuration
Map	get(String namespace) Get a Map of key name and corresponding IConfiguration for the specific namespace.
String	get(String namespace, String key) Will throw an exception if it did not find any matching result for the Config Note: param matching is case insensitive
String	get(User user, String namespace, String key) Get a configuration in the context to a User
Map	getAll(String namespace) Get a Map of key name and corresponding AbstractConfiguration for the specific namespace.
C	getConfig(C proxy)
C	getConfig(String namespace, String key)
List<C>	getConfigs(String namespace) Get configurations for a namespace and nested namesapces, as a collection of C
List<String>	getNamespaces() Get list of namespaces
C	put(C config) Updates the configurations and returns the updated configuration object for chaining

Methods inherited from class com.neurosys.dao.jpa.AbstractQueryableDaoImpl

conditionConstruct, count, ensureRowIsEntity, ensureRowIsEntity, getEntityInstance, getQueryObject, query, query, queryPage, queryPage

Methods inherited from class com.neurosys.dao.jpa.GenericDaoImpl

delete, getEntityManager, getNativeEntityName, load, load, paginate, query, query, save, setEntityManager, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.neurosys.dao.GenericDao

delete, load, load, save

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Constructor Detail

AbstractConfigurationJPADaoImpl

public AbstractConfigurationJPADaoImpl()

Method Detail

put

public C put(C config)

Updates the configurations and returns the updated configuration object for chaining

Specified by:

put in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

{@link - AbstractConfiguration} (Generic type extends Configuration)

Returns:

getConfig

public C getConfig(C proxy)

Specified by:

getConfig in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

getConfig

public C getConfig(String namespace,
                   String key)

Specified by:

getConfig in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

namespace - as String

key - as String

Returns:

AbstractConfiguration

get

public String get(String namespace,
                  String key)

Will throw an exception if it did not find any matching result for the Config
Note: param matching is case insensitive

Specified by:

get in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Specified by:

get in interface ConfigurationSource<String,String>

Parameters:

namespace - as String

key - as String

Returns:

AbstractConfiguration (Generic type extends Configuration) @nullable true, if no config exists

Throws:

Exception

get

public String get(User user,
                  String namespace,
                  String key)

Description copied from interface: ConfigurationSource

Get a configuration in the context to a User

Specified by:

get in interface ConfigurationSource<String,String>

Returns:

T

get

public Map get(String namespace)

Get a Map of key name and corresponding IConfiguration for the specific namespace.
The key in the returned map, is the key name local to the namespace.

This method may not be supported by some implementations. If namespace does not exist or namespace is null then null is returned. Note: param matching is case insensitive

Specified by:

get in interface ConfigurationSource<String,String>

Parameters:

namespace - as String

Returns:

Map of key and corresponding IConfiguration

getAll

public Map getAll(String namespace)

Description copied from interface: ConfigurationDao

Get a Map of key name and corresponding AbstractConfiguration for the specific namespace.
The key in the returned map, is the full key name including namespace, to avoid local key name conflicts in the returned map.
Note that namespaces are assumed to follow a delimited convention defined by ConfigurationSource.NAMESPACE_DELIM This method respects hierarchy based on default convention.
If namespace does not exist or namespace is null then null is returned. Note: param matching is case insensitive

Specified by:

getAll in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

namespace - as String

Returns:

Map of key and corresponding AbstractConfiguration

getNamespaces

public List<String> getNamespaces()

Description copied from interface: ConfigurationDao

Get list of namespaces

Specified by:

getNamespaces in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Returns:

List of String

getConfigs

public List<C> getConfigs(String namespace)

Description copied from interface: ConfigurationDao

Get configurations for a namespace and nested namesapces, as a collection of C

Specified by:

getConfigs in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

namespace - as String

Returns:

Collection of C

delete

public void delete(C config)

Description copied from interface: ConfigurationDao

Remove a configuration

Specified by:

delete in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Specified by:

delete in interface GenericDao<C extends AbstractConfiguration>

Overrides:

delete in class GenericDaoImpl<C extends AbstractConfiguration>