ch.agent.crnickl.impl

Class ChronicleImpl

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.ChronicleImpl

All Implemented Interfaces:

Chronicle, DBObject

Direct Known Subclasses:

UpdatableChronicleImpl

public class ChronicleImpl
extends DBObjectImpl
implements Chronicle

Default implementation of Chronicle.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChronicleImpl.RawData RawData encapsulates the low level members of a chronicle.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ChronicleImpl(ChronicleImpl.RawData rawData) Construct a Chronicle.
protected	ChronicleImpl(String name, String description, Chronicle parent, Schema schema, Surrogate surrogate) Construct a Chronicle.
	ChronicleImpl(Surrogate surrogate) Construct a Chronicle.

Method Summary

Modifier and Type	Method and Description
UpdatableChronicle	edit() Return an UpdatableChronicle corresponding to this chronicle.
Chronicle	findChronicle(String fullName, boolean mustExist) Find the chronicle with the the given full name.
Attribute<?>	getAttribute(String attrName, boolean mustExist) Return the attribute with the given name.
Collection<Attribute<?>>	getAttributes() Return all the chronicle's attributes.
Chronicle	getChronicle(String simpleName, boolean mustExist) Return the direct child of this chronicle with the given simple name.
Chronicle	getCollection() Return the chronicle to which this chronicle belongs.
String	getDescription(boolean full) Return the description of the chronicle.
List<String>	getDescriptions() Return the list of all descriptions along the chronicle chain.
Collection<Chronicle>	getMembers() Return the direct members of this chronicle seen as a collection.
String	getName(boolean full) Return the name of the chronicle.
List<String>	getNames() Return the list of all names along the chronicle chain.
Schema	getSchema(boolean effective) Return the chronicle's schema.
Collection<Series<?>>	getSeries() Return all existing series in this chronicle.
<T> Series<T>	getSeries(String name) Return the series with the given simple name.
<T> Series<T>[]	getSeries(String[] names, Class<T> type, boolean mustBeDefined) Return an array of series corresponding to the names requested.
boolean	isMemberOf(Chronicle collection) Return true if this chronicle is member of the collection.
boolean	isTopChronicle() Return true if this is the top chronicle.
String	toString()
protected void	update() Force refresh of state on next access.

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.DBObject

getDatabase, getId, getSurrogate, inConstruction, isValid

Constructor Detail

ChronicleImpl

public ChronicleImpl(Surrogate surrogate)

Construct a Chronicle.

Parameters:

surrogate - a chronicle surrogate

ChronicleImpl

protected ChronicleImpl(String name,
                        String description,
                        Chronicle parent,
                        Schema schema,
                        Surrogate surrogate)

Construct a Chronicle.

Parameters:

name - a string

description - a string

parent - a chronicle or null

schema - a schema or null

surrogate - a surrogate

ChronicleImpl

public ChronicleImpl(ChronicleImpl.RawData rawData)
              throws T2DBException

Construct a Chronicle.

Parameters:

rawData - a raw data object

Throws:

T2DBException

Method Detail

getChronicle

public Chronicle getChronicle(String simpleName,
                              boolean mustExist)
                       throws T2DBException

Description copied from interface: Chronicle

Return the direct child of this chronicle with the given simple name. The mustExist parameter determines behavior when nothing is found: exception or null result.

Specified by:

getChronicle in interface Chronicle

Parameters:

simpleName - a simple name

mustExist - if true throw an exception instead of returning null

Returns:

a chronicle or null (only when mustExist is false)

Throws:

T2DBException

findChronicle

public Chronicle findChronicle(String fullName,
                               boolean mustExist)
                        throws T2DBException

Description copied from interface: Chronicle

Find the chronicle with the the given full name. Throw an exception if there is no such chronicle. When the parameter mustExist is false, a non-existing chronicle is tolerated when it is at the end of the chain of simple names.

Specified by:

findChronicle in interface Chronicle

Parameters:

fullName - the full name of the chronicle

mustExist - if true throw an exception instead of returning null

Returns:

a chronicle or null (only when mustExist is false)

Throws:

T2DBException

isTopChronicle

public boolean isTopChronicle()

Description copied from interface: Chronicle

Return true if this is the top chronicle.

Specified by:

isTopChronicle in interface Chronicle

Returns:

true if this is the top chronicle

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

Returns:

an updatable chronicle corresponding to this chronicle

update

protected void update()

Force refresh of state on next access.

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

Returns:

the parent chronicle or null

Throws:

T2DBException

getMembers

public Collection<Chronicle> getMembers()
                                 throws T2DBException

Description copied from interface: Chronicle

Return the direct members of this chronicle seen as a collection.

Specified by:

getMembers in interface Chronicle

Returns:

a collection of chronicles

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

Parameters:

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

Returns:

the schema of the chronicle or null

Throws:

T2DBException

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

Parameters:

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

Returns:

the full or the simple name of the chronicle

Throws:

T2DBException

getNames

public List<String> getNames()
                      throws T2DBException

Description copied from interface: Chronicle

Return the list of all names along the chronicle chain. The last element is this chronicle's simple name. The previous element is the name of the parent. The element before that is the name of the parent's parent, and so on until the top chronicle.

Specified by:

getNames in interface Chronicle

Returns:

the list of names along the chronicle chain

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

Parameters:

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

Returns:

the full or the simple description of the chronicle

Throws:

T2DBException

getDescriptions

public List<String> getDescriptions()
                             throws T2DBException

Description copied from interface: Chronicle

Return the list of all descriptions along the chronicle chain. The last element is this chronicle's description. The previous element is the description of the parent. The element before that is the description of the parent's parent, and so on until the top chronicle.

Specified by:

getDescriptions in interface Chronicle

Returns:

the list of descriptions along the chronicle chain

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

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

getSeries

public <T> Series<T> getSeries(String name)
                        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

Type Parameters:

T - the data type of the underlying time series

Parameters:

name - the simple name if the series

Returns:

a series or null

Throws:

T2DBException

getSeries

public <T> Series<T>[] getSeries(String[] names,
                                 Class<T> type,
                                 boolean mustBeDefined)
                          throws T2DBException

Description copied from interface: Chronicle

Return an array of series corresponding to the names requested. If a name is undefined an exception is thrown, unless the parameter mustBeDefined is false (in which case the series is treated like a missing series). If the value type does not correspond to the type requested an exception is thrown. If a series is missing (there are no values), a null is returned in its place.

Specified by:

getSeries in interface Chronicle

Type Parameters:

T - the data type of the underlying time series

Parameters:

names - the names of the series requested

type - the expected type or null to bypass enforcing a type

mustBeDefined - if true throw an exception when a name is undefined

Returns:

an array of series with the same length as the name array

Throws:

T2DBException

getAttributes

public Collection<Attribute<?>> getAttributes()
                                       throws T2DBException

Description copied from interface: Chronicle

Return all the chronicle's attributes.

Specified by:

getAttributes in interface Chronicle

Returns:

all the attributes of the chronicle

Throws:

T2DBException

getSeries

public Collection<Series<?>> getSeries()
                                throws T2DBException

Description copied from interface: Chronicle

Return all existing series in this chronicle. The result includes all series which have been created, whether empty or not.

Specified by:

getSeries in interface Chronicle

Returns:

all existing series of the chronicle

Throws:

T2DBException

isMemberOf

public boolean isMemberOf(Chronicle collection)
                   throws T2DBException

Description copied from interface: Chronicle

Return true if this chronicle is member of the collection. A collection of chronicles is simply a chronicle which contains chronicles. The contained chronicles can themselves contain more chronicles.

Specified by:

isMemberOf in interface Chronicle

Parameters:

collection - a chronicle

Returns:

true if this chronicle is a member of the collection represented by the parameter

Throws:

T2DBException

toString

public String toString()

Overrides:

toString in class Object