org.n52.oxf.serviceAdapters
Class ParameterContainer

java.lang.Object
  org.n52.oxf.serviceAdapters.ParameterContainer

public class ParameterContainer
extends Object

Holds all the ParameterShells of an AbstractServiceLayer that should be used in an operation execution.

Author:

Arne Broering

Constructor Summary

ParameterContainer()

Method Summary

void	addParameterShell(ParameterShell parameterShell)
void	addParameterShell(String parameterName, int parameterValue)
void	addParameterShell(String parameterName, ITime parameterValue)
void	addParameterShell(String parameterName, ITime[] parameterValueArray)
void	addParameterShell(String parameterName, ParameterContainer[] parameterValue)
void	addParameterShell(String parameterName, String parameterValue) convenience-method.
void	addParameterShell(String parameterName, String[] parameterValueArray)
boolean	containsParameterShellWithCommonName(String commonName)
boolean	containsParameterShellWithServiceSidedName(String serviceSidedName)
List<ParameterShell>	getParameterShells()
ParameterShell	getParameterShellWithCommonName(String commonName)
ParameterShell	getParameterShellWithServiceSidedName(String serviceSidedName)
void	removeParameterShell(ParameterShell parameterShell)
void	setParameterValue(String commonName, Object newValue) searches the ParameterShell whose Parameter has the commonName and sets the newValue to this Parameter.
void	setParameterValueArray(String commonName, Object[] newValues) searches the ParameterShell whose Parameter has the commonName and sets the newValues to this Parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterContainer

public ParameterContainer()

Method Detail

addParameterShell

public void addParameterShell(ParameterShell parameterShell)

addParameterShell

public void addParameterShell(String parameterName,
                              String parameterValue)
                       throws OXFException

convenience-method. Adds a new ParameterShell with a 'required' Parameter which has the specified parameterName and a StringValueDomain only containing the specified parameterValue. The ParameterShell associates the Parameter with the specified parameterValue.

Parameters:

parameterName -

parameterValue -

Throws:

OXFException

addParameterShell

public void addParameterShell(String parameterName,
                              ITime parameterValue)
                       throws OXFException

Throws:

OXFException

addParameterShell

public void addParameterShell(String parameterName,
                              ITime[] parameterValueArray)
                       throws OXFException

Throws:

OXFException

addParameterShell

public void addParameterShell(String parameterName,
                              String[] parameterValueArray)
                       throws OXFException

Throws:

OXFException

addParameterShell

public void addParameterShell(String parameterName,
                              int parameterValue)
                       throws OXFException

Throws:

OXFException

addParameterShell

public void addParameterShell(String parameterName,
                              ParameterContainer[] parameterValue)
                       throws OXFException

Throws:

OXFException

removeParameterShell

public void removeParameterShell(ParameterShell parameterShell)

getParameterShellWithCommonName

public ParameterShell getParameterShellWithCommonName(String commonName)

Parameters:

commonName -

Returns:

the ParameterShell whose parameter has the specified commonName (ignoring case). If there isn't such a ParameterShell null will be returned.

getParameterShellWithServiceSidedName

public ParameterShell getParameterShellWithServiceSidedName(String serviceSidedName)

Parameters:

serviceSidedName -

Returns:

the ParameterShell whose parameter has the specified serviceSidedName (ignoring case). If there isn't such a ParameterShell null will be returned.

containsParameterShellWithServiceSidedName

public boolean containsParameterShellWithServiceSidedName(String serviceSidedName)

Parameters:

serviceSidedName -

Returns:

true if this ParameterContainer contains a ParameterShell with a Parameter whose serviceSidedName is as specified (ignoring case). Otherwise false will be returned.

containsParameterShellWithCommonName

public boolean containsParameterShellWithCommonName(String commonName)

Parameters:

commonName -

Returns:

true if this ParameterContainer contains a ParameterShell with a Parameter whose commonName is as specified. Otherwise false will be returned.

setParameterValue

public void setParameterValue(String commonName,
                              Object newValue)
                       throws OXFException

searches the ParameterShell whose Parameter has the commonName and sets the newValue to this Parameter.

Parameters:

commonName -

newValue -

Throws:

OXFException - if there is no ParameterShell whose parameter has the specified commonName.
or if the newValue is not contained in the valueDomain of the parameter.

setParameterValueArray

public void setParameterValueArray(String commonName,
                                   Object[] newValues)
                            throws OXFException

searches the ParameterShell whose Parameter has the commonName and sets the newValues to this Parameter.

Parameters:

commonName -

newValues -

Throws:

OXFException - if there is no ParameterShell whose parameter has the specified commonName.
or if the one of the newValues is not contained in the valueDomain of the parameter.

getParameterShells

public List<ParameterShell> getParameterShells()

toString

public String toString()

Overrides:

toString in class Object