systems.dmx.core.service

Interface CoreService

Show UML class diagram

All Known Implementing Classes:

CoreServiceImpl

public interface CoreService

Specification of the DMX core service -- the heart of DMX.

The responsibility of the DMX core service is to orchestrate the control flow and allow plugins to hook in. The main duties of the DMX core service are to provide access to the storage layer and to dispatch events to the installed plugins. ### FIXDOC

The DMX core service is a realization of the Inversion of Control pattern.

The DMX core service provides methods to deal with topics, associations, types, and plugins.

Plugin developer notes: Inside the PluginActivator and Migration classes an instance of the DMX core service is available through the dmx object.

Method Summary

Modifier and Type	Method and Description
void	addAssociationPropertyIndex(String propUri)
void	addTopicPropertyIndex(String propUri)
DMXTransaction	beginTx()
Association	createAssociation(AssociationModel model)
AssociationType	createAssociationType(AssociationTypeModel model)
Topic	createRoleType(TopicModel model)
Topic	createTopic(TopicModel model)
TopicType	createTopicType(TopicTypeModel model)
void	deleteAssociation(long assocId)
void	deleteAssociationType(String assocTypeUri)
void	deleteTopic(long topicId)
void	deleteTopicType(String topicTypeUri)
void	dispatchEvent(String pluginUri, DMXEvent event, Object... params)
void	fireEvent(DMXEvent event, Object... params)
AccessControl	getAccessControl()
Iterable<Association>	getAllAssociations()
List<AssociationType>	getAllAssociationTypes()
Iterable<Topic>	getAllTopics()
List<TopicType>	getAllTopicTypes()
Association	getAssociation(long assocId)
Association	getAssociation(String assocTypeUri, long topic1Id, long topic2Id, String roleTypeUri1, String roleTypeUri2) Returns the association between two topics, qualified by association type and both role types.
Association	getAssociationBetweenTopicAndAssociation(String assocTypeUri, long topicId, long assocId, String topicRoleTypeUri, String assocRoleTypeUri)
Association	getAssociationByValue(String key, SimpleValue value) Looks up a single association by exact value.
List<Association>	getAssociations(long topic1Id, long topic2Id) Returns all associations between two topics.
List<Association>	getAssociations(long topic1Id, long topic2Id, String assocTypeUri) Returns the associations between two topics.
List<Association>	getAssociationsByProperty(String propUri, Object propValue)
List<Association>	getAssociationsByPropertyRange(String propUri, Number from, Number to)
List<Association>	getAssociationsByType(String assocTypeUri)
List<Association>	getAssociationsByValue(String key, SimpleValue value) Looks up associations by key and value.
AssociationType	getAssociationType(String assocTypeUri)
AssociationType	getAssociationTypeImplicitly(long assocId) Acccesses an association type while enforcing the implicit READ permission.
Object	getDatabaseVendorObject()
ModelFactory	getModelFactory()
DMXObject	getObject(long id)
long[]	getPlayerIds(long assocId)
Plugin	getPlugin(String pluginUri)
List<PluginInfo>	getPluginInfo()
Object	getProperty(long id, String propUri) Returns a topic's or association's property value associated with the given property URI.
Topic	getTopic(long topicId) Accesses a topic by ID.
Topic	getTopicByUri(String uri) Accesses a topic by URI.
Topic	getTopicByValue(String key, SimpleValue value) Looks up a single topic by exact value.
List<Topic>	getTopicsByProperty(String propUri, Object propValue)
List<Topic>	getTopicsByPropertyRange(String propUri, Number from, Number to)
List<Topic>	getTopicsByType(String topicTypeUri)
List<Topic>	getTopicsByValue(String key, SimpleValue value) Looks up topics by key and value.
TopicType	getTopicType(String topicTypeUri)
TopicType	getTopicTypeImplicitly(long topicId) Acccesses a topic type while enforcing the implicit READ permission.
WebSocketsService	getWebSocketsService()
boolean	hasProperty(long id, String propUri) Checks whether for a given topic or association a property value is associated with a given property URI.
List<Topic>	searchTopics(String searchTerm, String fieldUri) Performs a fulltext search.
void	updateAssociation(AssociationModel updateModel)
void	updateAssociationType(AssociationTypeModel updateModel)
void	updateTopic(TopicModel updateModel)
void	updateTopicType(TopicTypeModel updateModel)

Method Detail

getTopic

Topic getTopic(long topicId)

Accesses a topic by ID.

Returns:

the topic.

Throws:

RuntimeException - if no such topic exists.

getTopicByUri

Topic getTopicByUri(String uri)

Accesses a topic by URI.

Returns:

the topic, or null if no such topic exists.

getTopicByValue

Topic getTopicByValue(String key,
                      SimpleValue value)

Looks up a single topic by exact value.

Note: wildcards like "*" in String values are not interpreted. They are treated literally. Compare to getTopicsByValue(String,SimpleValue)

IMPORTANT: Looking up a topic this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

Returns:

the topic, or null if no such topic exists.

Throws:

RuntimeException - If more than one topic is found.

getTopicsByValue

List<Topic> getTopicsByValue(String key,
                             SimpleValue value)

Looks up topics by key and value.

Wildcards like "*" in String values are interpreted.

IMPORTANT: Looking up topics this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

getTopicsByType

List<Topic> getTopicsByType(String topicTypeUri)

searchTopics

List<Topic> searchTopics(String searchTerm,
                         String fieldUri)

Performs a fulltext search.

IMPORTANT: Searching topics this way requires the corresponding type to be indexed with indexing mode dmx.core.fulltext or dmx.core.fulltext_key. ### FIXDOC

Parameters:

fieldUri - The URI of the data field to search. If null is provided all fields are searched. ### FIXDOC ### TODO: rename parameter to "key"/"typeUri"?

getAllTopics

Iterable<Topic> getAllTopics()

createTopic

Topic createTopic(TopicModel model)

updateTopic

void updateTopic(TopicModel updateModel)

deleteTopic

void deleteTopic(long topicId)

getAssociation

Association getAssociation(long assocId)

getAssociationByValue

Association getAssociationByValue(String key,
                                  SimpleValue value)

Looks up a single association by exact value.

Note: wildcards like "*" in String values are not interpreted. They are treated literally. Compare to getAssociationsByValue(String,SimpleValue)

IMPORTANT: Looking up an association this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

Returns:

the association, or null if no such association exists.

Throws:

RuntimeException - If more than one association is found.

getAssociationsByValue

List<Association> getAssociationsByValue(String key,
                                         SimpleValue value)

Looks up associations by key and value.

Wildcards like "*" in String values are interpreted.

IMPORTANT: Looking up associations this way requires the corresponding type to be indexed with indexing mode dmx.core.key.

getAssociation

Association getAssociation(String assocTypeUri,
                           long topic1Id,
                           long topic2Id,
                           String roleTypeUri1,
                           String roleTypeUri2)

Returns the association between two topics, qualified by association type and both role types. If no such association exists null is returned. If more than one association exist, a runtime exception is thrown.

Parameters:

assocTypeUri - Association type filter. Pass null to switch filter off.

getAssociationBetweenTopicAndAssociation

Association getAssociationBetweenTopicAndAssociation(String assocTypeUri,
                                                     long topicId,
                                                     long assocId,
                                                     String topicRoleTypeUri,
                                                     String assocRoleTypeUri)

getAssociationsByType

List<Association> getAssociationsByType(String assocTypeUri)

getAssociations

List<Association> getAssociations(long topic1Id,
                                  long topic2Id)

Returns all associations between two topics. If no such association exists an empty list is returned.

getAssociations

List<Association> getAssociations(long topic1Id,
                                  long topic2Id,
                                  String assocTypeUri)

Returns the associations between two topics. If no such association exists an empty list is returned.

Parameters:

assocTypeUri - Association type filter. Pass null to switch filter off.

getAllAssociations

Iterable<Association> getAllAssociations()

getPlayerIds

long[] getPlayerIds(long assocId)

createAssociation

Association createAssociation(AssociationModel model)

updateAssociation

void updateAssociation(AssociationModel updateModel)

deleteAssociation

void deleteAssociation(long assocId)

getTopicType

TopicType getTopicType(String topicTypeUri)

getTopicTypeImplicitly

TopicType getTopicTypeImplicitly(long topicId)

Acccesses a topic type while enforcing the implicit READ permission. A user has implicit READ permission for the topic type if she has READ permission for the given topic.

getAllTopicTypes

List<TopicType> getAllTopicTypes()

createTopicType

TopicType createTopicType(TopicTypeModel model)

updateTopicType

void updateTopicType(TopicTypeModel updateModel)

deleteTopicType

void deleteTopicType(String topicTypeUri)

getAssociationType

AssociationType getAssociationType(String assocTypeUri)

getAssociationTypeImplicitly

AssociationType getAssociationTypeImplicitly(long assocId)

Acccesses an association type while enforcing the implicit READ permission. A user has implicit READ permission for the association type if she has READ permission for the given association.

getAllAssociationTypes

List<AssociationType> getAllAssociationTypes()

createAssociationType

AssociationType createAssociationType(AssociationTypeModel model)

updateAssociationType

void updateAssociationType(AssociationTypeModel updateModel)

deleteAssociationType

void deleteAssociationType(String assocTypeUri)

createRoleType

Topic createRoleType(TopicModel model)

getObject

DMXObject getObject(long id)

getPlugin

Plugin getPlugin(String pluginUri)

getPluginInfo

List<PluginInfo> getPluginInfo()

fireEvent

void fireEvent(DMXEvent event,
               Object... params)

dispatchEvent

void dispatchEvent(String pluginUri,
                   DMXEvent event,
                   Object... params)

getProperty

Object getProperty(long id,
                   String propUri)

Returns a topic's or association's property value associated with the given property URI. If there's no property value associated with the property URI an exception is thrown.

Parameters:

id - a topic ID, or an association ID

hasProperty

boolean hasProperty(long id,
                    String propUri)

Checks whether for a given topic or association a property value is associated with a given property URI.

Parameters:

id - a topic ID, or an association ID

getTopicsByProperty

List<Topic> getTopicsByProperty(String propUri,
                                Object propValue)

getTopicsByPropertyRange

List<Topic> getTopicsByPropertyRange(String propUri,
                                     Number from,
                                     Number to)

getAssociationsByProperty

List<Association> getAssociationsByProperty(String propUri,
                                            Object propValue)

getAssociationsByPropertyRange

List<Association> getAssociationsByPropertyRange(String propUri,
                                                 Number from,
                                                 Number to)

addTopicPropertyIndex

void addTopicPropertyIndex(String propUri)

addAssociationPropertyIndex

void addAssociationPropertyIndex(String propUri)

beginTx

DMXTransaction beginTx()

getModelFactory

ModelFactory getModelFactory()

getAccessControl

AccessControl getAccessControl()

getWebSocketsService

WebSocketsService getWebSocketsService()

getDatabaseVendorObject

Object getDatabaseVendorObject()