org.qedeq.kernel.bo.module
Class KernelModuleReferenceList

java.lang.Object
  org.qedeq.kernel.bo.module.KernelModuleReferenceList

All Implemented Interfaces:

ModuleReferenceList

public class KernelModuleReferenceList
extends java.lang.Object
implements ModuleReferenceList

Represents a reference list of modules. Every entry has a symbolic name for one referenced QEDEQ module. This module label acts as a prefix for all references to that module. The module label must be an unique String.

Author:

Michael Meyling

Constructor Summary

KernelModuleReferenceList()
Constructs an empty list of module references.

Method Summary

void	add(ModuleContext context, java.lang.String label, QedeqBo prop) Add module reference to list.
void	addLabelUnique(ModuleContext context, java.lang.String label, QedeqBo prop) Add module reference to list.
void	clear() Empty reference list.
boolean	contains(KernelQedeqBo bo) Is the given QEDEQ BO already in this list?
boolean	equals(java.lang.Object obj)
KernelQedeqBo	getKernelQedeqBo(int index) Get QedeqBo of referenced module.
KernelQedeqBo	getKernelQedeqBo(java.lang.String label) Get KernelQedeqBo of referenced module via label.
java.lang.String	getLabel(int index) Get label for certain module.
ModuleContext	getModuleContext(int index) Get import context of referenced module.
QedeqBo	getQedeqBo(int index) Get properties of referenced module.
QedeqBo	getQedeqBo(java.lang.String label) Get QedeqBo of referenced module via label.
int	hashCode()
void	remove(KernelQedeqBo bo) Delete a given QEDEQ BO already from list.
void	set(KernelModuleReferenceList list) Copy all list entry references of list to this instance.
int	size() Get number of module references.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KernelModuleReferenceList

public KernelModuleReferenceList()

Constructs an empty list of module references.

Method Detail

add

public void add(ModuleContext context,
                java.lang.String label,
                QedeqBo prop)
         throws IllegalModuleDataException

Add module reference to list.

Parameters:

context - Within this context.

label - Referenced module gets this label. Must not be null or empty.

prop - Referenced module has this properties. Must not be null.

Throws:

IllegalModuleDataException - The label is empty or null.

addLabelUnique

public void addLabelUnique(ModuleContext context,
                           java.lang.String label,
                           QedeqBo prop)
                    throws IllegalModuleDataException

Add module reference to list.

Parameters:

context - Within this context.

label - Referenced module gets this label. Must not be null or empty.

prop - Referenced module has this properties. Must not be null.

Throws:

IllegalModuleDataException - The id already exists or is null. Also if label is empty or null.

size

public int size()

Description copied from interface: ModuleReferenceList

Get number of module references.

Specified by:

size in interface ModuleReferenceList

Returns:

Number of module references.

getLabel

public java.lang.String getLabel(int index)

Description copied from interface: ModuleReferenceList

Get label for certain module.

Specified by:

getLabel in interface ModuleReferenceList

Parameters:

index - Entry index.

Returns:

Label of module.

getQedeqBo

public QedeqBo getQedeqBo(int index)

Description copied from interface: ModuleReferenceList

Get properties of referenced module.

Specified by:

getQedeqBo in interface ModuleReferenceList

Parameters:

index - Entry index.

Returns:

Module properties for that module.

getKernelQedeqBo

public KernelQedeqBo getKernelQedeqBo(int index)

Get QedeqBo of referenced module.

Parameters:

index - Entry index.

Returns:

Module properties for that module.

getModuleContext

public ModuleContext getModuleContext(int index)

Description copied from interface: ModuleReferenceList

Get import context of referenced module.

Specified by:

getModuleContext in interface ModuleReferenceList

Parameters:

index - Entry index.

Returns:

Context for that module.

getQedeqBo

public QedeqBo getQedeqBo(java.lang.String label)

Description copied from interface: ModuleReferenceList

Get QedeqBo of referenced module via label. Might be null.

Specified by:

getQedeqBo in interface ModuleReferenceList

Parameters:

label - Label for referenced module or null if not found.

Returns:

Module properties for that module.

getKernelQedeqBo

public KernelQedeqBo getKernelQedeqBo(java.lang.String label)

Get KernelQedeqBo of referenced module via label. Might be null.

Parameters:

label - Label for referenced module or null if not found.

Returns:

QEQDEQ BO.

contains

public boolean contains(KernelQedeqBo bo)

Is the given QEDEQ BO already in this list?

Parameters:

bo - QEDEQ BO.

Returns:

Already in list?

remove

public void remove(KernelQedeqBo bo)

Delete a given QEDEQ BO already from list.

Parameters:

bo - QEDEQ BO.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clear

public void clear()

Empty reference list.

set

public void set(KernelModuleReferenceList list)

Copy all list entry references of list to this instance.

Parameters:

list - Copy from here.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object