systems.dmx.core.impl

Class StorageDecorator

Show UML class diagram

java.lang.Object

systems.dmx.core.impl.StorageDecorator

Direct Known Subclasses:

PersistenceLayer

class StorageDecorator
extends Object

A thin convenience layer above vendor specific storage. 2 responsibilites: - Adapts public storage API to Core internal API (type casting). - Adds fetch-single calls on top of fetch-multiple calls and performs sanity checks.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	logger
private DMXStorage	storage

Constructor Summary

Constructors

Constructor and Description
StorageDecorator(DMXStorage storage)

Method Summary

Modifier and Type	Method and Description
(package private) void	_deleteAssociation(long assocId)
(package private) void	_deleteTopic(long topicId) Deletes the topic.
(package private) DMXTransaction	beginTx()
(package private) Iterator<AssociationModelImpl>	fetchAllAssociations()
(package private) Iterator<TopicModelImpl>	fetchAllTopics()
(package private) AssociationModelImpl	fetchAssociation(long assocId)
(package private) AssociationModelImpl	fetchAssociation(String assocTypeUri, long topicId1, long topicId2, String roleTypeUri1, String roleTypeUri2) Convenience method (checks singularity).
(package private) AssociationModelImpl	fetchAssociation(String key, SimpleValue value) Looks up a single association by exact value.
(package private) List<AssociationModelImpl>	fetchAssociationAssociations(long assocId)
(package private) AssociationModelImpl	fetchAssociationBetweenTopicAndAssociation(String assocTypeUri, long topicId, long assocId, String topicRoleTypeUri, String assocRoleTypeUri) Convenience method (checks singularity).
(package private) RelatedAssociationModelImpl	fetchAssociationRelatedAssociation(long assocId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersAssocTypeUri) Convenience method (checks singularity).
(package private) List<RelatedAssociationModelImpl>	fetchAssociationRelatedAssociations(long assocId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersAssocTypeUri)
(package private) RelatedTopicModelImpl	fetchAssociationRelatedTopic(long assocId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri) Convenience method (checks singularity).
(package private) List<RelatedTopicModelImpl>	fetchAssociationRelatedTopics(long assocId, List<String> assocTypeUris, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri) Convenience method (receives *list* of association types).
(package private) List<RelatedTopicModelImpl>	fetchAssociationRelatedTopics(long assocId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri)
(package private) List<AssociationModelImpl>	fetchAssociations(String assocTypeUri, long topicId1, long topicId2, String roleTypeUri1, String roleTypeUri2) Returns the associations between two topics.
(package private) List<AssociationModelImpl>	fetchAssociations(String key, SimpleValue value)
(package private) List<AssociationModelImpl>	fetchAssociationsBetweenTopicAndAssociation(String assocTypeUri, long topicId, long assocId, String topicRoleTypeUri, String assocRoleTypeUri)
(package private) List<AssociationModelImpl>	fetchAssociationsByProperty(String propUri, Object propValue)
(package private) List<AssociationModelImpl>	fetchAssociationsByPropertyRange(String propUri, Number from, Number to)
(package private) int	fetchMigrationNr()
(package private) DMXObjectModelImpl	fetchObject(long id)
(package private) long[]	fetchPlayerIds(long assocId)
(package private) Object	fetchProperty(long id, String propUri)
(package private) RelatedTopicModelImpl	fetchRelatedTopic(long objectId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri) Convenience method (checks singularity).
(package private) List<RelatedTopicModelImpl>	fetchRelatedTopics(long objectId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri)
(package private) TopicModelImpl	fetchTopic(long topicId)
(package private) TopicModelImpl	fetchTopic(String key, SimpleValue value) Looks up a single topic by exact value.
(package private) List<AssociationModelImpl>	fetchTopicAssociations(long topicId)
(package private) RelatedAssociationModelImpl	fetchTopicRelatedAssociation(long topicId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersAssocTypeUri) Convenience method (checks singularity).
(package private) List<RelatedAssociationModelImpl>	fetchTopicRelatedAssociations(long topicId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersAssocTypeUri)
(package private) RelatedTopicModelImpl	fetchTopicRelatedTopic(long topicId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri) Convenience method (checks singularity).
(package private) List<RelatedTopicModelImpl>	fetchTopicRelatedTopics(long topicId, List<String> assocTypeUris, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri) Convenience method (receives *list* of association types).
(package private) List<RelatedTopicModelImpl>	fetchTopicRelatedTopics(long topicId, String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri)
(package private) List<TopicModelImpl>	fetchTopics(String key, SimpleValue value)
(package private) List<TopicModelImpl>	fetchTopicsByProperty(String propUri, Object propValue)
(package private) List<TopicModelImpl>	fetchTopicsByPropertyRange(String propUri, Number from, Number to)
(package private) Object	getDatabaseVendorObject()
(package private) Object	getDatabaseVendorObject(long objectId)
(package private) boolean	hasProperty(long id, String propUri)
(package private) void	indexAssociationProperty(long assocId, String propUri, Object propValue)
(package private) void	indexAssociationValue(long assocId, IndexMode indexMode, String indexKey, SimpleValue indexValue)
(package private) void	indexTopicProperty(long topicId, String propUri, Object propValue)
(package private) void	indexTopicValue(long topicId, IndexMode indexMode, String indexKey, SimpleValue indexValue)
(package private) boolean	init() Initializes the database.
(package private) List<TopicModelImpl>	queryTopics(String key, SimpleValue value)
(package private) void	removeAssociationProperty(long assocId, String propUri)
(package private) void	removeTopicProperty(long topicId, String propUri)
(package private) void	shutdown()
(package private) void	storeAssociation(AssociationModel model)
(package private) void	storeAssociationProperty(long assocId, String propUri, Object propValue, boolean addToIndex)
(package private) void	storeAssociationTypeUri(long assocId, String assocTypeUri)
(package private) void	storeAssociationUri(long assocId, String uri) Stores and indexes the association's URI.
(package private) void	storeAssociationValue(long assocId, SimpleValue value) Convenience method (no indexing).
(package private) void	storeAssociationValue(long assocId, SimpleValue value, List<IndexMode> indexModes, String indexKey, SimpleValue indexValue) Stores and indexes the association's value.
(package private) void	storeMigrationNr(int migrationNr)
(package private) void	storeRoleTypeUri(long assocId, long playerId, String roleTypeUri)
(package private) void	storeTopic(TopicModel model) Creates a topic.
(package private) void	storeTopicProperty(long topicId, String propUri, Object propValue, boolean addToIndex)
(package private) void	storeTopicTypeUri(long topicId, String topicTypeUri)
(package private) void	storeTopicUri(long topicId, String uri) Stores and indexes the topic's URI.
(package private) void	storeTopicValue(long topicId, SimpleValue value) Convenience method (no indexing).
(package private) void	storeTopicValue(long topicId, SimpleValue value, List<IndexMode> indexModes, String indexKey, SimpleValue indexValue) Stores and indexes the topic's value.

Methods inherited from class java.lang.Object

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

Field Detail

storage

private final DMXStorage storage

logger

private final Logger logger

Constructor Detail

StorageDecorator

StorageDecorator(DMXStorage storage)

Method Detail

fetchTopic

final TopicModelImpl fetchTopic(long topicId)

Returns:

The fetched topic. Note: its child topics are not fetched.

fetchTopic

final TopicModelImpl fetchTopic(String key,
                                SimpleValue value)

Looks up a single topic by exact value.

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

Returns:

The fetched topic, or null if no such topic exists. Note: its child topics are not fetched.

Throws:

RuntimeException - if more than one topic is found.

fetchTopics

final List<TopicModelImpl> fetchTopics(String key,
                                       SimpleValue value)

queryTopics

final List<TopicModelImpl> queryTopics(String key,
                                       SimpleValue value)

Returns:

The fetched topics. Note: their child topics are not fetched.

fetchAllTopics

final Iterator<TopicModelImpl> fetchAllTopics()

storeTopic

final void storeTopic(TopicModel model)

Creates a topic.

Actually only the topic URI and type URI are stored and indexed. The topic value is not stored.

storeTopicUri

final void storeTopicUri(long topicId,
                         String uri)

Stores and indexes the topic's URI.

storeTopicTypeUri

final void storeTopicTypeUri(long topicId,
                             String topicTypeUri)

storeTopicValue

final void storeTopicValue(long topicId,
                           SimpleValue value)

Convenience method (no indexing).

storeTopicValue

final void storeTopicValue(long topicId,
                           SimpleValue value,
                           List<IndexMode> indexModes,
                           String indexKey,
                           SimpleValue indexValue)

Stores and indexes the topic's value. ### TODO: separate storing/indexing?

indexTopicValue

final void indexTopicValue(long topicId,
                           IndexMode indexMode,
                           String indexKey,
                           SimpleValue indexValue)

_deleteTopic

final void _deleteTopic(long topicId)

Deletes the topic.

Prerequisite: the topic has no relations.

fetchAssociation

final AssociationModelImpl fetchAssociation(long assocId)

fetchAssociation

final AssociationModelImpl fetchAssociation(String key,
                                            SimpleValue value)

Looks up a single association by exact value. If no such association exists null is returned. If more than one association is found a runtime exception is thrown.

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

Returns:

The fetched association. Note: its child topics are not fetched.

fetchAssociations

final List<AssociationModelImpl> fetchAssociations(String key,
                                                   SimpleValue value)

fetchAssociation

final AssociationModelImpl fetchAssociation(String assocTypeUri,
                                            long topicId1,
                                            long topicId2,
                                            String roleTypeUri1,
                                            String roleTypeUri2)

Convenience method (checks singularity). 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. ### FIXME: for methods with a singular return value all filters should be mandatory

fetchAssociations

final List<AssociationModelImpl> fetchAssociations(String assocTypeUri,
                                                   long topicId1,
                                                   long topicId2,
                                                   String roleTypeUri1,
                                                   String roleTypeUri2)

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

Parameters:

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

fetchAssociationBetweenTopicAndAssociation

final AssociationModelImpl fetchAssociationBetweenTopicAndAssociation(String assocTypeUri,
                                                                      long topicId,
                                                                      long assocId,
                                                                      String topicRoleTypeUri,
                                                                      String assocRoleTypeUri)

Convenience method (checks singularity).

fetchAssociationsBetweenTopicAndAssociation

final List<AssociationModelImpl> fetchAssociationsBetweenTopicAndAssociation(String assocTypeUri,
                                                                             long topicId,
                                                                             long assocId,
                                                                             String topicRoleTypeUri,
                                                                             String assocRoleTypeUri)

fetchAllAssociations

final Iterator<AssociationModelImpl> fetchAllAssociations()

fetchPlayerIds

final long[] fetchPlayerIds(long assocId)

storeAssociationUri

final void storeAssociationUri(long assocId,
                               String uri)

Stores and indexes the association's URI.

storeAssociationTypeUri

final void storeAssociationTypeUri(long assocId,
                                   String assocTypeUri)

storeRoleTypeUri

final void storeRoleTypeUri(long assocId,
                            long playerId,
                            String roleTypeUri)

storeAssociationValue

final void storeAssociationValue(long assocId,
                                 SimpleValue value)

Convenience method (no indexing).

storeAssociationValue

final void storeAssociationValue(long assocId,
                                 SimpleValue value,
                                 List<IndexMode> indexModes,
                                 String indexKey,
                                 SimpleValue indexValue)

Stores and indexes the association's value. ### TODO: separate storing/indexing?

indexAssociationValue

final void indexAssociationValue(long assocId,
                                 IndexMode indexMode,
                                 String indexKey,
                                 SimpleValue indexValue)

storeAssociation

final void storeAssociation(AssociationModel model)

_deleteAssociation

final void _deleteAssociation(long assocId)

fetchObject

final DMXObjectModelImpl fetchObject(long id)

fetchTopicRelatedTopic

final RelatedTopicModelImpl fetchTopicRelatedTopic(long topicId,
                                                   String assocTypeUri,
                                                   String myRoleTypeUri,
                                                   String othersRoleTypeUri,
                                                   String othersTopicTypeUri)

Convenience method (checks singularity).

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

Returns:

The fetched topic. Note: its child topics are not fetched.

fetchTopicRelatedTopics

final List<RelatedTopicModelImpl> fetchTopicRelatedTopics(long topicId,
                                                          String assocTypeUri,
                                                          String myRoleTypeUri,
                                                          String othersRoleTypeUri,
                                                          String othersTopicTypeUri)

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

Returns:

The fetched topics. Note: their child topics are not fetched.

fetchTopicRelatedTopics

final List<RelatedTopicModelImpl> fetchTopicRelatedTopics(long topicId,
                                                          List<String> assocTypeUris,
                                                          String myRoleTypeUri,
                                                          String othersRoleTypeUri,
                                                          String othersTopicTypeUri)

Convenience method (receives *list* of association types).

Parameters:

assocTypeUris - may *not* be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

Returns:

The fetched topics. Note: their child topics are not fetched.

fetchTopicRelatedAssociation

final RelatedAssociationModelImpl fetchTopicRelatedAssociation(long topicId,
                                                               String assocTypeUri,
                                                               String myRoleTypeUri,
                                                               String othersRoleTypeUri,
                                                               String othersAssocTypeUri)

Convenience method (checks singularity).

Returns:

The fetched association. Note: its child topics are not fetched.

fetchTopicRelatedAssociations

final List<RelatedAssociationModelImpl> fetchTopicRelatedAssociations(long topicId,
                                                                      String assocTypeUri,
                                                                      String myRoleTypeUri,
                                                                      String othersRoleTypeUri,
                                                                      String othersAssocTypeUri)

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersAssocTypeUri - may be null

Returns:

The fetched associations. Note: their child topics are not fetched.

fetchTopicAssociations

final List<AssociationModelImpl> fetchTopicAssociations(long topicId)

Returns:

The fetched associations. Note: their child topics are not fetched.

fetchAssociationRelatedTopic

final RelatedTopicModelImpl fetchAssociationRelatedTopic(long assocId,
                                                         String assocTypeUri,
                                                         String myRoleTypeUri,
                                                         String othersRoleTypeUri,
                                                         String othersTopicTypeUri)

Convenience method (checks singularity).

Returns:

The fetched topic. Note: its child topics are not fetched.

fetchAssociationRelatedTopics

final List<RelatedTopicModelImpl> fetchAssociationRelatedTopics(long assocId,
                                                                String assocTypeUri,
                                                                String myRoleTypeUri,
                                                                String othersRoleTypeUri,
                                                                String othersTopicTypeUri)

Returns:

The fetched topics. Note: their child topics are not fetched.

fetchAssociationRelatedTopics

final List<RelatedTopicModelImpl> fetchAssociationRelatedTopics(long assocId,
                                                                List<String> assocTypeUris,
                                                                String myRoleTypeUri,
                                                                String othersRoleTypeUri,
                                                                String othersTopicTypeUri)

Convenience method (receives *list* of association types).

Parameters:

assocTypeUris - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

Returns:

The fetched topics. Note: their child topics are not fetched.

fetchAssociationRelatedAssociation

final RelatedAssociationModelImpl fetchAssociationRelatedAssociation(long assocId,
                                                                     String assocTypeUri,
                                                                     String myRoleTypeUri,
                                                                     String othersRoleTypeUri,
                                                                     String othersAssocTypeUri)

Convenience method (checks singularity).

Returns:

The fetched association. Note: its child topics are not fetched.

fetchAssociationRelatedAssociations

final List<RelatedAssociationModelImpl> fetchAssociationRelatedAssociations(long assocId,
                                                                            String assocTypeUri,
                                                                            String myRoleTypeUri,
                                                                            String othersRoleTypeUri,
                                                                            String othersAssocTypeUri)

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersAssocTypeUri - may be null

Returns:

The fetched associations. Note: their child topics are not fetched.

fetchAssociationAssociations

final List<AssociationModelImpl> fetchAssociationAssociations(long assocId)

fetchRelatedTopic

final RelatedTopicModelImpl fetchRelatedTopic(long objectId,
                                              String assocTypeUri,
                                              String myRoleTypeUri,
                                              String othersRoleTypeUri,
                                              String othersTopicTypeUri)

Convenience method (checks singularity).

Parameters:

objectId - id of a topic or an association

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

Returns:

The fetched topic. Note: its child topics are not fetched.

fetchRelatedTopics

final List<RelatedTopicModelImpl> fetchRelatedTopics(long objectId,
                                                     String assocTypeUri,
                                                     String myRoleTypeUri,
                                                     String othersRoleTypeUri,
                                                     String othersTopicTypeUri)

Parameters:

objectId - id of a topic or an association

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

Returns:

The fetched topics. Note: their child topics are not fetched.

fetchProperty

final Object fetchProperty(long id,
                           String propUri)

hasProperty

final boolean hasProperty(long id,
                          String propUri)

fetchTopicsByProperty

final List<TopicModelImpl> fetchTopicsByProperty(String propUri,
                                                 Object propValue)

fetchTopicsByPropertyRange

final List<TopicModelImpl> fetchTopicsByPropertyRange(String propUri,
                                                      Number from,
                                                      Number to)

fetchAssociationsByProperty

final List<AssociationModelImpl> fetchAssociationsByProperty(String propUri,
                                                             Object propValue)

fetchAssociationsByPropertyRange

final List<AssociationModelImpl> fetchAssociationsByPropertyRange(String propUri,
                                                                  Number from,
                                                                  Number to)

storeTopicProperty

final void storeTopicProperty(long topicId,
                              String propUri,
                              Object propValue,
                              boolean addToIndex)

storeAssociationProperty

final void storeAssociationProperty(long assocId,
                                    String propUri,
                                    Object propValue,
                                    boolean addToIndex)

indexTopicProperty

final void indexTopicProperty(long topicId,
                              String propUri,
                              Object propValue)

indexAssociationProperty

final void indexAssociationProperty(long assocId,
                                    String propUri,
                                    Object propValue)

removeTopicProperty

final void removeTopicProperty(long topicId,
                               String propUri)

removeAssociationProperty

final void removeAssociationProperty(long assocId,
                                     String propUri)

beginTx

final DMXTransaction beginTx()

init

final boolean init()

Initializes the database. Prerequisite: there is an open transaction.

Returns:

true if a clean install is detected, false otherwise.

shutdown

final void shutdown()

fetchMigrationNr

final int fetchMigrationNr()

storeMigrationNr

final void storeMigrationNr(int migrationNr)

getDatabaseVendorObject

final Object getDatabaseVendorObject()

getDatabaseVendorObject

final Object getDatabaseVendorObject(long objectId)