|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.contentmanagement.contentmanager.plugin.delegates.Delegate
org.gcube.contentmanagement.contentmanager.plugin.delegates.Collection
public abstract class Collection
Extends Delegate
as the base class for extensions of CollectionResource
.
Nested Class Summary | |
---|---|
static class |
Collection.ChangeTopic
A GCUBETopic for changes of state to dynamic collection properties. |
Constructor Summary | |
---|---|
Collection(java.lang.String id)
Constructs an instance for a collection. |
Method Summary | |
---|---|
long |
getCardinality()
Returns the cardinality of the collection. |
java.util.Calendar |
getCreationTime()
Returns the creation time of the collection. |
java.lang.String |
getDescription()
Returns the free-form description of the collection. |
java.lang.String |
getID()
Returns the collection identifier. |
java.util.Calendar |
getLastUpdate()
Returns the time in which the collection was last updated. |
java.lang.String |
getName()
Returns the name of the collection. |
ReadDelegate |
getReader()
Return the collection reader. |
WriteDelegate |
getWriter()
Return the collection writer. |
abstract void |
initialise()
Invoked by the service to initialise the collection. |
boolean |
isUser()
Indicates whether the collection is a user collection. |
void |
notifyDeletion()
Reports the deletion of the collection. |
void |
onLoad(boolean firstLoad)
Invoked right after collection has been reloaded form persistent storage. |
void |
setCardinality(long c)
Sets the cardinality of the collection. |
java.util.Calendar |
setCreationTime(java.util.Calendar c)
Sets the creation time of the collection. |
void |
setDescription(java.lang.String d)
Sets the free-form description of the collection. |
void |
setLastUpdate(java.util.Calendar t)
Sets the time in which the collection was last updated. |
void |
setName(java.lang.String name)
Sets the name of the collection. |
void |
setReader(ReadDelegate r)
Sets the reader. |
void |
setUser(boolean isUser)
Sets the collection as a user collection or as a system collection. |
void |
setWriter(WriteDelegate w)
Sets the writer. |
void |
store()
Signals that the delegate has changed. |
void |
subscribe(
|
Methods inherited from class org.gcube.contentmanagement.contentmanager.plugin.delegates.Delegate |
---|
getScopeManager, getSecurityManager, setResource |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Collection(java.lang.String id) throws java.lang.IllegalArgumentException
id
- the collection identifier.
java.lang.IllegalArgumentException
Method Detail |
---|
public void subscribe(consumer)
public abstract void initialise() throws java.lang.Exception
Subclasses are expected to trigger staging processes during the execution of this method.
java.lang.Exception
- if the collection could not be initialised.public boolean isUser()
true
if it is, false
otherwise.public java.util.Calendar getCreationTime()
public java.util.Calendar setCreationTime(java.util.Calendar c)
the
- time.public java.lang.String getDescription()
public void setDescription(java.lang.String d)
the
- description.public void setUser(boolean isUser)
isUser
- true if is a user collection, false
otherwise.
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name.public void setReader(ReadDelegate r)
r
- the reader.public void setWriter(WriteDelegate w)
r
- the writer.public ReadDelegate getReader()
public WriteDelegate getWriter()
public java.lang.String getID()
public void setCardinality(long c)
c
- the cardinality.public long getCardinality()
public void setLastUpdate(java.util.Calendar t)
t
- the time.public java.util.Calendar getLastUpdate()
public void notifyDeletion()
public void store()
public final void onLoad(boolean firstLoad) throws java.lang.Exception
java.lang.Exception
- if the collection fails to be loaded.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |