ch.agent.crnickl.impl

Class UpdatableChronicleImpl

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.ChronicleImpl

ch.agent.crnickl.impl.UpdatableChronicleImpl

All Implemented Interfaces:

Chronicle, DBObject, Updatable, UpdatableChronicle

Direct Known Subclasses:

NameSpace

public class UpdatableChronicleImpl
extends ChronicleImpl
implements UpdatableChronicle

Default implementation of UpdatableChronicle.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested classes/interfaces inherited from class ch.agent.crnickl.impl.ChronicleImpl

ChronicleImpl.RawData

Constructor Summary

Constructors

Constructor and Description
UpdatableChronicleImpl(Surrogate surrogate) Construct an UpdatableChronicle.

Method Summary

Modifier and Type	Method and Description
void	applyUpdates() Apply pending updates.
UpdatableChronicle	createChronicle(String orig, boolean tweakable, String description, Collection<Attribute<?>> attributes, Schema schema) Return a new chronicle to be created in this chronicle.
<T> UpdatableSeries<T>	createSeries(String seriesName) Create an empty series with the given name.
void	destroy() Destroy the chronicle.
UpdatableChronicle	edit() Return an UpdatableChronicle corresponding to this chronicle.
Attribute<?>	getAttribute(String attrName, boolean mustExist) Return the attribute with the given name.
Chronicle	getCollection() Return the chronicle to which this chronicle belongs.
String	getDescription(boolean full) Return the description of the chronicle.
String	getName(boolean full) Return the name of the chronicle.
Schema	getSchema(boolean effective) Return the chronicle's schema.
<T> Series<T>	getSeries(String seriesName) Return the series with the given simple name.
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.
protected void	update() Force refresh of state on next access.
void	updateAttributes(Collection<Attribute<?>> attributes) Update attribute values.
<T> UpdatableSeries<T>	updateSeries(String seriesName) Return the updatable series with the given name if it exists.

Methods inherited from class ch.agent.crnickl.impl.ChronicleImpl

findChronicle, getAttributes, getChronicle, getDescriptions, getMembers, getNames, getSeries, getSeries, isMemberOf, isTopChronicle, toString

Methods inherited from class ch.agent.crnickl.impl.DBObjectImpl

equals, getDatabase, getId, getSurrogate, hashCode, inConstruction, isValid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

findChronicle, getAttributes, getChronicle, getDescriptions, getMembers, getNames, getSeries, getSeries, isMemberOf, isTopChronicle

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

getDatabase, getId, getSurrogate, inConstruction, isValid

Constructor Detail

UpdatableChronicleImpl

public UpdatableChronicleImpl(Surrogate surrogate)

Construct an UpdatableChronicle.

Parameters:

surrogate - a surrogate

Method Detail

edit

public UpdatableChronicle edit()

Description copied from interface: Chronicle

Return an UpdatableChronicle corresponding to this chronicle. Successfully getting an Updatable object does not imply that updates can be successfully applied.

Specified by:

edit in interface Chronicle

Overrides:

edit in class ChronicleImpl

Returns:

an updatable chronicle corresponding to this chronicle

getName

public String getName(boolean full)
               throws T2DBException

Description copied from interface: Chronicle

Return the name of the chronicle.

Specified by:

getName in interface Chronicle

Overrides:

getName in class ChronicleImpl

Parameters:

full - if true return the full name, else the simple name

Returns:

the full or the simple name of the chronicle

Throws:

T2DBException

getDescription

public String getDescription(boolean full)
                      throws T2DBException

Description copied from interface: Chronicle

Return the description of the chronicle.

Specified by:

getDescription in interface Chronicle

Overrides:

getDescription in class ChronicleImpl

Parameters:

full - if true return the full description, else the simple description

Returns:

the full or the simple description of the chronicle

Throws:

T2DBException

getAttribute

public Attribute<?> getAttribute(String attrName,
                                 boolean mustExist)
                          throws T2DBException

Description copied from interface: Chronicle

Return the attribute with the given name. When the parameter mustExist is true, the result is never null. The value of the attribute can always be null. When no attribute with the given name is defined, an exception is thrown.

Specified by:

getAttribute in interface Chronicle

Overrides:

getAttribute in class ChronicleImpl

Parameters:

attrName - a string

mustExist - if true throw an exception instead of returning null

Returns:

an attribute or null (only when mustExist is false)

Throws:

T2DBException

getCollection

public Chronicle getCollection()
                        throws T2DBException

Description copied from interface: Chronicle

Return the chronicle to which this chronicle belongs. The result is null if the chronicle is the top-level chronicle. The result is also known as the parent chronicle.

Specified by:

getCollection in interface Chronicle

Overrides:

getCollection in class ChronicleImpl

Returns:

the parent chronicle or null

Throws:

T2DBException

getSchema

public Schema getSchema(boolean effective)
                 throws T2DBException

Description copied from interface: Chronicle

Return the chronicle's schema. The schema can be null. When the effective parameter is true, the schema returned is the first non-null schema encountered along the chronicle chain. Also in this case the result can be null.

Specified by:

getSchema in interface Chronicle

Overrides:

getSchema in class ChronicleImpl

Parameters:

effective - if true return the first non-null schema along the chronicle chain

Returns:

the schema of the chronicle or null

Throws:

T2DBException

setName

public void setName(String name)
             throws T2DBException

Description copied from interface: UpdatableChronicle

Set the name of the chronicle.

Specified by:

setName in interface UpdatableChronicle

Parameters:

name - a string

Throws:

T2DBException

setDescription

public void setDescription(String description)
                    throws T2DBException

Description copied from interface: UpdatableChronicle

Set the description of the chronicle.

Specified by:

setDescription in interface UpdatableChronicle

Parameters:

description - a string

Throws:

T2DBException

setAttribute

public void setAttribute(Attribute<?> value)
                  throws T2DBException

Description copied from interface: UpdatableChronicle

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

Specified by:

setAttribute in interface UpdatableChronicle

Parameters:

value - an attribute

Throws:

T2DBException

setCollection

public void setCollection(Chronicle collection)
                   throws T2DBException

Description copied from interface: UpdatableChronicle

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.

Specified by:

setCollection in interface UpdatableChronicle

Parameters:

collection - a chronicle

Throws:

T2DBException

setSchema

public void setSchema(Schema schema)
               throws T2DBException

Description copied from interface: UpdatableChronicle

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

Specified by:

setSchema in interface UpdatableChronicle

Parameters:

schema - a schema

Throws:

T2DBException

getSeries

public <T> Series<T> getSeries(String seriesName)
                        throws T2DBException

Description copied from interface: Chronicle

Return the series with the given simple name. The result is null if the series has not yet been set up in the database. Such a non-existent series is conceptually equivalent to a series with no values (empty range). The series name must be defined in the schema, else an exception is thrown. When the result is not null, it is possibly a new series for which updates need to be "applied".

Specified by:

getSeries in interface Chronicle

Overrides:

getSeries in class ChronicleImpl

Type Parameters:

T - the data type of the underlying time series

Parameters:

seriesName - the simple name if the series

Returns:

a series or null

Throws:

T2DBException

createSeries

public <T> UpdatableSeries<T> createSeries(String seriesName)
                                    throws T2DBException

Description copied from interface: UpdatableChronicle

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

Specified by:

createSeries in interface UpdatableChronicle

Parameters:

seriesName - a series name defined in the schema

Returns:

an updatable series

Throws:

T2DBException

updateSeries

public <T> UpdatableSeries<T> updateSeries(String seriesName)
                                    throws T2DBException

Description copied from interface: UpdatableChronicle

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

Specified by:

updateSeries in interface UpdatableChronicle

Parameters:

seriesName - a series name defined in the schema

Returns:

an updatable series or null

Throws:

T2DBException

createChronicle

public UpdatableChronicle createChronicle(String orig,
                                          boolean tweakable,
                                          String description,
                                          Collection<Attribute<?>> attributes,
                                          Schema schema)
                                   throws T2DBException

Description copied from interface: UpdatableChronicle

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.

Specified by:

createChronicle in interface UpdatableChronicle

Parameters:

orig - a name

tweakable - 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

destroy

public void destroy()
             throws T2DBException

Description copied from interface: UpdatableChronicle

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.

Specified by:

destroy in interface UpdatableChronicle

Throws:

T2DBException

applyUpdates

public void applyUpdates()
                  throws T2DBException

Description copied from interface: Updatable

Apply pending updates. Any error, including lack of authorization, results in an exception being thrown. This method does not manage transactions nor does it impose transaction boundaries. The management of transactions using Database.commit() and Database.rollback() is the client's responsibility.

Specified by:

applyUpdates in interface Updatable

Throws:

T2DBException

update

protected void update()

Description copied from class: ChronicleImpl

Force refresh of state on next access.

Overrides:

update in class ChronicleImpl

updateAttributes

public void updateAttributes(Collection<Attribute<?>> attributes)
                      throws T2DBException

Update attribute values.

Parameters:

attributes - a collection of attributes

Throws:

T2DBException