ch.agent.crnickl.api

Interface UpdatableChronicle

All Superinterfaces:

Chronicle, DBObject, Updatable

All Known Implementing Classes:

NameSpace, UpdatableChronicleImpl

public interface UpdatableChronicle
extends Chronicle, Updatable

An UpdatableChronicle is a chronicle which can be modified.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
UpdatableChronicle	createChronicle(String name, boolean tweakName, String description, Collection<Attribute<?>> attributes, Schema schema) Return a new chronicle to be created in this chronicle.
<T> UpdatableSeries<T>	createSeries(String name) Create an empty series with the given name.
void	destroy() Destroy the chronicle.
void	setAttribute(Attribute<?> value) Set an attribute.
void	setCollection(Chronicle collection) Set the collection of the chronicle.
void	setDescription(String description) Set the description of the chronicle.
void	setName(String name) Set the name of the chronicle.
void	setSchema(Schema schema) Set the schema of the chronicle.
<T> UpdatableSeries<T>	updateSeries(String name) Return the updatable series with the given name if it exists.

Methods inherited from interface ch.agent.crnickl.api.Chronicle

edit, findChronicle, getAttribute, getAttributes, getChronicle, getCollection, getDescription, getDescriptions, getMembers, getName, getNames, getSchema, getSeries, getSeries, getSeries, isMemberOf, isTopChronicle

Methods inherited from interface ch.agent.crnickl.api.DBObject

getDatabase, getId, getSurrogate, inConstruction, isValid

Methods inherited from interface ch.agent.crnickl.api.Updatable

applyUpdates

Method Detail

setName

void setName(String name)
      throws T2DBException

Set the name of the chronicle.

Parameters:

name - a string

Throws:

T2DBException

setDescription

void setDescription(String description)
             throws T2DBException

Set the description of the chronicle.

Parameters:

description - a string

Throws:

T2DBException

setAttribute

void setAttribute(Attribute<?> value)
           throws T2DBException

Set an attribute. The attribute must be defined in the schema.

Parameters:

value - an attribute

Throws:

T2DBException

setCollection

void setCollection(Chronicle collection)
            throws T2DBException

Set the collection of the chronicle. It is only allowed to specify a chronicle with a schema compatible with the current state of the chronicle.

Parameters:

collection - a chronicle

Throws:

T2DBException

setSchema

void setSchema(Schema schema)
        throws T2DBException

Set the schema of the chronicle. It is only allowed to specify a schema compatible with the current state of the chronicle.

Parameters:

schema - a schema

Throws:

T2DBException

destroy

void destroy()
      throws T2DBException

Destroy the chronicle. The operation fails if the chronicle is used as collection or if it has series. After applying updates DBObject.isValid() will return false.

Throws:

T2DBException

createSeries

<T> UpdatableSeries<T> createSeries(String name)
                             throws T2DBException

Create an empty series with the given name. The series must be defined in the schema.

Parameters:

name - a series name defined in the schema

Returns:

an updatable series

Throws:

T2DBException

updateSeries

<T> UpdatableSeries<T> updateSeries(String name)
                             throws T2DBException

Return the updatable series with the given name if it exists. The series must be defined in the schema.

Parameters:

name - a series name defined in the schema

Returns:

an updatable series or null

Throws:

T2DBException

createChronicle

UpdatableChronicle createChronicle(String name,
                                   boolean tweakName,
                                   String description,
                                   Collection<Attribute<?>> attributes,
                                   Schema schema)
                            throws T2DBException

Return a new chronicle to be created in this chronicle. When setting up a hierarchy of chronicles, start with Database.getTopChronicle().

The name of the chronicle must not be in use within this chronicle. It may optionally be tweaked to satisfy this requirement (and to obey rules of the prevailing name syntax). The attributes must be defined in the schema. If no schema is specified, the schema of this chronicle will apply. If this chronicle has no schema, then the first schema along the chronicle chain will apply. On the other hand, if a schema is specified, it completely overrides any current schema. The schema may not be an UpdatableSchema.

The client must execute Updatable.applyUpdates() on the result.

Parameters:

name - a name

tweakName - if true, the name can be tweaked if required

description - a description

attributes - a collection of attributes

schema - a schema or null

Returns:

an updatable chronicle

Throws:

T2DBException