org.deegree_impl.clients.context
Class Module_Impl

java.lang.Object
  org.deegree_impl.clients.context.Module_Impl

All Implemented Interfaces:

Marshallable, Module

public class Module_Impl

extends java.lang.Object

implements Module, Marshallable

this class encapsulates the basic informations of a module that is part of an area of the GUI. Other classes may extent this class by adding special attributes for more specialazied GUIs.

Version:

$Revision: 1.3 $

Author:

Andreas Poth

Field Summary

private java.lang.String	content
private boolean	hidden
private ModuleConfiguration	moduleConfiguration
private java.lang.String	name
private ParameterList	parameterList

Constructor Summary

Module_Impl(java.lang.String name, java.lang.String content, boolean hidden, ModuleConfiguration moduleConfiguration, ParameterList parameterList)
Creates a new Module_Impl object.

Method Summary

void	addParameter(Parameter parameter) adds a parameter to the list of parameters that will be passed to a class/object etc. that represents a module
java.lang.String	exportAsXML() Produces an XML-representation of this object.
java.lang.String	getContent() returns the name of the page/class/file etc. containing the content of the module
ModuleConfiguration	getModuleConfiguration() returns the a specific confguration for a module.
java.lang.String	getName() returns the name of a module
ParameterList	getParameter() returns a list of parameters that will be passed to a class/object etc.
boolean	isHidden() returns true if the module is hidden. this will always be the case for modules that just offers functions to the context. visible modules may offere the capability to be turned to visible or not.
void	removeParameter(java.lang.String name) removes a parameter to the list of parameters that will be passed to a class/object etc. that represents a module
void	setContent(java.lang.String content) sets the name of the page/class/file etc. containing the content of the module
void	setHidden(boolean hidden) sets the module to be hidden or visible. modules that only adds functions to a context will ignore this because they are always hidden
void	setModuleConfiguration(ModuleConfiguration configuration) sets the specific configuration for a module.
void	setName(java.lang.String name) sets the name of a module
void	setParameter(ParameterList parameterList) sets a list of parameters that will be passed to a class/object etc.

Methods inherited from class java.lang.Object

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

Field Detail

moduleConfiguration

private ModuleConfiguration moduleConfiguration

content

private java.lang.String content

name

private java.lang.String name

hidden

private boolean hidden

parameterList

private ParameterList parameterList

Constructor Detail

Module_Impl

public Module_Impl(java.lang.String name,
                   java.lang.String content,
                   boolean hidden,
                   ModuleConfiguration moduleConfiguration,
                   ParameterList parameterList)

Creates a new Module_Impl object.

Parameters:

name - name of the module

content - the name of the page/class/file etc. containing the content of the module

hidden - indicates if the module is visible or not

moduleConfiguration - encapsulates the access to the modules configuration (may be null)

Method Detail

getName

public java.lang.String getName()

returns the name of a module

Specified by:

getName in interface Module

Returns:

setName

public void setName(java.lang.String name)

sets the name of a module

Specified by:

setName in interface Module

Parameters:

name -

getContent

public java.lang.String getContent()

returns the name of the page/class/file etc. containing the content of the module

Specified by:

getContent in interface Module

setContent

public void setContent(java.lang.String content)

sets the name of the page/class/file etc. containing the content of the module

Specified by:

setContent in interface Module

Parameters:

content -

isHidden

public boolean isHidden()

returns true if the module is hidden. this will always be the case for modules that just offers functions to the context. visible modules may offere the capability to be turned to visible or not.

Specified by:

isHidden in interface Module

Returns:

setHidden

public void setHidden(boolean hidden)

sets the module to be hidden or visible. modules that only adds functions to a context will ignore this because they are always hidden

Specified by:

setHidden in interface Module

Parameters:

hidden -

getModuleConfiguration

public ModuleConfiguration getModuleConfiguration()

returns the a specific confguration for a module. This may be null if the module doesn't need to be configured.

Specified by:

getModuleConfiguration in interface Module

Returns:

setModuleConfiguration

public void setModuleConfiguration(ModuleConfiguration configuration)

sets the specific configuration for a module.

Specified by:

setModuleConfiguration in interface Module

Parameters:

configuration -

getParameter

public ParameterList getParameter()

returns a list of parameters that will be passed to a class/object etc. that represents a module

Specified by:

getParameter in interface Module

Returns:

parameters

setParameter

public void setParameter(ParameterList parameterList)

sets a list of parameters that will be passed to a class/object etc. that represents a module

Specified by:

setParameter in interface Module

Parameters:

parameterList -

addParameter

public void addParameter(Parameter parameter)

adds a parameter to the list of parameters that will be passed to a class/object etc. that represents a module

Specified by:

addParameter in interface Module

Parameters:

parameter -

removeParameter

public void removeParameter(java.lang.String name)

removes a parameter to the list of parameters that will be passed to a class/object etc. that represents a module

Specified by:

removeParameter in interface Module

Parameters:

name -

exportAsXML

public java.lang.String exportAsXML()

Description copied from interface: Marshallable

Produces an XML-representation of this object.

Specified by:

exportAsXML in interface Marshallable

Returns: