Package com.activeviam.copper

Class DatabaseHelper

java.lang.Object

com.activeviam.copper.DatabaseHelper

All Implemented Interfaces:

IDatabaseHelper

@Deprecated(since="6.0.7",
            forRemoval=true)
public class DatabaseHelper
extends Object
implements IDatabaseHelper

Deprecated, for removal: This API element is subject to removal in a future version.

Implementation of IDatabaseHelper based on an IDatabaseSchemaEntityResolver.

Author:

ActiveViam

Constructor Summary

Constructors

Constructor	Description
DatabaseHelper(IDatabaseSchemaEntityResolver resolver)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor.

Method Summary

Modifier and Type	Method	Description
void	ensureFieldExists(ReachableField field)	Deprecated, for removal: This API element is subject to removal in a future version. Ensures the given field exists.
Object	getDefaultValue(ReachableField field)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the default value of the given field.
Collection<String>	getKeyFields(String store)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the key fields of a given store.
int	getType(ReachableField field)	Deprecated, for removal: This API element is subject to removal in a future version. Gets the type of the given field.
Collection<String>	getUnicityFields(String store)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the minimal list of fields that grant the uniqueness of a record when requesting data on given store.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseHelper

public DatabaseHelper(IDatabaseSchemaEntityResolver resolver)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor.

Parameters:

resolver - the database resolver

Method Detail

ensureFieldExists

public void ensureFieldExists(ReachableField field)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IDatabaseHelper

Ensures the given field exists.

Specified by:

ensureFieldExists in interface IDatabaseHelper

Parameters:

field - the field to check

getType

public int getType(ReachableField field)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IDatabaseHelper

Gets the type of the given field.

Specified by:

getType in interface IDatabaseHelper

Parameters:

field - a field

Returns:

the field's type

getDefaultValue

public Object getDefaultValue(ReachableField field)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IDatabaseHelper

Returns the default value of the given field.

Specified by:

getDefaultValue in interface IDatabaseHelper

Parameters:

field - a field

Returns:

the field's type

getUnicityFields

public Collection<String> getUnicityFields(String store)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IDatabaseHelper

Returns the minimal list of fields that grant the uniqueness of a record when requesting data on given store.

For stores having at least one key Field in their description, this list corresponds to the list of key fields. For key-less stores, this list will contains all the store fields.

Specified by:

getUnicityFields in interface IDatabaseHelper

Parameters:

store - the store name

Returns:

The unicity fields of the given store

getKeyFields

public Collection<String> getKeyFields(String store)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: IDatabaseHelper

Returns the key fields of a given store.

Specified by:

getKeyFields in interface IDatabaseHelper

Parameters:

store - the store name

Returns:

The key fields of the given store