ch.agent.crnickl.impl

Class NameSpace

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.ChronicleImpl

ch.agent.crnickl.impl.UpdatableChronicleImpl

ch.agent.crnickl.impl.NameSpace

All Implemented Interfaces:

Chronicle, DBObject, Updatable, UpdatableChronicle

public class NameSpace
extends UpdatableChronicleImpl

A NameSpace object implements the top-level chronicle. The top-level chronicle exists only virtually, and is never stored.

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
NameSpace(String name, String description, Surrogate surrogate) Construct a name space, also known as top level chronicle.

Method Summary

Modifier and Type	Method and Description
<T> UpdatableSeries<T>	createSeries(String name) Always throws an exception.
void	destroy() Always throws an exception.
UpdatableChronicle	edit() Return this object.
boolean	equals(Object obj)
Attribute<?>	getAttribute(String name, boolean mustExist) Always throws an exception.
Chronicle	getCollection() Return null.
String	getDescription(boolean full) Return the description of the chronicle.
List<String>	getDescriptions() Return the list of all descriptions along the chronicle chain.
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 null.
<T> Series<T>	getSeries(String name) Always throws an exception.
int	hashCode()
boolean	isTopChronicle() Return true.
void	setAttribute(Attribute<?> value) Always throws an exception.
void	setDescription(String description) Always throws an exception.
void	setName(String name) Always throws an exception.
String	toString()
<T> UpdatableSeries<T>	updateSeries(String name) Always throws an exception.

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

applyUpdates, createChronicle, setCollection, setSchema, update, updateAttributes

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

findChronicle, getAttributes, getChronicle, getMembers, getSeries, getSeries, isMemberOf

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

getDatabase, getId, getSurrogate, 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, getMembers, getSeries, getSeries, isMemberOf

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

getDatabase, getId, getSurrogate, inConstruction, isValid

Constructor Detail

NameSpace

public NameSpace(String name,
                 String description,
                 Surrogate surrogate)

Construct a name space, also known as top level chronicle. By convention, the name space object is named after its database.

Parameters:

name - the name of the database

description - a string

surrogate - a surrogate

Method Detail

edit

public UpdatableChronicle edit()

Return this object.

Specified by:

edit in interface Chronicle

Overrides:

edit in class UpdatableChronicleImpl

Returns:

this object

isTopChronicle

public boolean isTopChronicle()

Return true.

Specified by:

isTopChronicle in interface Chronicle

Overrides:

isTopChronicle in class ChronicleImpl

Returns:

true

getCollection

public Chronicle getCollection()
                        throws T2DBException

Return null.

Specified by:

getCollection in interface Chronicle

Overrides:

getCollection in class UpdatableChronicleImpl

Returns:

null

Throws:

T2DBException

getSchema

public Schema getSchema(boolean effective)
                 throws T2DBException

Return null.

Specified by:

getSchema in interface Chronicle

Overrides:

getSchema in class UpdatableChronicleImpl

Parameters:

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

Returns:

null

Throws:

T2DBException

getName

public String getName(boolean full)
               throws T2DBException

Return the name of the chronicle.

The simple name and the full name are identical. By convention the name space is named after the database.

Specified by:

getName in interface Chronicle

Overrides:

getName in class UpdatableChronicleImpl

Parameters:

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

Returns:

the name of the top level 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

Overrides:

getNames in class ChronicleImpl

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

Overrides:

getDescription in class UpdatableChronicleImpl

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

Overrides:

getDescriptions in class ChronicleImpl

Returns:

the list of descriptions along the chronicle chain

Throws:

T2DBException

getAttribute

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

Always throws an exception.

Specified by:

getAttribute in interface Chronicle

Overrides:

getAttribute in class UpdatableChronicleImpl

Parameters:

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

Always throws an exception.

Specified by:

getSeries in interface Chronicle

Overrides:

getSeries in class UpdatableChronicleImpl

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

createSeries

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

Always throws an exception.

Specified by:

createSeries in interface UpdatableChronicle

Overrides:

createSeries in class UpdatableChronicleImpl

Parameters:

name - a series name defined in the schema

Returns:

an updatable series

Throws:

T2DBException

updateSeries

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

Always throws an exception.

Specified by:

updateSeries in interface UpdatableChronicle

Overrides:

updateSeries in class UpdatableChronicleImpl

Parameters:

name - a series name defined in the schema

Returns:

an updatable series or null

Throws:

T2DBException

setName

public void setName(String name)
             throws T2DBException

Always throws an exception.

Specified by:

setName in interface UpdatableChronicle

Overrides:

setName in class UpdatableChronicleImpl

Parameters:

name - a string

Throws:

T2DBException

setDescription

public void setDescription(String description)
                    throws T2DBException

Always throws an exception.

Specified by:

setDescription in interface UpdatableChronicle

Overrides:

setDescription in class UpdatableChronicleImpl

Parameters:

description - a string

Throws:

T2DBException

setAttribute

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

Always throws an exception.

Specified by:

setAttribute in interface UpdatableChronicle

Overrides:

setAttribute in class UpdatableChronicleImpl

Parameters:

value - an attribute

Throws:

T2DBException

destroy

public void destroy()
             throws T2DBException

Always throws an exception.

Specified by:

destroy in interface UpdatableChronicle

Overrides:

destroy in class UpdatableChronicleImpl

Throws:

T2DBException

hashCode

public int hashCode()

Overrides:

hashCode in class DBObjectImpl

equals

public boolean equals(Object obj)

Overrides:

equals in class DBObjectImpl

toString

public String toString()

Overrides:

toString in class ChronicleImpl