ch.agent.crnickl.impl

Class SchemaComponents<T extends SchemaComponent>

java.lang.Object

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

Type Parameters:

T - the type of SchemaComponent managed by the collection

All Implemented Interfaces:

Containable, SchemaComponentContainer

public class SchemaComponents<T extends SchemaComponent>
extends Object
implements SchemaComponentContainer, Containable

SchemaComponents is a managed collection of SchemaComponent objects. Components can be added, deleted, edited. Components have a name, which can be modified in edit mode. Names, when not null, must be unique. Note that a complete component has a non-null name.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
SchemaComponents(Collection<T> components) Construct a managed collection of schema components.

Method Summary

Modifier and Type	Method and Description
boolean	addComponent(T component) Add a new component.
void	consolidate() Leave edit mode.
boolean	deleteComponent(int number) If a component with the given number exists remove it and return true.
protected void	edit() Enter edit mode.
T	editComponent(int number) Enter edit mode and edit the component specified.
T	getComponent(int number) Return the component with the given number.
T	getComponent(String name) Return the component with the given name.
Collection<T>	getComponents() Return all components.
protected Map<Integer,T>	getMap()
boolean	isComplete() Return true if all components are complete.
void	nameChanged(boolean attribute, String oldName, String newName) Tell the container that the name of a component was changed.
void	setContainer(SchemaComponentContainer container) Set a container.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaComponents

public SchemaComponents(Collection<T> components)
                 throws T2DBException

Construct a managed collection of schema components.

Parameters:

components - a collection of initial components to add

Throws:

T2DBException - if components contain a duplicate name or number

Method Detail

setContainer

public void setContainer(SchemaComponentContainer container)

Description copied from interface: Containable

Set a container.

Specified by:

setContainer in interface Containable

Parameters:

container - a container or null

nameChanged

public void nameChanged(boolean attribute,
                        String oldName,
                        String newName)
                 throws T2DBException

Description copied from interface: SchemaComponentContainer

Tell the container that the name of a component was changed. The arguments old name and new name have different values, one of which can be null.

Specified by:

nameChanged in interface SchemaComponentContainer

Parameters:

attribute - if true the changes concerns an attribute, else a series

oldName - old name

newName - new name

Throws:

T2DBException - if a duplicate is found

isComplete

public boolean isComplete()

Return true if all components are complete.

Returns:

true if all components are complete

getComponents

public Collection<T> getComponents()

Return all components. Components are sorted by number.

Returns:

the collection of components

getMap

protected Map<Integer,T> getMap()

getComponent

public T getComponent(int number)

Return the component with the given number. Return null if not found.

Parameters:

number - a positive number

Returns:

the component with the given number

getComponent

public T getComponent(String name)

Return the component with the given name. Return null if not found.

Parameters:

name - a string

Returns:

the component with the given name

editComponent

public T editComponent(int number)

Enter edit mode and edit the component specified. Return the component with the given number or null if not found. If the component is not null, its edit mode is set.

Parameters:

number - a positive number

Returns:

a component or null

Throws:

T2DBException

addComponent

public boolean addComponent(T component)
                     throws T2DBException

Add a new component. If there is no component with the same number, set its edit mode and add it to the collection of components and return true. Else do nothing and return false.

Parameters:

component - a component

Returns:

true if the component was added else false

Throws:

T2DBException

deleteComponent

public boolean deleteComponent(int number)

If a component with the given number exists remove it and return true. Else return false.

Parameters:

number - a positive number

Returns:

true unless the component was not found

edit

protected void edit()

Enter edit mode. The index is discarded.

consolidate

public void consolidate()

Leave edit mode.

toString

public String toString()

Overrides:

toString in class Object