ch.agent.crnickl.impl

Class UpdatableSchemaImpl

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.SchemaImpl

ch.agent.crnickl.impl.UpdatableSchemaImpl

All Implemented Interfaces:

DBObject, IncompleteSchema, Schema, Updatable, UpdatableSchema

public class UpdatableSchemaImpl
extends SchemaImpl
implements UpdatableSchema

Default implementation of UpdatableSchema.

Note about cyclical definitions of schemas. Suppose schema a is the parent of schema b and b of a. It is in principle not possible to create such a cycle without hacking the database. If for some reason such a cycle occurs, it will be detected by the resolve method. The code constructing an updatable schema from its database representation should detect cycles, perform some minimal surgery in a way which allows detection of the cycle (like nullifying the parent creating the cycle: a -> b -> a -> null).

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
UpdatableSchemaImpl(String name, UpdatableSchema base, Collection<AttributeDefinition<?>> attributeDefs, Collection<SeriesDefinition> seriesDefinitions, Surrogate surrogate) Construct an UpdatableSchema.

Method Summary

Modifier and Type	Method and Description
AttributeDefinition<?>	addAttribute(int attrNr) Add a new attribute to the schema.
AttributeDefinition<?>	addAttribute(int seriesNr, int attrNr) Add a new attribute to a series.
SeriesDefinition	addSeries(int seriesNr) Add a new series to the schema.
void	applyUpdates() Apply pending updates.
protected Schema	consolidate(String name, Surrogate surrogate, List<Surrogate> dependencyList) Apply all changes and return the schema as a standard read-only schema.
void	deleteAttribute(int attrNr) Delete an attribute from the schema.
void	deleteAttribute(int seriesNr, int attrNr) Delete an attribute from a series.
void	deleteSeries(int seriesNr) Delete a series from the schema.
void	destroy() Destroy the schema.
UpdatableSchema	edit() Return an UpdatableSchema corresponding to this schema.
protected AttributeDefinitionImpl<?>	editAttributeDefinition(int attrNr) Start editing an attribute definition.
protected AttributeDefinitionImpl<?>	editSeriesAttributeDefinition(int seriesNr, int attrNr, boolean mustExist) Start editing a series attribute definition.
void	eraseAttribute(int attrNr) Set an attribute as erasing.
void	eraseAttribute(int seriesNr, int attrNr) Set a series attribute as erasing.
void	eraseSeries(int seriesNr) Set a series as erasing.
UpdatableSchema	getBase() Return the base schema if any.
String	getName() Return the name of the schema or series definition.
UpdatableSchema	getPreviousBase() Return the base schema before it was modified with setBase(UpdatableSchema).
void	merge(UpdatableSchema schema) Merge a schema into this schema.
Schema	resolve() Resolve into a schema.
void	setAttributeDefault(int seriesNr, int attrNr, Object defaultValue) Set the default value of a series attribute.
<T> void	setAttributeDefault(int attrNr, T defaultValue) Set the default value of an attribute.
void	setAttributeProperty(int seriesNr, int attrNr, Property<?> property) Set the property of a series attribute.
<T> void	setAttributeProperty(int attrNr, Property<T> property) Set the property of an attribute.
void	setBase(UpdatableSchema base) Set the base of the schema.
void	setName(String name) Set the name of the schema.
void	setSeriesDescription(int seriesNr, String description) Set the description of the series.
void	setSeriesName(int seriesNr, String name) Set the name of a series.
void	setSeriesSparsity(int seriesNr, boolean sparse) Set the sparsity of the series.
void	setSeriesTimeDomain(int seriesNr, ch.agent.t2.time.TimeDomain timeDomain) Set the time domain of the series.
void	setSeriesType(int seriesNr, String type) Set the value type of the series using the name of the value type.
void	setSeriesType(int seriesNr, ValueType<?> type) Set the value type of the series.
protected SeriesDefinitionImpl	startEditingSeriesSchema(int seriesNr) Start editing a series definition.
int	traverse(boolean resolve, UpdatableSchemaVisitor visitor) Traverse all edited attribute and series definitions.
protected void	update() Refresh state.
protected int	visit(UpdatableSchemaVisitor visitor, SeriesDefinition seriesDef, Map<Integer,AttributeDefinition<?>> editedADs, Map<Integer,AttributeDefinition<?>> origADs)

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

dependsOnSchema, getAttributeDefinition, getAttributeDefinition, getAttributeDefinitions, getAttributeDefinitionsObject, getDependencyList, getSeriesDefinition, getSeriesDefinition, getSeriesDefinitions, getSeriesDefinitionsObject, isComplete, 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.Schema

dependsOnSchema, getSeriesDefinition, getSeriesDefinition, getSeriesDefinitions, isComplete

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

getAttributeDefinition, getAttributeDefinition, getAttributeDefinitions

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

getDatabase, getId, getSurrogate, inConstruction, isValid

Constructor Detail

UpdatableSchemaImpl

public UpdatableSchemaImpl(String name,
                           UpdatableSchema base,
                           Collection<AttributeDefinition<?>> attributeDefs,
                           Collection<SeriesDefinition> seriesDefinitions,
                           Surrogate surrogate)
                    throws T2DBException

Construct an UpdatableSchema.

Parameters:

name - a string

base - a base schema

attributeDefs - a collection of attribute definitions

seriesDefinitions - a collection of series definitions

surrogate - a surrogate

Throws:

T2DBException - if there is a duplicate attribute or series name

Method Detail

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()
               throws T2DBException

Description copied from class: SchemaImpl

Refresh state.

Overrides:

update in class SchemaImpl

Throws:

T2DBException

edit

public UpdatableSchema edit()

Description copied from interface: Schema

Return an UpdatableSchema corresponding to this schema. Successfully getting an Updatable object does not imply that any update can be successfully applied.

Specified by:

edit in interface Schema

Overrides:

edit in class SchemaImpl

Returns:

an updatable schema corresponding to this schema

destroy

public void destroy()
             throws T2DBException

Description copied from interface: UpdatableSchema

Destroy the schema. The operation fails if the schema is used.

Specified by:

destroy in interface UpdatableSchema

Throws:

T2DBException

getName

public String getName()

Description copied from interface: IncompleteSchema

Return the name of the schema or series definition.

Specified by:

getName in interface IncompleteSchema

Overrides:

getName in class SchemaImpl

Returns:

the name of the schema or the series definition

setName

public void setName(String name)
             throws T2DBException

Description copied from interface: UpdatableSchema

Set the name of the schema. May not be null or empty.

Specified by:

setName in interface UpdatableSchema

Parameters:

name - a string

Throws:

T2DBException

getBase

public UpdatableSchema getBase()

Description copied from interface: UpdatableSchema

Return the base schema if any.

Specified by:

getBase in interface UpdatableSchema

Returns:

an updatable schema or null

getPreviousBase

public UpdatableSchema getPreviousBase()

Return the base schema before it was modified with setBase(UpdatableSchema). Return the same result as getBase() if the base schema was not modified.

Returns:

a schema

setBase

public void setBase(UpdatableSchema base)
             throws T2DBException

Description copied from interface: UpdatableSchema

Set the base of the schema. When not null, the base schema may not be in construction (see DBObject.inConstruction()).

Specified by:

setBase in interface UpdatableSchema

Parameters:

base - an updatable schema or null

Throws:

T2DBException

addSeries

public SeriesDefinition addSeries(int seriesNr)
                           throws T2DBException

Description copied from interface: UpdatableSchema

Add a new series to the schema.

Specified by:

addSeries in interface UpdatableSchema

Parameters:

seriesNr - a positive number not already used

Returns:

a series definition

Throws:

T2DBException

deleteSeries

public void deleteSeries(int seriesNr)
                  throws T2DBException

Description copied from interface: UpdatableSchema

Delete a series from the schema.

Specified by:

deleteSeries in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

Throws:

T2DBException

eraseSeries

public void eraseSeries(int seriesNr)
                 throws T2DBException

Description copied from interface: UpdatableSchema

Set a series as erasing. An erasing series deletes a series with the same number inherited from a base schema during schema resolution.

Specified by:

eraseSeries in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

Throws:

T2DBException

setSeriesDescription

public void setSeriesDescription(int seriesNr,
                                 String description)
                          throws T2DBException

Description copied from interface: UpdatableSchema

Set the description of the series.

Specified by:

setSeriesDescription in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

description - a string

Throws:

T2DBException

setSeriesName

public void setSeriesName(int seriesNr,
                          String name)
                   throws T2DBException

Description copied from interface: UpdatableSchema

Set the name of a series.

Specified by:

setSeriesName in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

name - a string

Throws:

T2DBException

setSeriesType

public void setSeriesType(int seriesNr,
                          ValueType<?> type)
                   throws T2DBException

Description copied from interface: UpdatableSchema

Set the value type of the series.

Specified by:

setSeriesType in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

type - a value type

Throws:

T2DBException

setSeriesType

public void setSeriesType(int seriesNr,
                          String type)
                   throws T2DBException

Description copied from interface: UpdatableSchema

Set the value type of the series using the name of the value type.

Specified by:

setSeriesType in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

type - the name of a value type defined in the database

Throws:

T2DBException

setSeriesTimeDomain

public void setSeriesTimeDomain(int seriesNr,
                                ch.agent.t2.time.TimeDomain timeDomain)
                         throws T2DBException

Description copied from interface: UpdatableSchema

Set the time domain of the series.

Specified by:

setSeriesTimeDomain in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

timeDomain - a time domain

Throws:

T2DBException

setSeriesSparsity

public void setSeriesSparsity(int seriesNr,
                              boolean sparse)
                       throws T2DBException

Description copied from interface: UpdatableSchema

Set the sparsity of the series. By default series are not sparse.

Specified by:

setSeriesSparsity in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

sparse - true to force the series to use sparse time series, else false

Throws:

T2DBException

addAttribute

public AttributeDefinition<?> addAttribute(int attrNr)
                                    throws T2DBException

Description copied from interface: UpdatableSchema

Add a new attribute to the schema.

Specified by:

addAttribute in interface UpdatableSchema

Parameters:

attrNr - a positive number not already used

Returns:

an attribute definition

Throws:

T2DBException

deleteAttribute

public void deleteAttribute(int attrNr)
                     throws T2DBException

Description copied from interface: UpdatableSchema

Delete an attribute from the schema.

Specified by:

deleteAttribute in interface UpdatableSchema

Parameters:

attrNr - the number of an existing attribute

Throws:

T2DBException

eraseAttribute

public void eraseAttribute(int attrNr)
                    throws T2DBException

Description copied from interface: UpdatableSchema

Set an attribute as erasing. An erasing attribute deletes an attribute with the same number inherited from a base schema during schema resolution.

Specified by:

eraseAttribute in interface UpdatableSchema

Parameters:

attrNr - the number of an existing attribute

Throws:

T2DBException

setAttributeProperty

public <T> void setAttributeProperty(int attrNr,
                                     Property<T> property)
                              throws T2DBException

Description copied from interface: UpdatableSchema

Set the property of an attribute.

Specified by:

setAttributeProperty in interface UpdatableSchema

Parameters:

attrNr - the number of an existing attribute

property - a property

Throws:

T2DBException

setAttributeDefault

public <T> void setAttributeDefault(int attrNr,
                                    T defaultValue)
                             throws T2DBException

Description copied from interface: UpdatableSchema

Set the default value of an attribute.

Specified by:

setAttributeDefault in interface UpdatableSchema

Parameters:

attrNr - the number of an existing attribute

defaultValue - a value

Throws:

T2DBException

addAttribute

public AttributeDefinition<?> addAttribute(int seriesNr,
                                           int attrNr)
                                    throws T2DBException

Description copied from interface: UpdatableSchema

Add a new attribute to a series.

Specified by:

addAttribute in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

attrNr - a positive number not yet in use within the series

Returns:

an attribute definition

Throws:

T2DBException

deleteAttribute

public void deleteAttribute(int seriesNr,
                            int attrNr)
                     throws T2DBException

Description copied from interface: UpdatableSchema

Delete an attribute from a series.

Specified by:

deleteAttribute in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

attrNr - the number of an existing attribute within the series

Throws:

T2DBException

eraseAttribute

public void eraseAttribute(int seriesNr,
                           int attrNr)
                    throws T2DBException

Description copied from interface: UpdatableSchema

Set a series attribute as erasing.

Specified by:

eraseAttribute in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

attrNr - the number of an existing attribute within the series

Throws:

T2DBException

setAttributeProperty

public void setAttributeProperty(int seriesNr,
                                 int attrNr,
                                 Property<?> property)
                          throws T2DBException

Description copied from interface: UpdatableSchema

Set the property of a series attribute.

Specified by:

setAttributeProperty in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

attrNr - the number of an existing attribute within the series

property - a property

Throws:

T2DBException

setAttributeDefault

public void setAttributeDefault(int seriesNr,
                                int attrNr,
                                Object defaultValue)
                         throws T2DBException

Description copied from interface: UpdatableSchema

Set the default value of a series attribute.

Specified by:

setAttributeDefault in interface UpdatableSchema

Parameters:

seriesNr - the number of an existing series

attrNr - the number of an existing attribute within the series

defaultValue - a value

Throws:

T2DBException

startEditingSeriesSchema

protected SeriesDefinitionImpl startEditingSeriesSchema(int seriesNr)
                                                 throws T2DBException

Start editing a series definition.

Parameters:

seriesNr - a series number

Returns:

a series definition

Throws:

T2DBException

editAttributeDefinition

protected AttributeDefinitionImpl<?> editAttributeDefinition(int attrNr)
                                                      throws T2DBException

Start editing an attribute definition.

Parameters:

attrNr - an attribute number

Returns:

an attribute definition

Throws:

T2DBException

editSeriesAttributeDefinition

protected AttributeDefinitionImpl<?> editSeriesAttributeDefinition(int seriesNr,
                                                                   int attrNr,
                                                                   boolean mustExist)
                                                            throws T2DBException

Start editing a series attribute definition.

Parameters:

seriesNr - a series number

attrNr - an attribute number

mustExist - if true throw an exception instead of returning null

Returns:

an attribute definition or null if there is no such attribute definition

Throws:

T2DBException

merge

public void merge(UpdatableSchema schema)
           throws T2DBException

Merge a schema into this schema.

Parameters:

schema - a schema

Throws:

T2DBException

consolidate

protected Schema consolidate(String name,
                             Surrogate surrogate,
                             List<Surrogate> dependencyList)
                      throws T2DBException

Apply all changes and return the schema as a standard read-only schema.

Returns:

a schema

Throws:

T2DBException

resolve

public Schema resolve()
               throws T2DBException

Description copied from interface: UpdatableSchema

Resolve into a schema. Resolving an updatable schema resolves its base schema recursively, then adds, edits, and deletes attributes and series as specified in this updatable schema. Once resolved, the schema must be complete as determined by Schema.isComplete().

Specified by:

resolve in interface UpdatableSchema

Returns:

a schema

Throws:

T2DBException

traverse

public int traverse(boolean resolve,
                    UpdatableSchemaVisitor visitor)
             throws T2DBException

Traverse all edited attribute and series definitions. When reviewing updates, use the method with the resolve flag on. When writing updates to the database , use the method with the resolve flag off.

Parameters:

resolve - if true, resolve original and updated schema before traversing

visitor - a schema update visitor

Returns:

the number of components visited

Throws:

T2DBException

visit

protected int visit(UpdatableSchemaVisitor visitor,
                    SeriesDefinition seriesDef,
                    Map<Integer,AttributeDefinition<?>> editedADs,
                    Map<Integer,AttributeDefinition<?>> origADs)
             throws T2DBException

Throws:

T2DBException