com.inubit.research.server.persistence

Interface DatabaseConnector

All Known Implementing Classes:

MySQLDatabaseConnector, PostgreSQLDatabaseConnector, SQLDatabaseConnector

public interface DatabaseConnector

This interface is intended to provide a SQL-indepent interface to databases. Thereby, different database types (e.g. XML-based, document-based) can hopefully be plugged in.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DatabaseConnector.EntityType

Method Summary

Modifier and Type	Method and Description
boolean	addModel(java.io.File file, java.lang.String path, java.lang.String id, SingleUser user, java.lang.String comment) Add a model to the database
int	addModelVersion(java.io.File f, java.lang.String id, SingleUser user, java.lang.String comment, java.lang.String date)
boolean	addUser(SingleUser user) Store the given user in the database
boolean	checkConnection() Check if the connection is alive
void	deleteEntity(DatabaseConnector.EntityType entity, java.lang.Object[] idValues) Delete enitities specified by the given entity type and entity id values.
void	deleteModel(java.lang.String modelId) Delete a model (and all its versions) from the database
void	divestRight(java.lang.String id, AccessType access, User u) Deny access for a specific user to s specific model
java.util.Set<java.lang.String>	getAccessiblePaths(SingleUser user) Get paths that are accessible by the given user
java.util.Set<User>	getAccessors(java.lang.String id, AccessType access) Get a set of users that have a specific type of access to the given model
java.util.Set<ProcessObjectComment>	getComments(java.lang.String modelId, java.lang.String version, java.lang.String elementId) Get all comments for a specific model or modelelement
java.lang.String	getConnectionName() Get the connection's name
java.util.Set<ISLocation>	getISConnections(SingleUser user) Retrieve the ISConnections for the given user
ProcessModel	getModel(java.lang.String id, int version) Retrieve a specific model version
java.util.Map<java.lang.String,AccessType>	getModelsWithAccess(SingleUser user) Retrieve a list of models and the respective access for a given user
int	getModelVersionCount(java.lang.String modelId) Retrieve the number of model versions from the database
void	grantRight(java.lang.String id, AccessType access, User u) Allow access for a specific user to a specific model
void	insertEntity(DatabaseConnector.EntityType entity, DatabaseSchema.Attribute[] attributes, java.lang.Object[] values) Create an entity specified by the given entity type, attributes, and attribute values.
java.lang.Object[]	selectAttributes(DatabaseSchema.Attribute[] attributes, DatabaseConnector.EntityType entity, java.lang.Object[] idValues) Select a set of attributes of an object specified by the gievn entity type and entity id values.
java.util.Set<java.lang.Object>	selectMultiValueSingleAttribute(DatabaseSchema.Attribute attribute, DatabaseConnector.EntityType entity, java.lang.Object[] idValues) Select ALL values for an attribute of an object specified by the given entity type and entity id values.
java.util.Set<java.lang.Object>	selectMultiValueSingleAttributeWithMultipleIDs(DatabaseSchema.Attribute attribute, DatabaseConnector.EntityType entity, java.lang.Object[][] idValues) Select ALL values for an attribute of multiple object specified by the given enitity type and entity ids.
java.util.Set<java.lang.Object>	selectSingleAttribute(DatabaseSchema.Attribute attribute, DatabaseConnector.EntityType entity) Select ALL values for an attribute of the given entity type.
java.lang.Object	selectSingleAttribute(DatabaseSchema.Attribute attribute, DatabaseConnector.EntityType entity, java.lang.Object[] idValues) Select a single attribute value of an object specified by the given entity type and entity id values.
boolean	updateAttribute(DatabaseSchema.Attribute attribute, java.lang.Object value, DatabaseConnector.EntityType entity, java.lang.Object[] idValues) Update an attribute value of an object specified by the gievn entity type and entity id values.

Method Detail

getConnectionName

java.lang.String getConnectionName()

Get the connection's name

Returns:

the name

checkConnection

boolean checkConnection()

Check if the connection is alive

Returns:

true, if connection is alive. false, otherwise.

selectSingleAttribute

java.util.Set<java.lang.Object> selectSingleAttribute(DatabaseSchema.Attribute attribute,
                                                      DatabaseConnector.EntityType entity)

Select ALL values for an attribute of the given entity type.
This is equals to "SELECT FROM " in SQL.

Parameters:

attribute - the attribute

entity - the entity type

Returns:

The set of returned objects

selectSingleAttribute

java.lang.Object selectSingleAttribute(DatabaseSchema.Attribute attribute,
                                       DatabaseConnector.EntityType entity,
                                       java.lang.Object[] idValues)

Select a single attribute value of an object specified by the given entity type and entity id values. Which attributes are used for determining the id is specified by the given entity type.

Parameters:

attribute - the attribute

entity - the entity type

idValues - the values of the id attributes

Returns:

the single attribute value

selectMultiValueSingleAttribute

java.util.Set<java.lang.Object> selectMultiValueSingleAttribute(DatabaseSchema.Attribute attribute,
                                                                DatabaseConnector.EntityType entity,
                                                                java.lang.Object[] idValues)

Select ALL values for an attribute of an object specified by the given entity type and entity id values. Which attributes are used for determining the id is specified by the given entity type.

Parameters:

attribute - the attribute

entity - the entity type

idValues - the values of the id attributes

Returns:

The set of returned object ( = attribute values )

selectMultiValueSingleAttributeWithMultipleIDs

java.util.Set<java.lang.Object> selectMultiValueSingleAttributeWithMultipleIDs(DatabaseSchema.Attribute attribute,
                                                                               DatabaseConnector.EntityType entity,
                                                                               java.lang.Object[][] idValues)

Select ALL values for an attribute of multiple object specified by the given enitity type and entity ids. Which attributes are used for determining the id is specified by the given entity type.

Parameters:

attribute - the attribute

entity - the entity type

idValues - the value sets of the id attributes

Returns:

The set of returned object ( = attribute values )

updateAttribute

boolean updateAttribute(DatabaseSchema.Attribute attribute,
                        java.lang.Object value,
                        DatabaseConnector.EntityType entity,
                        java.lang.Object[] idValues)

Update an attribute value of an object specified by the gievn entity type and entity id values. Which attributes are used for determining the id is specified by the given entity type.

Parameters:

attribute - the attribute

value - the new value

entity - the enitity type

idValues - the values of the id attributes

Returns:

true, if the update has been successful. false, otherwise.

selectAttributes

java.lang.Object[] selectAttributes(DatabaseSchema.Attribute[] attributes,
                                    DatabaseConnector.EntityType entity,
                                    java.lang.Object[] idValues)

Select a set of attributes of an object specified by the gievn entity type and entity id values.

Parameters:

attributes - the attributes that have to be selected

entity - the entity type

idValues - the values of the id attributes

Returns:

the attribute values in the order the attributes have been given

deleteEntity

void deleteEntity(DatabaseConnector.EntityType entity,
                  java.lang.Object[] idValues)

Delete enitities specified by the given entity type and entity id values.

Parameters:

entity - the entity type

idValues - the values of the id attributes

insertEntity

void insertEntity(DatabaseConnector.EntityType entity,
                  DatabaseSchema.Attribute[] attributes,
                  java.lang.Object[] values)

Create an entity specified by the given entity type, attributes, and attribute values.

Parameters:

entity - the entity type

attributes - the attributes

values - the attribute values

getModel

ProcessModel getModel(java.lang.String id,
                      int version)

Retrieve a specific model version

Parameters:

id - the model id

version - the version number. Be aware that due to the SQL AUTO_INCREMENT construct versions are assumed to start with number 1, NOT 0

Returns:

the model

getModelsWithAccess

java.util.Map<java.lang.String,AccessType> getModelsWithAccess(SingleUser user)

Retrieve a list of models and the respective access for a given user

Parameters:

user - the user

Returns:

a map of model ids to access types

getAccessiblePaths

java.util.Set<java.lang.String> getAccessiblePaths(SingleUser user)

Get paths that are accessible by the given user

Parameters:

user - the user

Returns:

the paths

addModel

boolean addModel(java.io.File file,
                 java.lang.String path,
                 java.lang.String id,
                 SingleUser user,
                 java.lang.String comment)

Add a model to the database

Parameters:

file - the file containing the model

path - the path of the model

id - the model id

user - the user that commited the model

comment - the commit message

Returns:

true, if model was successfully saved. false, otherwise

addModelVersion

int addModelVersion(java.io.File f,
                    java.lang.String id,
                    SingleUser user,
                    java.lang.String comment,
                    java.lang.String date)
             throws java.sql.SQLException,
                    java.io.IOException

Parameters:

f - the file containing the new model version

id - the model id

user - the commiting user

comment - the commit message

date - the creation date

Returns:

the model version number

Throws:

java.sql.SQLException - if an error occured while saving to the database

java.io.IOException - if an error occured while reading the file

getModelVersionCount

int getModelVersionCount(java.lang.String modelId)

Retrieve the number of model versions from the database

Parameters:

modelId - the model id

Returns:

the version count

deleteModel

void deleteModel(java.lang.String modelId)

Delete a model (and all its versions) from the database

Parameters:

modelId - the model id

grantRight

void grantRight(java.lang.String id,
                AccessType access,
                User u)

Allow access for a specific user to a specific model

Parameters:

id - the model id

access - the access type

u - the user

divestRight

void divestRight(java.lang.String id,
                 AccessType access,
                 User u)

Deny access for a specific user to s specific model

Parameters:

id - the model od

access - the access type

u - the user

getAccessors

java.util.Set<User> getAccessors(java.lang.String id,
                                 AccessType access)

Get a set of users that have a specific type of access to the given model

Parameters:

id - the model id

access - the access type

Returns:

the set of users

addUser

boolean addUser(SingleUser user)

Store the given user in the database

Parameters:

user - the user

Returns:

true, if storing the user has been sucessful

getISConnections

java.util.Set<ISLocation> getISConnections(SingleUser user)

Retrieve the ISConnections for the given user

Parameters:

user - the user

Returns:

the set of ISConnections

getComments

java.util.Set<ProcessObjectComment> getComments(java.lang.String modelId,
                                                java.lang.String version,
                                                java.lang.String elementId)

Get all comments for a specific model or modelelement

Parameters:

modelId - the model id

version - the version number

elementId - the element id. Use 'model' to look up model comments.

Returns:

the set of comments

Skip navigation links

• Overview
• Package
• Class
• Tree
• Deprecated
• Index
• Help

• Prev Class
• Next Class

• Frames
• No Frames

• All Classes

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method