org.granite.client.persistence.collection

Class AbstractPersistentCollection<C>

java.lang.Object

org.granite.client.persistence.collection.AbstractPersistentCollection<C>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, PersistentCollection<C>

Direct Known Subclasses:

AbstractPersistentMapCollection, AbstractPersistentSimpleCollection

public abstract class AbstractPersistentCollection<C>
extends java.lang.Object
implements PersistentCollection<C>

Author:

Franck WOLFF

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.granite.client.persistence.collection.PersistentCollection

PersistentCollection.ChangeListener<C>, PersistentCollection.InitializationCallback<C>, PersistentCollection.InitializationListener<C>, PersistentCollection.Initializer<C>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPersistentCollection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(PersistentCollection.ChangeListener<C> listener) Register a change listener
void	addListener(PersistentCollection.InitializationListener<C> listener) Register a initialization listener
protected boolean	checkInitializedRead()
protected void	checkInitializedWrite()
void	clearDirty() Clear the dirty state of the collection
PersistentCollection<C>	clone(boolean uninitialize) Clone a persistent collection
protected abstract PersistentCollectionSnapshot	createSnapshot(java.lang.Object io, boolean forReading)
void	dirty() Mark the collection as dirty
protected abstract void	doInitialize(C content, boolean empty)
protected java.lang.ClassLoader	getClassLoader()
protected C	getCollection()
java.lang.String	getDetachedState()
Loader<C>	getLoader() Loader for the collection
protected void	init(C collection, java.lang.String detachedState, boolean dirty)
void	initialize(C content, PersistentCollection.Initializer<C> initializer) Mark the collection as initialized, called after the content is loaded
void	initializing() Mark the collection as currently initializing so next access do not trigger loading
boolean	isDirty() Is the collection dirty ?
void	readExternal(java.io.ObjectInput in)
void	removeListener(PersistentCollection.ChangeListener<C> listener) Unregister a change listener
void	removeListener(PersistentCollection.InitializationListener<C> listener) Unregister a initialization listener
void	setLoader(Loader<C> loader) Set a loader for the collection
java.lang.String	toString()
void	uninitialize() Unload the collection and unset its initialized state
protected abstract void	updateFromSnapshot(java.io.ObjectInput in, PersistentCollectionSnapshot snapshot)
boolean	wasInitialized() Was the collection was initialized
void	withInitialized(PersistentCollection.InitializationCallback<C> callback) Execute the specified callback after ensuring the collection has been loaded If it was not loaded, the callack is called asynchronously after loading is complete
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPersistentCollection

protected AbstractPersistentCollection()

Method Detail

init

protected void init(C collection,
        java.lang.String detachedState,
        boolean dirty)

getLoader

public Loader<C> getLoader()

Description copied from interface: PersistentCollection

Loader for the collection

Specified by:

getLoader in interface PersistentCollection<C>

Returns:

loader or null of none defined

setLoader

public void setLoader(Loader<C> loader)

Description copied from interface: PersistentCollection

Set a loader for the collection

Specified by:

setLoader in interface PersistentCollection<C>

Parameters:

loader - loader that will be called when a lazy collection is accessed

checkInitializedRead

protected boolean checkInitializedRead()

checkInitializedWrite

protected void checkInitializedWrite()

getCollection

protected C getCollection()

getDetachedState

public java.lang.String getDetachedState()

getClassLoader

protected java.lang.ClassLoader getClassLoader()

wasInitialized

public boolean wasInitialized()

Description copied from interface: PersistentCollection

Was the collection was initialized

Specified by:

wasInitialized in interface PersistentCollection<C>

Returns:

true if collection initialized

isDirty

public boolean isDirty()

Description copied from interface: PersistentCollection

Is the collection dirty ?

Specified by:

isDirty in interface PersistentCollection<C>

Returns:

true if the collection has been modified since last server sync

dirty

public void dirty()

Description copied from interface: PersistentCollection

Mark the collection as dirty

Specified by:

dirty in interface PersistentCollection<C>

clearDirty

public void clearDirty()

Description copied from interface: PersistentCollection

Clear the dirty state of the collection

Specified by:

clearDirty in interface PersistentCollection<C>

clone

public PersistentCollection<C> clone(boolean uninitialize)

Description copied from interface: PersistentCollection

Clone a persistent collection

Specified by:

clone in interface PersistentCollection<C>

Parameters:

uninitialize - true to get an uninitialized clone of a lazy collection

Returns:

cloned collection

createSnapshot

protected abstract PersistentCollectionSnapshot createSnapshot(java.lang.Object io,
                                          boolean forReading)

updateFromSnapshot

protected abstract void updateFromSnapshot(java.io.ObjectInput in,
                      PersistentCollectionSnapshot snapshot)

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addListener

public void addListener(PersistentCollection.ChangeListener<C> listener)

Description copied from interface: PersistentCollection

Register a change listener

Specified by:

addListener in interface PersistentCollection<C>

Parameters:

listener - listener

removeListener

public void removeListener(PersistentCollection.ChangeListener<C> listener)

Description copied from interface: PersistentCollection

Unregister a change listener

Specified by:

removeListener in interface PersistentCollection<C>

Parameters:

listener - listener

addListener

public void addListener(PersistentCollection.InitializationListener<C> listener)

Description copied from interface: PersistentCollection

Register a initialization listener

Specified by:

addListener in interface PersistentCollection<C>

Parameters:

listener - listener

removeListener

public void removeListener(PersistentCollection.InitializationListener<C> listener)

Description copied from interface: PersistentCollection

Unregister a initialization listener

Specified by:

removeListener in interface PersistentCollection<C>

Parameters:

listener - listener

initializing

public void initializing()

Description copied from interface: PersistentCollection

Mark the collection as currently initializing so next access do not trigger loading

Specified by:

initializing in interface PersistentCollection<C>

initialize

public void initialize(C content,
              PersistentCollection.Initializer<C> initializer)

Description copied from interface: PersistentCollection

Mark the collection as initialized, called after the content is loaded

Specified by:

initialize in interface PersistentCollection<C>

doInitialize

protected abstract void doInitialize(C content,
                boolean empty)

uninitialize

public void uninitialize()

Description copied from interface: PersistentCollection

Unload the collection and unset its initialized state

Specified by:

uninitialize in interface PersistentCollection<C>

withInitialized

public void withInitialized(PersistentCollection.InitializationCallback<C> callback)

Description copied from interface: PersistentCollection

Execute the specified callback after ensuring the collection has been loaded If it was not loaded, the callack is called asynchronously after loading is complete

Specified by:

withInitialized in interface PersistentCollection<C>

Parameters:

callback - callback method to execute