ch.agent.crnickl.impl

Class AttributeDefinitionImpl<T>

java.lang.Object

ch.agent.crnickl.impl.SchemaComponentImpl

ch.agent.crnickl.impl.AttributeDefinitionImpl<T>

Type Parameters:

T - the underlying data type of the attribute

All Implemented Interfaces:

AttributeDefinition<T>, SchemaComponent, Containable, Comparable<AttributeDefinition<T>>

public class AttributeDefinitionImpl<T>
extends SchemaComponentImpl
implements AttributeDefinition<T>

Default implementation of AttributeDefinition.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
AttributeDefinitionImpl(int seriesNr, int number, Property<T> property, T value) Construct an attribute definition.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AttributeDefinition<T> o)
SchemaComponent	copy() Return a copy.
void	edit(SchemaComponent component) Edit the component, taking the parameter as a template.
boolean	equals(Object obj)
Attribute<T>	getAttribute() Return the attribute.
String	getName() Return the name of the component.
int	getNumber() Return the number of the component.
Property<T>	getProperty() Return the attribute's property.
T	getValue() Return the attribute's default value.
int	hashCode()
boolean	isComplete() Return true if the component is complete and can be used.
boolean	isErasing() Return true if the definition removes an inherited definition.
void	setErasing(boolean erasing) Set the erasing mode of the definition.
void	setProperty(Property<T> property) Set the property.
void	setValue(Object value) Set the default value.
String	toString()
<S> AttributeDefinition<S>	typeCheck(Class<S> type) Cast the attribute definition to the type specified.

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

checkEdit, consolidate, edit, nameChanged, setContainer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

consolidate, edit

Constructor Detail

AttributeDefinitionImpl

public AttributeDefinitionImpl(int seriesNr,
                               int number,
                               Property<T> property,
                               T value)
                        throws T2DBException

Construct an attribute definition.

Parameters:

seriesNr - the series number or zero if a chronicle attribute

number - the attribute number

property - a property

value - a default value or null

Throws:

T2DBException

Method Detail

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

getProperty

public Property<T> getProperty()

Description copied from interface: AttributeDefinition

Return the attribute's property.

Specified by:

getProperty in interface AttributeDefinition<T>

Returns:

the property of the attribute

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 SchemaComponent

Returns:

the name of the component or null

getValue

public T getValue()

Description copied from interface: AttributeDefinition

Return the attribute's default value.

Specified by:

getValue in interface AttributeDefinition<T>

Returns:

the default value of the attribute

getAttribute

public Attribute<T> getAttribute()

Description copied from interface: AttributeDefinition

Return the attribute. It is forbidden to use this method while the definition is not complete. Using the method when isComplete() returns false throws an IllegalStateException

Specified by:

getAttribute in interface AttributeDefinition<T>

Returns:

the attribute

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(AttributeDefinition<T> o)

Specified by:

compareTo in interface Comparable<AttributeDefinition<T>>

setErasing

public void setErasing(boolean erasing)

Set the erasing mode of the definition. The definition must be in edit mode. Setting erasing mode resets the property and the value.

Parameters:

erasing - if true the definition removes an inherited definition

setProperty

public void setProperty(Property<T> property)
                 throws T2DBException

Set the property. The definition must be in edit mode. The property name is also used as the attribute name. Setting a non-null property resets erasing mode.

Parameters:

property - a property or null

Throws:

T2DBException

setValue

public void setValue(Object value)
              throws T2DBException

Set the default value. The definition must be in edit mode. Setting a non-null value resets erasing mode.

Parameters:

value - a value or null

Throws:

T2DBException

edit

public void edit(SchemaComponent component)

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

copy

public SchemaComponent copy()

Description copied from interface: SchemaComponent

Return a copy.

Specified by:

copy in interface SchemaComponent

Returns:

a copy

typeCheck

public <S> AttributeDefinition<S> typeCheck(Class<S> type)
                                     throws T2DBException

Description copied from interface: AttributeDefinition

Cast the attribute definition to the type specified. The method performs type checking at run time and allows to catch type errors in controlled fashion.

Specified by:

typeCheck in interface AttributeDefinition<T>

Parameters:

type - the underlying type required

Returns:

the attribute definition cast to the type specified

Throws:

T2DBException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object