de.espirit.firstspirit.access.database

Interface Layer

All Superinterfaces:

Comparable<Layer>

public interface Layer
extends Comparable<Layer>

Since:

3.0.86

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	JDBC_PARAMETERS

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
Layer	getLayerByClassName(String className) Return the layer from type className.
Layer	getLayerById(String id) Return the layer with the given id see Layer.getId().
Object[]	getLayerIds() Return an array of all available layer ids in the system (array elements are of type java.lang.String).
String	getName()
String	getParameter(String name)
List<String>	getParameterNames()
Map<String,String>	getParameters()
String	getSchema() Return the database schema name defined for this layer.
boolean	isDbaLayer() A DBA (database administration) layer is a layer which creates a db-schema in the database for each FirstSpirit schema.
void	removeParameter(String name)
void	setParameter(String name, String value)

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

JDBC_PARAMETERS

static final String[] JDBC_PARAMETERS

Since:

4.0

Method Detail

getName

String getName()

Since:

3.0.86

getParameterNames

List<String> getParameterNames()

Since:

3.0.86

getParameter

String getParameter(String name)

Since:

3.0.86

setParameter

void setParameter(String name,
                String value)

Since:

3.0.86

clear

void clear()

Since:

3.0.86

removeParameter

void removeParameter(String name)

Since:

3.0.86

getParameters

Map<String,String> getParameters()

Since:

4.0

getLayerByClassName

Layer getLayerByClassName(String className)

Return the layer from type className.

Since:

4.0

getLayerById

Layer getLayerById(String id)

Return the layer with the given id see Layer.getId(). Returns null for an unknown id.

Since:

4.0

getLayerIds

Object[] getLayerIds()

Return an array of all available layer ids in the system (array elements are of type java.lang.String).

Since:

4.0

getSchema

@Nullable
String getSchema()

Return the database schema name defined for this layer. A DBA layer has no database schema name asseigned.

Since:

4.0

See Also:

isDbaLayer()

isDbaLayer

boolean isDbaLayer()

A DBA (database administration) layer is a layer which creates a db-schema in the database for each FirstSpirit schema. A layer which is no DBA layer could be used only once in write mode - violations are configuration failures and can lead to unexpected behaviour.

Returns:

true if this schema is a database administration layer.

Since:

4.2.34

See Also:

getSchema()