ch.agent.crnickl.impl

Class SeriesDefinitionImpl

java.lang.Object

ch.agent.crnickl.impl.SchemaComponentImpl

ch.agent.crnickl.impl.SeriesDefinitionImpl

All Implemented Interfaces:

IncompleteSchema, SchemaComponent, SeriesDefinition, Containable, Comparable<SeriesDefinition>

public class SeriesDefinitionImpl
extends SchemaComponentImpl
implements SeriesDefinition

Default implementation of SeriesDefinition.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
SeriesDefinitionImpl(int number, String description, Collection<AttributeDefinition<?>> attributeDefs) Construct a SeriesDefinition.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SeriesDefinition o)
SchemaComponent	copy() Return a copy.
void	edit(SchemaComponent component) Edit the component, taking the parameter as a template.
AttributeDefinition<?>	getAttributeDefinition(int attrNr, 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 the series' attribute definitions.
Collection<AttributeDefinition<?>>	getCustomAttributeDefinitions() Return the collection of attribute definitions which are not built-in.
String	getDescription() Return the description of the series.
String	getName() Return the name of the component.
int	getNumber() Return the number of the component.
ch.agent.t2.time.TimeDomain	getTimeDomain() Return the time domain of the series.
ValueType<?>	getValueType() Return the value type of the series.
boolean	isComplete() Return true if the component is complete and can be used.
boolean	isErasing() Return true if the definition removes an inherited definition.
boolean	isSparse() Return true to force the series to use sparse time series.
void	setContainer(SchemaComponentContainer container) Set a container.
void	setDescription(String description) Set the description.
void	setErasing(boolean erasing) Set the erasing mode.
String	toString()

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

checkEdit, consolidate, edit, nameChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

consolidate, edit

Constructor Detail

SeriesDefinitionImpl

public SeriesDefinitionImpl(int number,
                            String description,
                            Collection<AttributeDefinition<?>> attributeDefs)
                     throws T2DBException

Construct a SeriesDefinition.

Parameters:

number - a positive number

description - a string

attributeDefs - a collection of attribute definitions

Throws:

T2DBException

Method Detail

setContainer

public void setContainer(SchemaComponentContainer container)

Description copied from interface: Containable

Set a container.

Specified by:

setContainer in interface Containable

Overrides:

setContainer in class SchemaComponentImpl

Parameters:

container - a container or null

isComplete

public boolean isComplete()

Description copied from interface: SchemaComponent

Return true if the component is complete and can be used. All the components of a Schema defining an actual Chronicle must be complete. If the component is an AttributeDefinition, it is complete when the property of the attribute is defined and the default value is valid. If the component is a SeriesDefinition, it is complete when the name, the type, and the time domain of the series are defined, and all the series attributes are complete.

Specified by:

isComplete in interface SchemaComponent

Returns:

true if the component can be used

isErasing

public boolean isErasing()

Description copied from interface: SchemaComponent

Return true if the definition removes an inherited definition. This method is relevant during execution of UpdatableSchema.resolve().

Specified by:

isErasing in interface SchemaComponent

Returns:

true if the definition removes an inherited definition

getNumber

public int getNumber()

Description copied from interface: SchemaComponent

Return the number of the component. The number is always positive and is unique within its container.

Specified by:

getNumber in interface SchemaComponent

Returns:

a positive number

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

getCustomAttributeDefinitions

public Collection<AttributeDefinition<?>> getCustomAttributeDefinitions()

Description copied from interface: SeriesDefinition

Return the collection of attribute definitions which are not built-in. The collection is sorted by attribute number.

Specified by:

getCustomAttributeDefinitions in interface SeriesDefinition

Returns:

the collection of non-built-in 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 attrNr,
                                                     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:

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

getDescription

public String getDescription()

Description copied from interface: SeriesDefinition

Return the description of the series.

Specified by:

getDescription in interface SeriesDefinition

Returns:

the series description

getName

public String getName()

Description copied from interface: SchemaComponent

Return the name of the component. The name can be null when the component is not complete. The name is unique within its container.

Specified by:

getName in interface IncompleteSchema

Specified by:

getName in interface SchemaComponent

Returns:

the name of the component or null

getTimeDomain

public ch.agent.t2.time.TimeDomain getTimeDomain()

Description copied from interface: SeriesDefinition

Return the time domain of the series.

Specified by:

getTimeDomain in interface SeriesDefinition

Returns:

the time domain of the series

getValueType

public ValueType<?> getValueType()

Description copied from interface: SeriesDefinition

Return the value type of the series.

Specified by:

getValueType in interface SeriesDefinition

Returns:

the value type of the series

isSparse

public boolean isSparse()

Description copied from interface: SeriesDefinition

Return true to force the series to use sparse time series. By default series leave the choice to a lower layer of the software.

Specified by:

isSparse in interface SeriesDefinition

Returns:

true if time series are sparse

setErasing

public void setErasing(boolean erasing)

Set the erasing mode. Setting erasing mode resets the description and all attributes.

Parameters:

erasing - true if the definition should erase an inherited definition

setDescription

public void setDescription(String description)

Set the description.

Parameters:

description - a string

getAttributeDefinitionsObject

protected SchemaComponents<AttributeDefinition<?>> getAttributeDefinitionsObject()

Return the object managing the series' attribute definitions.

Returns:

a collection of managed attribute definitions

edit

public void edit(SchemaComponent component)
          throws T2DBException

Description copied from interface: SchemaComponent

Edit the component, taking the parameter as a template. The parameter must be of the same class as this component.

Specified by:

edit in interface SchemaComponent

Parameters:

component - a component serving as template

Throws:

T2DBException

copy

public SchemaComponent copy()

Description copied from interface: SchemaComponent

Return a copy.

Specified by:

copy in interface SchemaComponent

Returns:

a copy

compareTo

public int compareTo(SeriesDefinition o)

Specified by:

compareTo in interface Comparable<SeriesDefinition>

toString

public String toString()

Overrides:

toString in class Object