ch.agent.crnickl.impl

Class SchemaImpl

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.SchemaImpl

All Implemented Interfaces:

DBObject, IncompleteSchema, Schema

Direct Known Subclasses:

UpdatableSchemaImpl

public class SchemaImpl
extends DBObjectImpl
implements Schema

Default implementation of Schema.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchemaImpl(boolean updatable, String name, Collection<AttributeDefinition<?>> attributeDefs, Collection<SeriesDefinition> seriesDefinitions, Surrogate surrogate, List<Surrogate> dependencyList) Construct a Schema.
	SchemaImpl(String name, Collection<AttributeDefinition<?>> attributeDefs, Collection<SeriesDefinition> seriesDefinitions, Surrogate surrogate, List<Surrogate> dependencyList) Construct a Schema.

Method Summary

Modifier and Type	Method and Description
boolean	dependsOnSchema(Schema schema) Return true if the schema depends on the schema specified.
UpdatableSchema	edit() Return an UpdatableSchema corresponding to this schema.
AttributeDefinition<?>	getAttributeDefinition(int number, boolean mustExist) Return the attribute definition with the given attribute number.
AttributeDefinition<?>	getAttributeDefinition(String name, boolean mustExist) Return the attribute definition with the given attribute name.
Collection<AttributeDefinition<?>>	getAttributeDefinitions() Return the collection of all attribute definitions.
protected SchemaComponents<AttributeDefinition<?>>	getAttributeDefinitionsObject() Return the object managing attribute definitions.
List<Surrogate>	getDependencyList() Return the list of schema surrogates which this schema extends.
String	getName() Return the name of the schema or series definition.
SeriesDefinition	getSeriesDefinition(int number, boolean mustExist) Return the series definition with the given series number.
SeriesDefinition	getSeriesDefinition(String name, boolean mustExist) Return the series definition with the given series name.
Collection<SeriesDefinition>	getSeriesDefinitions() Return all series definitions of this schema.
protected SchemaComponents<SeriesDefinition>	getSeriesDefinitionsObject() Return the object managing series definitions.
boolean	isComplete() Return true if the schema is complete.
String	toString()
protected void	update() Refresh state.

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

SchemaImpl

public SchemaImpl(String name,
                  Collection<AttributeDefinition<?>> attributeDefs,
                  Collection<SeriesDefinition> seriesDefinitions,
                  Surrogate surrogate,
                  List<Surrogate> dependencyList)
           throws T2DBException

Construct a Schema.

Parameters:

name - a string

attributeDefs - a collection of attribute definitions

seriesDefinitions - a collection of series definitions

surrogate - a surrogate

dependencyList - a list of surrogates

Throws:

T2DBException - if there is a duplicate attribute or series name

SchemaImpl

protected SchemaImpl(boolean updatable,
                     String name,
                     Collection<AttributeDefinition<?>> attributeDefs,
                     Collection<SeriesDefinition> seriesDefinitions,
                     Surrogate surrogate,
                     List<Surrogate> dependencyList)
              throws T2DBException

Construct a Schema.

Parameters:

updatable - set to true when invoked by an UpdatableSchemaImpl constructor, set to false when invoked by a SchemaImpl constructor

name - a string

attributeDefs - a collection of attribute definitions

seriesDefinitions - a collection of series definitions

surrogate - a surrogate

dependencyList - a list of surrogates

Throws:

T2DBException - if there is a duplicate attribute or series name

Method Detail

update

protected void update()
               throws T2DBException

Refresh state.

Throws:

T2DBException

isComplete

public boolean isComplete()

Description copied from interface: Schema

Return true if the schema is complete. A schema is complete if all its components are complete. When a schema is complete it can be used in a chronicle. See also SchemaComponent.isComplete().

Specified by:

isComplete in interface Schema

Returns:

true if the schema is complete

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

Returns:

an updatable schema corresponding to this schema

getName

public String getName()

Description copied from interface: IncompleteSchema

Return the name of the schema or series definition.

Specified by:

getName in interface IncompleteSchema

Returns:

the name of the schema or the series definition

getSeriesDefinitions

public Collection<SeriesDefinition> getSeriesDefinitions()

Description copied from interface: Schema

Return all series definitions of this schema.

Specified by:

getSeriesDefinitions in interface Schema

Returns:

the collection of series definitions

getSeriesDefinition

public SeriesDefinition getSeriesDefinition(String name,
                                            boolean mustExist)
                                     throws T2DBException

Description copied from interface: Schema

Return the series definition with the given series name. If there is no such definition, return null or throw an exception, depending on the value of the mustExist parameter.

Specified by:

getSeriesDefinition in interface Schema

Parameters:

name - the series defined

mustExist - if true throw an exception instead of returning null

Returns:

a series definition or null (only when mustExist is false)

Throws:

T2DBException

getSeriesDefinition

public SeriesDefinition getSeriesDefinition(int number,
                                            boolean mustExist)
                                     throws T2DBException

Description copied from interface: Schema

Return the series definition with the given series number. If there is no such definition, return null or throw an exception, depending on the value of the mustExist parameter.

Specified by:

getSeriesDefinition in interface Schema

Parameters:

number - the series defined

mustExist - if true throw an exception instead of returning null

Returns:

a series definition or null (only when mustExist is false)

Throws:

T2DBException

getAttributeDefinitions

public Collection<AttributeDefinition<?>> getAttributeDefinitions()

Description copied from interface: IncompleteSchema

Return the collection of all attribute definitions. The collection is sorted by attribute number. For a schema, the result does not include any series attribute definition.

Specified by:

getAttributeDefinitions in interface IncompleteSchema

Returns:

the collection of all attribute definitions

getAttributeDefinition

public AttributeDefinition<?> getAttributeDefinition(String name,
                                                     boolean mustExist)
                                              throws T2DBException

Description copied from interface: IncompleteSchema

Return the attribute definition with the given attribute name. The mustExist parameter determines behavior when nothing is found: exception or null result.

Specified by:

getAttributeDefinition in interface IncompleteSchema

Parameters:

name - the name of the attribute

mustExist - if true throw an exception instead of returning null

Returns:

an attribute definition or null (only when mustExist is false)

Throws:

T2DBException

getAttributeDefinition

public AttributeDefinition<?> getAttributeDefinition(int number,
                                                     boolean mustExist)
                                              throws T2DBException

Description copied from interface: IncompleteSchema

Return the attribute definition with the given attribute number. The mustExist parameter determines behavior when nothing is found: exception or null result.

Specified by:

getAttributeDefinition in interface IncompleteSchema

Parameters:

number - the number of the attribute

mustExist - if true throw an exception instead of returning null

Returns:

an attribute definition or null (only when mustExist is false)

Throws:

T2DBException

getAttributeDefinitionsObject

protected SchemaComponents<AttributeDefinition<?>> getAttributeDefinitionsObject()

Return the object managing attribute definitions.

Returns:

the object managing attribute definitions

getSeriesDefinitionsObject

protected SchemaComponents<SeriesDefinition> getSeriesDefinitionsObject()

Return the object managing series definitions.

Returns:

the object managing series definitions

getDependencyList

public List<Surrogate> getDependencyList()

Return the list of schema surrogates which this schema extends.

Returns:

a list of schema surrogates

dependsOnSchema

public boolean dependsOnSchema(Schema schema)

Description copied from interface: Schema

Return true if the schema depends on the schema specified.

Specified by:

dependsOnSchema in interface Schema

Parameters:

schema - a schema

Returns:

true if the schema inherits from a given schema

toString

public String toString()

Overrides:

toString in class Object