org.visallo.core.model.workspace

Class WorkspaceRepository

java.lang.Object

org.visallo.core.model.workspace.WorkspaceRepository

public abstract class WorkspaceRepository
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkspaceRepository.Update
static class	WorkspaceRepository.UpdateUserOnWorkspaceResult

Field Summary

Fields

Modifier and Type	Field and Description
static String	OWL_IRI
static String	TO_ENTITY_ID_SEPARATOR
static VisalloVisibility	VISIBILITY
static String	VISIBILITY_STRING
static String	WORKSPACE_CONCEPT_IRI
static String	WORKSPACE_ID_PREFIX
static String	WORKSPACE_TO_ENTITY_RELATIONSHIP_IRI
static String	WORKSPACE_TO_USER_RELATIONSHIP_IRI

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkspaceRepository(org.vertexium.Graph graph, VisibilityTranslator visibilityTranslator, TermMentionRepository termMentionRepository, OntologyRepository ontologyRepository, WorkQueueRepository workQueueRepository, UserRepository userRepository)

Method Summary

Modifier and Type	Method and Description
abstract Workspace	add(String workspaceId, String title, User user)
Workspace	add(String title, User user)
abstract String	addOrUpdateDashboard(String workspaceId, String dashboardId, String title, User user)
abstract String	addOrUpdateDashboardItem(String workspaceId, String dashboardId, String dashboardItemId, String title, String configuration, String extensionId, User user)
Workspace	copy(Workspace workspace, User user)
Workspace	copyTo(Workspace workspace, User destinationUser, User user)
abstract void	delete(Workspace workspace, User user)
abstract void	deleteDashboard(String workspaceId, String dashboardId, User user)
abstract void	deleteDashboardItem(String workspaceId, String dashboardItemId, User user)
abstract void	deleteUserFromWorkspace(Workspace workspace, String userId, User user)
abstract Iterable<Workspace>	findAll(User user) Finds all workspaces irregardless of access.
abstract Collection<Dashboard>	findAllDashboardsForWorkspace(String workspaceId, User user)
abstract Iterable<Workspace>	findAllForUser(User user) Finds all workspaces the given user has access to.
abstract Workspace	findById(String workspaceId, boolean includeHidden, User user)
Workspace	findById(String workspaceId, User user)
Iterable<Workspace>	findByIds(Iterable<String> workspaceIds, User user)
abstract Dashboard	findDashboardById(String workspaceId, String dashboardId, User user)
abstract DashboardItem	findDashboardItemById(String workspaceId, String dashboardItemId, User user)
abstract List<WorkspaceEntity>	findEntities(Workspace workspace, boolean fetchVertices, User user)
List<WorkspaceEntity>	findEntities(Workspace workspace, User user)
List<String>	findEntityVertexIds(Workspace workspace, User user)
protected Iterable<org.vertexium.Edge>	findModifiedEdges(Workspace workspace, List<WorkspaceEntity> workspaceEntities, boolean includeHidden, User user)
abstract List<WorkspaceUser>	findUsersWithAccess(String workspaceId, User user)
String	getCreatorUserId(String workspaceId, User user)
abstract ClientApiWorkspaceDiff	getDiff(Workspace workspace, User user, Locale locale, String timeZone)
protected org.vertexium.Graph	getGraph()
protected OntologyRepository	getOntologyRepository()
protected TermMentionRepository	getTermMentionRepository()
protected UserRepository	getUserRepository()
protected VisibilityTranslator	getVisibilityTranslator()
protected WorkQueueRepository	getWorkQueueRepository()
static String	getWorkspaceToEntityEdgeId(String workspaceVertexId, String entityVertexId)
abstract boolean	hasCommentPermissions(String workspaceId, User user)
abstract boolean	hasReadPermissions(String workspaceId, User user)
abstract boolean	hasWritePermissions(String workspaceId, User user)
ClientApiWorkspacePublishResponse	publish(ClientApiPublishItem[] publishData, String workspaceId, org.vertexium.Authorizations authorizations)
abstract void	setTitle(Workspace workspace, String title, User user)
abstract void	softDeleteEntitiesFromWorkspace(Workspace workspace, List<String> entityIdsToDelete, User authUser)
ClientApiWorkspace	toClientApi(Workspace workspace, User user, boolean includeVertices, org.vertexium.Authorizations authorizations)
org.json.JSONArray	toJson(Iterable<Workspace> workspaces, User user, boolean includeVertices)
org.json.JSONObject	toJson(Workspace workspace, User user, boolean includeVertices)
abstract void	updateEntitiesOnWorkspace(Workspace workspace, Collection<WorkspaceRepository.Update> updates, User user)
void	updateEntityOnWorkspace(String workspaceId, String vertexId, Boolean visible, GraphPosition graphPosition, User user)
void	updateEntityOnWorkspace(Workspace workspace, String vertexId, Boolean visible, GraphPosition graphPosition, User user)
void	updateEntityOnWorkspace(Workspace workspace, WorkspaceRepository.Update update, User user)
abstract WorkspaceRepository.UpdateUserOnWorkspaceResult	updateUserOnWorkspace(Workspace workspace, String userId, WorkspaceAccess workspaceAccess, User user)

Methods inherited from class java.lang.Object

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

Field Detail

TO_ENTITY_ID_SEPARATOR

public static final String TO_ENTITY_ID_SEPARATOR

See Also:

Constant Field Values

VISIBILITY_STRING

public static final String VISIBILITY_STRING

See Also:

Constant Field Values

VISIBILITY

public static final VisalloVisibility VISIBILITY

WORKSPACE_CONCEPT_IRI

public static final String WORKSPACE_CONCEPT_IRI

See Also:

Constant Field Values

WORKSPACE_TO_ENTITY_RELATIONSHIP_IRI

public static final String WORKSPACE_TO_ENTITY_RELATIONSHIP_IRI

See Also:

Constant Field Values

WORKSPACE_TO_USER_RELATIONSHIP_IRI

public static final String WORKSPACE_TO_USER_RELATIONSHIP_IRI

See Also:

Constant Field Values

WORKSPACE_ID_PREFIX

public static final String WORKSPACE_ID_PREFIX

See Also:

Constant Field Values

OWL_IRI

public static final String OWL_IRI

See Also:

Constant Field Values

Constructor Detail

WorkspaceRepository

protected WorkspaceRepository(org.vertexium.Graph graph,
                              VisibilityTranslator visibilityTranslator,
                              TermMentionRepository termMentionRepository,
                              OntologyRepository ontologyRepository,
                              WorkQueueRepository workQueueRepository,
                              UserRepository userRepository)

Method Detail

getWorkspaceToEntityEdgeId

public static String getWorkspaceToEntityEdgeId(String workspaceVertexId,
                                                String entityVertexId)

delete

public abstract void delete(Workspace workspace,
                            User user)

findById

public Workspace findById(String workspaceId,
                          User user)

findById

public abstract Workspace findById(String workspaceId,
                                   boolean includeHidden,
                                   User user)

findByIds

public Iterable<Workspace> findByIds(Iterable<String> workspaceIds,
                                     User user)

add

public abstract Workspace add(String workspaceId,
                              String title,
                              User user)

add

public Workspace add(String title,
                     User user)

findAllForUser

public abstract Iterable<Workspace> findAllForUser(User user)

Finds all workspaces the given user has access to. Including workspaces shared to that user.

findAll

public abstract Iterable<Workspace> findAll(User user)

Finds all workspaces irregardless of access.

Parameters:

user - a user with access to all workspaces such as system user.

setTitle

public abstract void setTitle(Workspace workspace,
                              String title,
                              User user)

findUsersWithAccess

public abstract List<WorkspaceUser> findUsersWithAccess(String workspaceId,
                                                        User user)

findEntities

public List<WorkspaceEntity> findEntities(Workspace workspace,
                                          User user)

findEntities

public abstract List<WorkspaceEntity> findEntities(Workspace workspace,
                                                   boolean fetchVertices,
                                                   User user)

copy

public Workspace copy(Workspace workspace,
                      User user)

copyTo

public Workspace copyTo(Workspace workspace,
                        User destinationUser,
                        User user)

softDeleteEntitiesFromWorkspace

public abstract void softDeleteEntitiesFromWorkspace(Workspace workspace,
                                                     List<String> entityIdsToDelete,
                                                     User authUser)

deleteUserFromWorkspace

public abstract void deleteUserFromWorkspace(Workspace workspace,
                                             String userId,
                                             User user)

updateUserOnWorkspace

public abstract WorkspaceRepository.UpdateUserOnWorkspaceResult updateUserOnWorkspace(Workspace workspace,
                                                                                      String userId,
                                                                                      WorkspaceAccess workspaceAccess,
                                                                                      User user)

getDiff

public abstract ClientApiWorkspaceDiff getDiff(Workspace workspace,
                                               User user,
                                               Locale locale,
                                               String timeZone)

getCreatorUserId

public String getCreatorUserId(String workspaceId,
                               User user)

hasCommentPermissions

public abstract boolean hasCommentPermissions(String workspaceId,
                                              User user)

hasWritePermissions

public abstract boolean hasWritePermissions(String workspaceId,
                                            User user)

hasReadPermissions

public abstract boolean hasReadPermissions(String workspaceId,
                                           User user)

toJson

public org.json.JSONArray toJson(Iterable<Workspace> workspaces,
                                 User user,
                                 boolean includeVertices)

toJson

public org.json.JSONObject toJson(Workspace workspace,
                                  User user,
                                  boolean includeVertices)

toClientApi

public ClientApiWorkspace toClientApi(Workspace workspace,
                                      User user,
                                      boolean includeVertices,
                                      org.vertexium.Authorizations authorizations)

getGraph

protected org.vertexium.Graph getGraph()

updateEntitiesOnWorkspace

public abstract void updateEntitiesOnWorkspace(Workspace workspace,
                                               Collection<WorkspaceRepository.Update> updates,
                                               User user)

updateEntityOnWorkspace

public void updateEntityOnWorkspace(Workspace workspace,
                                    WorkspaceRepository.Update update,
                                    User user)

updateEntityOnWorkspace

public void updateEntityOnWorkspace(Workspace workspace,
                                    String vertexId,
                                    Boolean visible,
                                    GraphPosition graphPosition,
                                    User user)

updateEntityOnWorkspace

public void updateEntityOnWorkspace(String workspaceId,
                                    String vertexId,
                                    Boolean visible,
                                    GraphPosition graphPosition,
                                    User user)

publish

public ClientApiWorkspacePublishResponse publish(ClientApiPublishItem[] publishData,
                                                 String workspaceId,
                                                 org.vertexium.Authorizations authorizations)

findEntityVertexIds

public List<String> findEntityVertexIds(Workspace workspace,
                                        User user)

findModifiedEdges

protected Iterable<org.vertexium.Edge> findModifiedEdges(Workspace workspace,
                                                         List<WorkspaceEntity> workspaceEntities,
                                                         boolean includeHidden,
                                                         User user)

findDashboardById

public abstract Dashboard findDashboardById(String workspaceId,
                                            String dashboardId,
                                            User user)

deleteDashboard

public abstract void deleteDashboard(String workspaceId,
                                     String dashboardId,
                                     User user)

findAllDashboardsForWorkspace

public abstract Collection<Dashboard> findAllDashboardsForWorkspace(String workspaceId,
                                                                    User user)

findDashboardItemById

public abstract DashboardItem findDashboardItemById(String workspaceId,
                                                    String dashboardItemId,
                                                    User user)

deleteDashboardItem

public abstract void deleteDashboardItem(String workspaceId,
                                         String dashboardItemId,
                                         User user)

getVisibilityTranslator

protected VisibilityTranslator getVisibilityTranslator()

getTermMentionRepository

protected TermMentionRepository getTermMentionRepository()

getOntologyRepository

protected OntologyRepository getOntologyRepository()

getWorkQueueRepository

protected WorkQueueRepository getWorkQueueRepository()

getUserRepository

protected UserRepository getUserRepository()

addOrUpdateDashboardItem

public abstract String addOrUpdateDashboardItem(String workspaceId,
                                                String dashboardId,
                                                String dashboardItemId,
                                                String title,
                                                String configuration,
                                                String extensionId,
                                                User user)

addOrUpdateDashboard

public abstract String addOrUpdateDashboard(String workspaceId,
                                            String dashboardId,
                                            String title,
                                            User user)