|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DeepaMehtaService
Specification of the DeepaMehta core service -- the heart of DeepaMehta.
The responsibility of the DeepaMehta core service is to orchestrate the control flow and allow plugins to hook in. The main duties of the DeepaMehta core service are to provide access to the storage layer and to deliver events to the installed plugins. ### FIXDOC
The DeepaMehta core service is a realization of the Inversion of Control pattern.
The DeepaMehta 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
DeepaMehta core service is available through the dms
object.
Method Detail |
---|
Topic getTopic(long id, boolean fetchComposite)
Topic getTopic(String key, SimpleValue value, boolean fetchComposite)
null
is returned.
If more than one topic is found a runtime exception is thrown.
IMPORTANT: Looking up a topic this way requires the corresponding type to be indexed with indexing mode
dm4.core.key
.
List<Topic> getTopics(String key, SimpleValue value, boolean fetchComposite)
IMPORTANT: Looking up topics this way requires the corresponding type to be indexed with indexing mode
dm4.core.key
.
ResultList<RelatedTopic> getTopics(String topicTypeUri, boolean fetchComposite, int maxResultSize)
List<Topic> searchTopics(String searchTerm, String fieldUri)
IMPORTANT: Searching topics this way requires the corresponding type to be indexed with indexing mode
dm4.core.fulltext
or dm4.core.fulltext_key
.
fieldUri
- The URI of the data field to search. If null is provided all fields are searched. ### FIXDOCIterable<Topic> getAllTopics()
Topic createTopic(TopicModel model, ClientState clientState)
Directives updateTopic(TopicModel model, ClientState clientState)
Directives deleteTopic(long topicId)
Association getAssociation(long assocId, boolean fetchComposite)
Association getAssociation(String assocTypeUri, long topic1Id, long topic2Id, String roleTypeUri1, String roleTypeUri2, boolean fetchComposite)
null
is returned.
If more than one association exist, a runtime exception is thrown.
assocTypeUri
- Association type filter. Pass null
to switch filter off.Association getAssociationBetweenTopicAndAssociation(String assocTypeUri, long topicId, long assocId, String topicRoleTypeUri, String assocRoleTypeUri, boolean fetchComposite)
List<RelatedAssociation> getAssociations(String assocTypeUri)
List<Association> getAssociations(long topic1Id, long topic2Id)
List<Association> getAssociations(long topic1Id, long topic2Id, String assocTypeUri)
assocTypeUri
- Association type filter. Pass null
to switch filter off.Iterable<Association> getAllAssociations()
Association createAssociation(AssociationModel model, ClientState clientState)
Directives updateAssociation(AssociationModel model, ClientState clientState)
Directives deleteAssociation(long assocId)
List<String> getTopicTypeUris()
TopicType getTopicType(String topicTypeUri)
List<TopicType> getAllTopicTypes()
TopicType createTopicType(TopicTypeModel model, ClientState clientState)
Directives updateTopicType(TopicTypeModel model, ClientState clientState)
List<String> getAssociationTypeUris()
AssociationType getAssociationType(String assocTypeUri)
List<AssociationType> getAllAssociationTypes()
AssociationType createAssociationType(AssociationTypeModel model, ClientState clientState)
Directives updateAssociationType(AssociationTypeModel model, ClientState clientState)
Plugin getPlugin(String pluginUri)
List<PluginInfo> getPluginInfo()
List<Topic> getTopicsByProperty(String propUri, Object propValue)
List<Topic> getTopicsByPropertyRange(String propUri, Number from, Number to)
List<Association> getAssociationsByProperty(String propUri, Object propValue)
List<Association> getAssociationsByPropertyRange(String propUri, Number from, Number to)
DeepaMehtaTransaction beginTx()
TypeStorage getTypeStorage()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |