ch.agent.crnickl.api

Interface SeriesDefinition

All Superinterfaces:

Comparable<SeriesDefinition>, IncompleteSchema, SchemaComponent

All Known Implementing Classes:

SeriesDefinitionImpl

public interface SeriesDefinition
extends SchemaComponent, IncompleteSchema, Comparable<SeriesDefinition>

A SeriesDefinition is a component part of a Schema and defines a Series. Like a schema, a series definition can define a number of Attributes.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
Collection<AttributeDefinition<?>>	getCustomAttributeDefinitions() Return the collection of attribute definitions which are not built-in.
String	getDescription() Return the description of the series.
ch.agent.t2.time.TimeDomain	getTimeDomain() Return the time domain of the series.
ValueType<?>	getValueType() Return the value type of the series.
boolean	isSparse() Return true to force the series to use sparse time series.

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

consolidate, copy, edit, edit, getName, getNumber, isComplete, isErasing

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

getAttributeDefinition, getAttributeDefinition, getAttributeDefinitions, getName

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDescription

String getDescription()

Return the description of the series.

Returns:

the series description

Throws:

T2DBException

getTimeDomain

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

Return the time domain of the series.

Returns:

the time domain of the series

getValueType

ValueType<?> getValueType()

Return the value type of the series.

Returns:

the value type of the series

isSparse

boolean isSparse()

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

Returns:

true if time series are sparse

getCustomAttributeDefinitions

Collection<AttributeDefinition<?>> getCustomAttributeDefinitions()

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

Returns:

the collection of non-built-in attribute definitions