com.inubit.research.server.manager

Interface Location

All Known Implementing Classes:

DatabaseLocation, FileSystemLocation, ISLocation

public interface Location

Interface for different model locations / repository parts

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Location.LocationType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SHARED_PATH_PREFIX

Method Summary

Modifier and Type	Method and Description
boolean	checkConnection() Checks if this location is currently available.
ServerModel	createNewModel(java.io.File model, java.lang.String path, java.lang.String id, SingleUser user, java.lang.String comment) Create new model
java.lang.String	getAtticPath(SingleUser user) Get path to the attic directory
java.util.Map<java.lang.String,java.util.List<ServerModel>>	getIndex(java.util.Set<java.lang.String> usedIDs, boolean forceRefresh) Get index of this location.
MetaDataHandler	getMetaDataHandler() Get meta data handler for this location
java.util.Map<java.lang.String,AccessType>	getModelsForUser(SingleUser user) Get all models belonging to a certain user withing this location
java.lang.String	getName() Get this location's name
Location.LocationType	getType() Get the type of this location
java.util.Set<java.lang.String>	listPaths() Get all paths belonging to this location
java.util.Set<java.lang.String>	listPaths(SingleUser user) Get all paths belonging to a certain user within this location
boolean	removeModel(java.lang.String id, SingleUser user) Remove a certain model

Field Detail

SHARED_PATH_PREFIX

static final java.lang.String SHARED_PATH_PREFIX

See Also:

Constant Field Values

Method Detail

checkConnection

boolean checkConnection()

Checks if this location is currently available.

Returns:

removeModel

boolean removeModel(java.lang.String id,
                    SingleUser user)

Remove a certain model

Parameters:

id - the model id

user - the user that requested the deletion

Returns:

• true, if the model can be physically deleted
• false, if the model should only be moved to some location where it resides until physical deletion

getAtticPath

java.lang.String getAtticPath(SingleUser user)

Get path to the attic directory

Parameters:

user - the user

Returns:

the path

getIndex

java.util.Map<java.lang.String,java.util.List<ServerModel>> getIndex(java.util.Set<java.lang.String> usedIDs,
                                                                     boolean forceRefresh)

Get index of this location.

Returns:

the index mapping IDs to lists of model versions

getMetaDataHandler

MetaDataHandler getMetaDataHandler()

Get meta data handler for this location

Returns:

the meta data handler

getType

Location.LocationType getType()

Get the type of this location

Returns:

the type

getName

java.lang.String getName()

Get this location's name

Returns:

the name

listPaths

java.util.Set<java.lang.String> listPaths()

Get all paths belonging to this location

listPaths

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

Get all paths belonging to a certain user within this location

Parameters:

user - the user

Returns:

the list of paths

getModelsForUser

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

Get all models belonging to a certain user withing this location

Parameters:

user - the user

Returns:

a map of model IDs and access types

createNewModel

ServerModel createNewModel(java.io.File model,
                           java.lang.String path,
                           java.lang.String id,
                           SingleUser user,
                           java.lang.String comment)

Create new model