Interface Layer
- All Superinterfaces:
Comparable<Layer>
FirstSpirit Database Layer.
- Since:
- 3.0.86
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String[]
JDBC parameters used in the database layer. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all layer parameters.getLayerByClassName
(String className) Return the layer from typeclassName
.getLayerById
(String id) Return the layer with the givenid
seeLayer.getId()
.Object[]
Return an array of all available layer ids in the system (array elements are of typejava.lang.String
).getName()
Returns the name of the database layer.getParameter
(String name) Returns the value of a specific parameter.Returns a list of the layer parameter names.Returns a map of all layer parameters.Return the database schema name defined for this layer.boolean
A DBA (database administration) layer is a layer which creates a db-schema in the database for eachFirstSpirit schema
.void
removeParameter
(String name) Removes the specified layer parameter.void
setParameter
(String name, String value) Setter for layer parameter.Methods inherited from interface java.lang.Comparable
compareTo
-
Field Details
-
JDBC_PARAMETERS
JDBC parameters used in the database layer.- Since:
- 4.0
-
-
Method Details
-
getName
String getName()Returns the name of the database layer.- Returns:
- the name of the database layer.
- Since:
- 3.0.86
-
getParameterNames
Returns a list of the layer parameter names.- Returns:
- the list of parameter names.
- Since:
- 3.0.86
-
getParameter
Returns the value of a specific parameter.- Parameters:
name
- the name of the parameter to get the value from.- Returns:
- the value of the parameter.
- Since:
- 3.0.86
-
setParameter
Setter for layer parameter.- Parameters:
name
- the name of the new parameter.value
- the value of the new parameter.- Since:
- 3.0.86
-
clear
void clear()Removes all layer parameters.- Since:
- 3.0.86
-
removeParameter
Removes the specified layer parameter.- Parameters:
name
- the name of the parameter to remove.- Since:
- 3.0.86
-
getParameters
Returns a map of all layer parameters.- Returns:
- a map of all layer parameters.
- Since:
- 4.0
-
getLayerByClassName
Return the layer from typeclassName
.- Since:
- 4.0
-
getLayerById
- Since:
- 4.0
-
getLayerIds
Object[] getLayerIds()Return an array of all available layer ids in the system (array elements are of typejava.lang.String
).- Since:
- 4.0
-
getSchema
Return the database schema name defined for this layer. ADBA layer
has no database schema name asseigned.- Since:
- 4.0
- See Also:
-
isDbaLayer
boolean isDbaLayer()A DBA (database administration) layer is a layer which creates a db-schema in the database for eachFirstSpirit 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:
-