ch.agent.crnickl.api

Interface IncompleteSchema

All Known Subinterfaces:

Schema, SeriesDefinition, UpdatableSchema

All Known Implementing Classes:

SchemaImpl, SeriesDefinitionImpl, UpdatableSchemaImpl

public interface IncompleteSchema

An IncompleteSchema provides common behavior to Schema and SeriesDefinition. Both can have a number of Attributes defined.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
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.
String	getName() Return the name of the schema or series definition.

Method Detail

getName

String getName()

Return the name of the schema or series definition.

Returns:

the name of the schema or the series definition

getAttributeDefinitions

Collection<AttributeDefinition<?>> getAttributeDefinitions()

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.

Returns:

the collection of all attribute definitions

getAttributeDefinition

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

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

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

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

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

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