Package cz.cvut.kbss.jopa.sessions

Class ReadOnlyUnitOfWork

java.lang.Object

cz.cvut.kbss.jopa.sessions.AbstractSession

cz.cvut.kbss.jopa.sessions.AbstractUnitOfWork

cz.cvut.kbss.jopa.sessions.ReadOnlyUnitOfWork

All Implemented Interfaces:

ConfigurationHolder, MetamodelProvider, UnitOfWork, Wrapper

public class ReadOnlyUnitOfWork
extends AbstractUnitOfWork

Field Summary

Fields inherited from class cz.cvut.kbss.jopa.sessions.AbstractUnitOfWork

LOG

Fields inherited from class cz.cvut.kbss.jopa.sessions.AbstractSession

configuration

Method Summary

Modifier and Type	Method	Description
void	attributeChanged(Object entity, FieldSpecification<?,?> fieldSpec)	Method is not supported.
void	attributeChanged(Object entity, Field f)	Method is not supported.
void	clear()	Clears this Unit of Work.
void	commit()	ReadOnlyUnitOfWork commits nothing.
void	commitToStorage()
Object	createIndirectCollection(Object collection, Object owner, Field field)	Creates an indirect collection that wraps the specified collection instance and propagates changes to this persistence context.
protected void	evictAfterMerge(EntityType<?> et, URI identifier, Descriptor descriptor)	Method not supported.
Object	getCloneForOriginal(Object original)	Simply returns the specified original object.
protected <T> T	getInstanceForMerge(URI identifier, EntityType<T> et, Descriptor descriptor)	Method not supported.
<T> T	getManagedOriginal(Class<T> cls, Object identifier, Descriptor descriptor)	Gets managed original with the specified identifier or null if there is none matching.
Object	getOriginal(Object entity)	Simply returns the specified entity.
<T> T	getReference(Class<T> cls, Object identifier, Descriptor descriptor)	Retrieves an object with the specified identifier.
EntityState	getState(Object entity)	Gets the lifecycle state of the specified entity.
EntityState	getState(Object entity, Descriptor descriptor)	Gets the lifecycle state of the specified entity with respect to a repository context indicated by the specified descriptor.
boolean	hasChanges()	Method is not supported.
boolean	isFlushingChanges()	Method is not supported.
boolean	isObjectManaged(Object entity)	Return true if the given entity is managed.
boolean	isObjectNew(Object entity)	Method not supported.
boolean	isReadOnly()
protected void	markCloneForDeletion(Object entity, Object identifier)	Method is not supported.
<T> T	mergeDetached(T entity, Descriptor descriptor)	Method not supported.
<T> T	mergeDetachedInternal(T entity, Descriptor descriptor)	Method not supported.
protected ObjectChangeSet	processInferredValueChanges(ObjectChangeSet changeSet)	Method is not supported.
void	putObjectIntoCache(Object identifier, Object entity, Descriptor descriptor)	Does nothing.
<T> T	readObjectFromAxioms(Class<T> cls, Collection<Axiom<?>> axioms, Descriptor descriptor)	Reads an object from the specified axioms.
protected <T> T	readObjectInternal(Class<T> cls, Object identifier, Descriptor descriptor)
<T> void	refreshObject(T object)	Method not supported.
Object	registerExistingObject(Object entity, Descriptor descriptor)	Register an existing object in this Unit of Work without cloning it.
Object	registerExistingObject(Object entity, CloneRegistrationDescriptor registrationDescriptor)	Register an existing object in this Unit of Work.
void	registerNewObject(Object entity, Descriptor descriptor)	Method is not supported.
void	registerOriginalForNewClone(Object clone, Object original)	Method is not supported.
void	removeObject(Object object)	Method is not supported.
void	removeObjectFromCache(Object toRemove, URI context)	Method not supported.
void	restoreRemovedObject(Object entity)	Method is not supported.
void	unregisterObject(Object object)	Detaches the specified registered object from this Unit of Work.
void	writeUncommittedChanges()	Method is not supported.

Methods inherited from class cz.cvut.kbss.jopa.sessions.AbstractUnitOfWork

acquireConnection, begin, contains, copyChangeSet, entityType, getContexts, getCriteriaBuilder, getFieldDescriptor, getLiveObjectCache, getLoadStateRegistry, getMetamodel, isActive, isConsistent, isEntityType, isInferred, isInRepository, isInTransaction, isLoaded, isLoaded, loadEntityField, readObject, readObjectWithoutRegistration, release, removeIndirectWrappersAndProxies, rollback, sparqlQueryFactory, stringify, unregisterEntityFromOntologyContext, unwrap

Methods inherited from class cz.cvut.kbss.jopa.sessions.AbstractSession

getConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.cvut.kbss.jopa.sessions.ConfigurationHolder

getConfiguration

Methods inherited from interface cz.cvut.kbss.jopa.sessions.MetamodelProvider

getNamedQueryManager, getResultSetMappingManager

Method Details

clear

public void clear()

Description copied from interface: UnitOfWork

Clears this Unit of Work.

Specified by:

clear in interface UnitOfWork

Overrides:

clear in class AbstractUnitOfWork

commit

public void commit()

ReadOnlyUnitOfWork commits nothing. The persistence context is cleared.

Specified by:

commit in interface UnitOfWork

Overrides:

commit in class AbstractUnitOfWork

readObjectInternal

protected <T> T readObjectInternal(Class<T> cls,
 Object identifier,
 Descriptor descriptor)

Overrides:

readObjectInternal in class AbstractUnitOfWork

getManagedOriginal

public <T> T getManagedOriginal(Class<T> cls,
 Object identifier,
 Descriptor descriptor)

Gets managed original with the specified identifier or null if there is none matching.

Descriptor is used to check repository context validity. Note that the ReadOnlyUnitOfWork does not distinguish between original and cloned objects.

Overrides:

getManagedOriginal in class AbstractUnitOfWork

Parameters:

cls - Return type of the original

identifier - Instance identifier

descriptor - Repository descriptor

Returns:

Original object managed by this UoW or null if this UoW doesn't contain a matching instance

readObjectFromAxioms

public <T> T readObjectFromAxioms(Class<T> cls,
 Collection<Axiom<?>> axioms,
 Descriptor descriptor)

Description copied from interface: UnitOfWork

Reads an object from the specified axioms.

It is assumed the axioms correspond to the provided descriptor.

Specified by:

readObjectFromAxioms in interface UnitOfWork

Overrides:

readObjectFromAxioms in class AbstractUnitOfWork

Type Parameters:

T - Return type

Parameters:

cls - Expected result class

axioms - Axioms representing the object

descriptor - Entity descriptor

Returns:

The retrieved object or null if no object of the expected target class can be reconstructed

unregisterObject

public void unregisterObject(Object object)

Detaches the specified registered object from this Unit of Work.

Specified by:

unregisterObject in interface UnitOfWork

Overrides:

unregisterObject in class AbstractUnitOfWork

Parameters:

object - Entity to detach

registerExistingObject

public Object registerExistingObject(Object entity,
 Descriptor descriptor)

Register an existing object in this Unit of Work without cloning it.

Specified by:

registerExistingObject in interface UnitOfWork

Overrides:

registerExistingObject in class AbstractUnitOfWork

Parameters:

entity - Object

descriptor - Entity descriptor identifying repository contexts

Returns:

Registered entity

See Also:

• UnitOfWork.registerExistingObject(Object, CloneRegistrationDescriptor)

registerExistingObject

public Object registerExistingObject(Object entity,
 CloneRegistrationDescriptor registrationDescriptor)

Register an existing object in this Unit of Work. Creates a working clone of the specified object according to the configuration.

Specified by:

registerExistingObject in interface UnitOfWork

Overrides:

registerExistingObject in class AbstractUnitOfWork

Parameters:

entity - Object

registrationDescriptor - Configuration of the registration

Returns:

Registered clone of the specified object.

getOriginal

public Object getOriginal(Object entity)

Simply returns the specified entity. ReadOnlyUnitOfWork does not distinguish between original and cloned objects.

Overrides:

getOriginal in class AbstractUnitOfWork

Parameters:

entity - Object

Returns:

the specified entity.

isObjectManaged

public boolean isObjectManaged(Object entity)

Return true if the given entity is managed.

Specified by:

isObjectManaged in interface UnitOfWork

Overrides:

isObjectManaged in class AbstractUnitOfWork

Parameters:

entity - Object to check

Returns:

true when the entity is managed, false otherwise

getState

public EntityState getState(Object entity)

Gets the lifecycle state of the specified entity.

ReadOnlyUnitOfWork

Specified by:

getState in interface UnitOfWork

Overrides:

getState in class AbstractUnitOfWork

Parameters:

entity - Entity whose state to resolve

Returns:

EntityState.MANAGED if this Unit Of Work contains the specified entity, EntityState.NOT_MANAGED otherwise

getState

public EntityState getState(Object entity,
 Descriptor descriptor)

Description copied from interface: UnitOfWork

Gets the lifecycle state of the specified entity with respect to a repository context indicated by the specified descriptor.

Specified by:

getState in interface UnitOfWork

Overrides:

getState in class AbstractUnitOfWork

Parameters:

entity - Entity whose state to resolve

descriptor - Descriptor of repository contexts

Returns:

Entity state

getReference

public <T> T getReference(Class<T> cls,
 Object identifier,
 Descriptor descriptor)

Retrieves an object with the specified identifier.

A reference is not retrieved! The method is implemented via the readObject and has exactly the same behavior.

Specified by:

getReference in interface UnitOfWork

Overrides:

getReference in class AbstractUnitOfWork

Type Parameters:

T - Entity type

Parameters:

cls - The type of the returned object

identifier - Instance identifier

descriptor - Entity descriptor

Returns:

The retrieved object or null if there is no object with the specified identifier in the specified repository

getCloneForOriginal

public Object getCloneForOriginal(Object original)

Simply returns the specified original object. ReadOnlyUnitOfWork does not distinguish between original and cloned objects.

Specified by:

getCloneForOriginal in interface UnitOfWork

Overrides:

getCloneForOriginal in class AbstractUnitOfWork

Parameters:

original - The original object whose clone we are looking for

Returns:

specified original

createIndirectCollection

public Object createIndirectCollection(Object collection,
 Object owner,
 Field field)

Creates an indirect collection that wraps the specified collection instance and propagates changes to this persistence context. ReadOnlyUnitOfWork simply returns the specified collection. No special indirect collection is needed.

Parameters:

collection - Collection to be proxied

owner - Collection owner instance

field - Field filled with the collection

Returns:

Indirect collection

putObjectIntoCache

public void putObjectIntoCache(Object identifier,
 Object entity,
 Descriptor descriptor)

Does nothing. ReadOnlyUnitOfWork should not put objects into the cache.

Specified by:

putObjectIntoCache in interface UnitOfWork

Overrides:

putObjectIntoCache in class AbstractUnitOfWork

Parameters:

identifier - Object identifier

entity - Object to cache

descriptor - Descriptor of repository context

commitToStorage

public void commitToStorage()

isReadOnly

public boolean isReadOnly()

Overrides:

isReadOnly in class AbstractUnitOfWork

removeObjectFromCache

public void removeObjectFromCache(Object toRemove,
 URI context)
                           throws UnsupportedOperationException

Method not supported.

Specified by:

removeObjectFromCache in interface UnitOfWork

Overrides:

removeObjectFromCache in class AbstractUnitOfWork

Parameters:

toRemove - Object to remove from cache

context - Entity context URI

Throws:

UnsupportedOperationException - Method not supported.

isObjectNew

public boolean isObjectNew(Object entity)
                    throws UnsupportedOperationException

Method not supported.

Specified by:

isObjectNew in interface UnitOfWork

Overrides:

isObjectNew in class AbstractUnitOfWork

Parameters:

entity - Object to check

Returns:

true when entity is managed and new, false otherwise

Throws:

UnsupportedOperationException - Method not supported.

See Also:

• UnitOfWork.isObjectManaged(Object)

mergeDetached

public <T> T mergeDetached(T entity,
 Descriptor descriptor)
                    throws UnsupportedOperationException

Method not supported.

Specified by:

mergeDetached in interface UnitOfWork

Overrides:

mergeDetached in class AbstractUnitOfWork

Parameters:

entity - entity instance

descriptor - Entity descriptor, specifies repository context

Returns:

the managed instance that the state was merged to

Throws:

UnsupportedOperationException - Method not supported.

mergeDetachedInternal

public <T> T mergeDetachedInternal(T entity,
 Descriptor descriptor)
                            throws UnsupportedOperationException

Method not supported.

Throws:

UnsupportedOperationException - Method not supported.

getInstanceForMerge

protected <T> T getInstanceForMerge(URI identifier,
 EntityType<T> et,
 Descriptor descriptor)
                             throws UnsupportedOperationException

Method not supported.

Overrides:

getInstanceForMerge in class AbstractUnitOfWork

Throws:

UnsupportedOperationException - Method not supported.

evictAfterMerge

protected void evictAfterMerge(EntityType<?> et,
 URI identifier,
 Descriptor descriptor)
                        throws UnsupportedOperationException

Method not supported.

Overrides:

evictAfterMerge in class AbstractUnitOfWork

Throws:

UnsupportedOperationException - Method not supported.

refreshObject

public <T> void refreshObject(T object)
                       throws UnsupportedOperationException

Method not supported.

Specified by:

refreshObject in interface UnitOfWork

Overrides:

refreshObject in class AbstractUnitOfWork

Type Parameters:

T - Object type

Parameters:

object - The object to revert

Throws:

UnsupportedOperationException - Method not supported.

processInferredValueChanges

protected ObjectChangeSet processInferredValueChanges(ObjectChangeSet changeSet)
                                               throws UnsupportedOperationException

Method is not supported.

Overrides:

processInferredValueChanges in class AbstractUnitOfWork

Throws:

UnsupportedOperationException - Always thrown

registerOriginalForNewClone

public void registerOriginalForNewClone(Object clone,
 Object original)
                                 throws UnsupportedOperationException

Method is not supported.

Overrides:

registerOriginalForNewClone in class AbstractUnitOfWork

Parameters:

clone - Already registered clone

original - Original to register

Throws:

UnsupportedOperationException - Always thrown

writeUncommittedChanges

public void writeUncommittedChanges()
                             throws UnsupportedOperationException

Method is not supported.

Specified by:

writeUncommittedChanges in interface UnitOfWork

Overrides:

writeUncommittedChanges in class AbstractUnitOfWork

Throws:

UnsupportedOperationException - Always thrown

hasChanges

public boolean hasChanges()
                   throws UnsupportedOperationException

Method is not supported.

Overrides:

hasChanges in class AbstractUnitOfWork

Throws:

UnsupportedOperationException - Always thrown

restoreRemovedObject

public void restoreRemovedObject(Object entity)
                          throws UnsupportedOperationException

Method is not supported.

Specified by:

restoreRemovedObject in interface UnitOfWork

Overrides:

restoreRemovedObject in class AbstractUnitOfWork

Parameters:

entity - The object to restore

Throws:

UnsupportedOperationException - Always thrown

isFlushingChanges

public boolean isFlushingChanges()
                          throws UnsupportedOperationException

Method is not supported.

Specified by:

isFlushingChanges in interface UnitOfWork

Overrides:

isFlushingChanges in class AbstractUnitOfWork

Returns:

true if the UoW is flushing changes, false otherwise

Throws:

UnsupportedOperationException - Always thrown

attributeChanged

public void attributeChanged(Object entity,
 Field f)
                      throws UnsupportedOperationException

Method is not supported.

Parameters:

entity - Entity with changes (the clone)

f - The field whose value has changed

Throws:

UnsupportedOperationException - Always thrown

See Also:

• UnitOfWork.attributeChanged(Object, FieldSpecification)

attributeChanged

public void attributeChanged(Object entity,
 FieldSpecification<?,?> fieldSpec)
                      throws UnsupportedOperationException

Method is not supported.

Parameters:

entity - Entity with changes (the clone)

fieldSpec - Metamodel element representing the attribute that changed

Throws:

UnsupportedOperationException - Always thrown

markCloneForDeletion

protected void markCloneForDeletion(Object entity,
 Object identifier)
                             throws UnsupportedOperationException

Method is not supported.

Overrides:

markCloneForDeletion in class AbstractUnitOfWork

Throws:

UnsupportedOperationException - Always thrown

registerNewObject

public void registerNewObject(Object entity,
 Descriptor descriptor)
                       throws UnsupportedOperationException

Method is not supported.

Specified by:

registerNewObject in interface UnitOfWork

Overrides:

registerNewObject in class AbstractUnitOfWork

Parameters:

entity - The object to register

descriptor - Entity descriptor

Throws:

UnsupportedOperationException - Always thrown

removeObject

public void removeObject(Object object)
                  throws UnsupportedOperationException

Method is not supported.

Parameters:

object - Object to remove

Throws:

UnsupportedOperationException - Always thrown